NumberedIntervalClass

class pitchtools.NumberedIntervalClass(number=0)

Numbered interval-class.

>>> import abjad

Initializes from integer:

>>> abjad.NumberedIntervalClass(-14)
NumberedIntervalClass(-2)

Initializes from float:

>>> abjad.NumberedIntervalClass(-14.5)
NumberedIntervalClass(-2.5)

Initializes from string:

>>> abjad.NumberedIntervalClass('-14.5')
NumberedIntervalClass(-2.5)

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.AbjadValueObject.AbjadValueObject" [color=1, group=0, label=AbjadValueObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.AbjadValueObject.AbjadValueObject"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_pitchtools { graph [label=pitchtools]; "abjad.tools.pitchtools.IntervalClass.IntervalClass" [color=3, group=2, label=IntervalClass, shape=oval, style=bold]; "abjad.tools.pitchtools.NumberedIntervalClass.NumberedIntervalClass" [color=black, fontcolor=white, group=2, label=<<B>NumberedIntervalClass</B>>, shape=box, style="filled, rounded"]; "abjad.tools.pitchtools.NumberedInversionEquivalentIntervalClass.NumberedInversionEquivalentIntervalClass" [color=3, group=2, label=NumberedInversionEquivalentIntervalClass, shape=box]; "abjad.tools.pitchtools.IntervalClass.IntervalClass" -> "abjad.tools.pitchtools.NumberedIntervalClass.NumberedIntervalClass"; "abjad.tools.pitchtools.NumberedIntervalClass.NumberedIntervalClass" -> "abjad.tools.pitchtools.NumberedInversionEquivalentIntervalClass.NumberedInversionEquivalentIntervalClass"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.pitchtools.IntervalClass.IntervalClass"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

direction_number Gets direction number of numbered interval-class.
direction_symbol Gets direction symbol of numbered interval-class.
direction_word Gets direction word of numbered interval-class.
from_pitch_carriers(pitch_carrier_1, …) Makes numbered interval-class from pitch_carrier_1 and pitch_carrier_2.
number Gets number of interval-class.
__abs__() Gets absolute value of numbered interval-class.
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when argument is a numbered interval-class with number equal to that of this numbered interval-class.
__format__([format_specification]) Formats Abjad object.
__ge__(other[, NotImplemented]) Return a >= b.
__gt__(other[, NotImplemented]) Return a > b.
__hash__() Hashes numbered interval-class.
__le__(other[, NotImplemented]) Return a <= b.
__lt__(argument) Is true when numbered interval-class is less than argument.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.
__str__() Gets string representation of numbered interval-class.

Read-only properties

NumberedIntervalClass.direction_number

Gets direction number of numbered interval-class.

Returns -1, 0 or 1.

NumberedIntervalClass.direction_symbol

Gets direction symbol of numbered interval-class.

Returns string.

NumberedIntervalClass.direction_word

Gets direction word of numbered interval-class.

Returns string.

(IntervalClass).number

Gets number of interval-class.

Returns number.

Class & static methods

classmethod NumberedIntervalClass.from_pitch_carriers(pitch_carrier_1, pitch_carrier_2)

Makes numbered interval-class from pitch_carrier_1 and pitch_carrier_2.

>>> abjad.NumberedIntervalClass.from_pitch_carriers(
...     abjad.NamedPitch(-2),
...     abjad.NamedPitch(12),
...     )
NumberedIntervalClass(2)
>>> abjad.NumberedIntervalClass.from_pitch_carriers(
...     abjad.NamedPitch(0),
...     abjad.NamedPitch(12),
...     )
NumberedIntervalClass(12)
>>> abjad.NumberedIntervalClass.from_pitch_carriers(
...     abjad.NamedPitch(9),
...     abjad.NamedPitch(12),
...     )
NumberedIntervalClass(3)
>>> abjad.NumberedIntervalClass.from_pitch_carriers(
...     abjad.NamedPitch(12),
...     abjad.NamedPitch(9),
...     )
NumberedIntervalClass(-3)
>>> abjad.NumberedIntervalClass.from_pitch_carriers(
...     abjad.NamedPitch(12),
...     abjad.NamedPitch(12),
...     )
NumberedIntervalClass(0)
>>> abjad.NumberedIntervalClass.from_pitch_carriers(
...     abjad.NamedPitch(12),
...     abjad.NamedPitch(-2),
...     )
NumberedIntervalClass(-2)

Returns numbered interval-class.

Special methods

NumberedIntervalClass.__abs__()

Gets absolute value of numbered interval-class.

Returns new numbered interval-class.

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

NumberedIntervalClass.__eq__(argument)

Is true when argument is a numbered interval-class with number equal to that of this numbered interval-class. Otherwise false.

>>> interval_class_1 = abjad.NumberedIntervalClass(0)
>>> interval_class_2 = abjad.NumberedIntervalClass(0)
>>> interval_class_3 = abjad.NumberedIntervalClass(1)
>>> interval_class_1 == interval_class_1
True
>>> interval_class_1 == interval_class_2
True
>>> interval_class_1 == interval_class_3
False
>>> interval_class_2 == interval_class_1
True
>>> interval_class_2 == interval_class_2
True
>>> interval_class_2 == interval_class_3
False
>>> interval_class_3 == interval_class_1
False
>>> interval_class_3 == interval_class_2
False
>>> interval_class_3 == interval_class_3
True

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(IntervalClass).__ge__(other, NotImplemented=NotImplemented)

Return a >= b. Computed by @total_ordering from (not a < b).

(IntervalClass).__gt__(other, NotImplemented=NotImplemented)

Return a > b. Computed by @total_ordering from (not a < b) and (a != b).

NumberedIntervalClass.__hash__()

Hashes numbered interval-class.

Returns integer.

(IntervalClass).__le__(other, NotImplemented=NotImplemented)

Return a <= b. Computed by @total_ordering from (a < b) or (a == b).

NumberedIntervalClass.__lt__(argument)

Is true when numbered interval-class is less than argument.

>>> interval_class_1 = abjad.NumberedIntervalClass(0)
>>> interval_class_2 = abjad.NumberedIntervalClass(0)
>>> interval_class_3 = abjad.NumberedIntervalClass(1)
>>> interval_class_1 < interval_class_1
False
>>> interval_class_1 < interval_class_2
False
>>> interval_class_1 < interval_class_3
True
>>> interval_class_2 < interval_class_1
False
>>> interval_class_2 < interval_class_2
False
>>> interval_class_2 < interval_class_3
True
>>> interval_class_3 < interval_class_1
False
>>> interval_class_3 < interval_class_2
False
>>> interval_class_3 < interval_class_3
False

Returns true or false.

(AbjadObject).__ne__(argument)

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

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

NumberedIntervalClass.__str__()

Gets string representation of numbered interval-class.

>>> str(abjad.NumberedIntervalClass(-13))
'-1'
>>> str(abjad.NumberedIntervalClass(0))
'0'
>>> str(abjad.NumberedIntervalClass(13))
'+1'