NamedInversionEquivalentIntervalClass

class pitchtools.NamedInversionEquivalentIntervalClass(*arguments)

Named inversion-equivalent interval-class.

Initializes from string:

>>> pitchtools.NamedInversionEquivalentIntervalClass('-m14')
NamedInversionEquivalentIntervalClass('+M2')

Named inversion-equivalent interval-classes are immutable.

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.NamedIntervalClass.NamedIntervalClass" [color=3, group=2, label=NamedIntervalClass, shape=box]; "abjad.tools.pitchtools.NamedInversionEquivalentIntervalClass.NamedInversionEquivalentIntervalClass" [color=black, fontcolor=white, group=2, label=<<B>NamedInversionEquivalentIntervalClass</B>>, shape=box, style="filled, rounded"]; "abjad.tools.pitchtools.IntervalClass.IntervalClass" -> "abjad.tools.pitchtools.NamedIntervalClass.NamedIntervalClass"; "abjad.tools.pitchtools.NamedIntervalClass.NamedIntervalClass" -> "abjad.tools.pitchtools.NamedInversionEquivalentIntervalClass.NamedInversionEquivalentIntervalClass"; } 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"; }

Attribute summary

direction_number Direction number of named interval-class.
direction_string Direction word of named interval-class.
direction_symbol Direction symbol of named interval-class.
from_pitch_carriers(class_, pitch_carrier_1, ...) Makes named inversion-equivalent interval-class from pitch_carrier_1 and pitch_carrier_2.
number Number of interval-class.
quality_string Quality string of named interval-class.
__abs__() Absolute value of named interval-class.
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when argument is a named inversion-equivalent interval-class with quality string and number equal to those of this named inversion-equivalent interval-class.
__float__() Changes named interval-class to float.
__format__([format_specification]) Formats Abjad object.
__hash__() Required to be explicitly redefined on Python 3 if
__int__() Changes named interval-class to integer.
__lt__(argument) Is true when argument is a named interval class with a number greater than that of this named interval.
__ne__(argument) Is true when named inversion-equivalent interval-class does not equal argument.
__repr__() Gets interpreter representation of Abjad object.
__str__() String representation of named interval-class.

Read-only properties

(NamedIntervalClass).direction_number

Direction number of named interval-class.

Returns -1, 0 or 1.

(NamedIntervalClass).direction_string

Direction word of named interval-class.

Returns string.

(NamedIntervalClass).direction_symbol

Direction symbol of named interval-class.

Returns string.

(IntervalClass).number

Number of interval-class.

Returns number.

(NamedIntervalClass).quality_string

Quality string of named interval-class.

Returns string.

Class & static methods

classmethod NamedInversionEquivalentIntervalClass.from_pitch_carriers(class_, pitch_carrier_1, pitch_carrier_2)

Makes named inversion-equivalent interval-class from pitch_carrier_1 and pitch_carrier_2.

>>> pitchtools.NamedInversionEquivalentIntervalClass.from_pitch_carriers(
...     NamedPitch(-2),
...     NamedPitch(12),
...     )
NamedInversionEquivalentIntervalClass('+M2')

Returns named inversion-equivalent interval-class.

Special methods

(NamedIntervalClass).__abs__()

Absolute value of named interval-class.

Returns new named interval-class.

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

NamedInversionEquivalentIntervalClass.__eq__(argument)

Is true when argument is a named inversion-equivalent interval-class with quality string and number equal to those of this named inversion-equivalent interval-class. Otherwise false.

Returns true or false.

(NamedIntervalClass).__float__()

Changes named interval-class to float.

Returns float.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

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

Returns string.

NamedInversionEquivalentIntervalClass.__hash__()

Required to be explicitly redefined on Python 3 if __eq__ changes

Returns integer.

(NamedIntervalClass).__int__()

Changes named interval-class to integer.

Returns integer.

(NamedIntervalClass).__lt__(argument)

Is true when argument is a named interval class with a number greater than that of this named interval.

NamedInversionEquivalentIntervalClass.__ne__(argument)

Is true when named inversion-equivalent interval-class does not equal argument. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

(NamedIntervalClass).__str__()

String representation of named interval-class.

Returns string.