NumberedIntervalClass

class abjad.pitch.NumberedIntervalClass.NumberedIntervalClass(number=0)

Numbered interval-class.

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)

>>> abjad.NumberedIntervalClass('P8')
NumberedIntervalClass(12)

>>> abjad.NumberedIntervalClass('-P8')
NumberedIntervalClass(-12)

---

Attributes Summary

__abs__	Gets absolute value of numbered interval-class.
__add__	Adds argument to numbered interval-class.
__eq__	Is true when argument is a numbered interval-class with number equal to that of this numbered interval-class.
__float__	Coerce to semitones as float.
__hash__	Hashes numbered interval-class.
__lt__	Is true when numbered interval-class is less than argument.
__radd__	Adds argument to numbered interval-class.
__str__	Gets string representation of numbered interval-class.
__sub__	Subtracts argument from numbered interval-class.
direction_number	Gets direction number of numbered interval-class.
from_pitch_carriers	Makes numbered interval-class from pitch_carrier_1 and pitch_carrier_2.

---

Special methods

__abs__()

Gets absolute value of numbered interval-class.

Returns new numbered interval-class.

__add__(argument)

Adds argument to numbered interval-class.

Returns new numbered interval-class.

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

__eq__(argument)

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

>>> 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.

__float__()

Coerce to semitones as float.

Returns float.

(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).

__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).

__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.

__radd__(argument)

Adds argument to numbered interval-class.

Returns new numbered interval-class.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

__str__()

Gets string representation of numbered interval-class.

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

>>> str(abjad.NumberedIntervalClass(0))
'0'

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

__sub__(argument)

Subtracts argument from numbered interval-class.

Returns new numbered interval-class.

---

Methods

(IntervalClass).transpose(pitch_carrier)

Transposes pitch_carrier by interval-class.

Returns new pitch carrier.

---

Class & static methods

classmethod 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(24),
...     abjad.NamedPitch(0),
...     )
NumberedIntervalClass(-12)

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

Returns numbered interval-class.

---

Read-only properties

direction_number

Gets direction number of numbered interval-class.

Returns -1, 0 or 1.

(IntervalClass).number

Gets number of interval-class.

Returns number.