Inequality

class timespantools.Inequality(template=None)

An inequality.

>>> template = 'timespan_2.start_offset < timespan_1.start_offset'
>>> inequality = timespantools.Inequality(template)
>>> inequality
Inequality('timespan_2.start_offset < timespan_1.start_offset')

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_timespantools { graph [label=timespantools]; "abjad.tools.timespantools.Inequality.Inequality" [color=black, fontcolor=white, group=2, label=<<B>Inequality</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.timespantools.Inequality.Inequality"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

evaluate(timespan_1_start_offset, ...) Evalutes inequality.
evaluate_offset_inequality(timespan_start, ...) Evalutes offset inequality.
get_offset_indices(timespan_1, ...) Gets offset indices of inequality.
template Gets template of inequality.
__eq__(expr) Is true when ID of expr equals ID of Abjad object.
__format__([format_specification]) Formats inequality.
__hash__() Hashes Abjad object.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

Inequality.template

Gets template of inequality.

>>> inequality.template
'timespan_2.start_offset < timespan_1.start_offset'

Returns string.

Methods

Inequality.evaluate(timespan_1_start_offset, timespan_1_stop_offset, timespan_2_start_offset, timespan_2_stop_offset)

Evalutes inequality.

Returns true or false.

Inequality.evaluate_offset_inequality(timespan_start, timespan_stop, offset)

Evalutes offset inequality.

Returns true or false.

Inequality.get_offset_indices(timespan_1, timespan_2_start_offsets, timespan_2_stop_offsets)

Gets offset indices of inequality.

Todo

add example.

Returns nonnegative integer pair.

Special methods

(AbjadObject).__eq__(expr)

Is true when ID of expr equals ID of Abjad object. Otherwise false.

Returns true or false.

Inequality.__format__(format_specification='')

Formats inequality.

>>> print(format(inequality))
timespantools.Inequality('timespan_2.start_offset < timespan_1.start_offset')

Returns string.

(AbjadObject).__hash__()

Hashes Abjad object.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

(AbjadObject).__ne__(expr)

Is true when Abjad object does not equal expr. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.