Interval

abstract class pitchtools.Interval

Abstract interval.

::
>>> import abjad

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

Bases

Attribute summary

cents Gets cents of interval.
is_named_interval_abbreviation(argument) Is true when argument is a named interval abbreviation.
is_named_interval_quality_abbreviation(argument) Is true when argument is a named-interval quality abbreviation.
transpose(pitch_carrier) Transposes pitch_carrier by interval.
__abs__() Gets absolute value of interval.
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when all initialization values of Abjad value object equal the initialization values of argument.
__float__() Coerce to float.
__format__([format_specification]) Formats Abjad object.
__ge__(other[, NotImplemented]) Return a >= b.
__gt__(other[, NotImplemented]) Return a > b.
__hash__() Hashes Abjad value object.
__le__(other[, NotImplemented]) Return a <= b.
__lt__(argument) Is true when interval is less than argument.
__ne__(argument) Is true when Abjad object does not equal argument.
__neg__() Negates interval.
__repr__() Gets interpreter representation of Abjad object.
__str__() Gets string representation of interval.

Read-only properties

Interval.cents

Gets cents of interval.

Returns nonnegative number.

Methods

abstract Interval.transpose(pitch_carrier)

Transposes pitch_carrier by interval.

Returns new pitch carrier.

Class & static methods

static Interval.is_named_interval_abbreviation(argument)

Is true when argument is a named interval abbreviation. Otherwise false.

>>> abjad.Interval.is_named_interval_abbreviation('+M9')
True

The regex ^([+,-]?)(M|m|P|aug|dim)(\d+)$ underlies this predicate.

Returns true or false.

static Interval.is_named_interval_quality_abbreviation(argument)

Is true when argument is a named-interval quality abbreviation. Otherwise false.

>>> abjad.Interval.is_named_interval_quality_abbreviation('aug')
True

The regex ^M|m|P|aug|dim$ underlies this predicate.

Returns true or false.

Special methods

Interval.__abs__()

Gets absolute value of interval.

Returns new interval.

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

Returns true or false.

Interval.__float__()

Coerce to float.

Returns float.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

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

Returns string.

Interval.__ge__(other, NotImplemented=NotImplemented)

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

Interval.__gt__(other, NotImplemented=NotImplemented)

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

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

Interval.__le__(other, NotImplemented=NotImplemented)

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

abstract Interval.__lt__(argument)

Is true when interval is less than argument.

Returns true or false.

(AbjadObject).__ne__(argument)

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

Returns true or false.

Interval.__neg__()

Negates interval.

Returns interval.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

Interval.__str__()

Gets string representation of interval.

Returns string.