FoscNamedInterval

Returns a FoscNamedInterval.

Description

Named interval.

Attributes Summary

Class Methods

Instance Properties

Instance Methods: Special Methods

Instance Methods

Usage

Class Methods

’’’

1. Makes named interval calculated from pitch_carrier_1 to

   pitch_carrier_2.

   • Example —

   ::

   abjad.NamedInterval.from_pitch_carriers( … abjad.NamedPitch(-2), … abjad.NamedPitch(12), … ) NamedInterval(‘+M9’)

   ::

   .. todo:: Improve this behavior.

   abjad.NamedInterval.from_pitch_carriers( … abjad.NamedPitch(“cs’”), … abjad.NamedPitch(“cf’”), … ) NamedInterval(‘-M2’)

   Returns named interval.

’’’

1. Makes named interval from quality and number.

   • Example —

   ::

   abjad.NamedInterval.from_quality_and_number( … major, … -3, … ) NamedInterval(‘-M3’)

   Returns newly constructed named interval.

Instance Properties

’’’

1. Gets direction number of named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’).direction_number 1

   Returns -1, 0 or 1.

’’’

1. Gets direction string of named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’).direction_string ascending

   • Example —

   ::

   abjad.NamedInterval(‘-M9’).direction_string descending

   • Example —

   ::

   abjad.NamedInterval(P1).direction_string is None True

   Returns __ascending__, __descending__ or none.

’’’

1. Gets interval class of named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’).interval_class 2

   Returns nonnegative integer.

’’’

1. Gets interval string of named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’).interval_string ninth

   Returns string.

’’’

1. Gets name of named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’).name ‘+M9’

   Returns string.

’’’

1. DEPRECATED.

   Gets named interval class of named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’).named_interval_class NamedIntervalClass(‘+M2’)

   ::

   abjad.NamedInterval(‘-M9’).named_interval_class NamedIntervalClass(‘-M2’)

   ::

   abjad.NamedInterval(P1).named_interval_class NamedIntervalClass(P1)

   ::

   abjad.NamedInterval(‘+P8’).named_interval_class NamedIntervalClass(‘+P8’)

   Returns named inversion-equivalent interval-class.

’’’

1. Gets number of named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’).number 9

   Returns nonnegative number.

’’’

1. Gets octaves of named interval.

   • Example —

   :: >>> abjad.NamedInterval(‘+M9’).octaves 1

   Returns nonnegative number.

’’’

1. Gets quality string of named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’).quality_string major

   ::

   abjad.NamedInterval(‘+m9’).quality_string minor

   ::

   abjad.NamedInterval(‘+P8’).quality_string perfect

   ::

   abjad.NamedInterval(‘+aug4’).quality_string augmented

   Returns string.

’’’

1. Gets semitones of named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’).semitones 14

   ::

   abjad.NamedInterval(‘-M9’).semitones -14

   ::

   abjad.NamedInterval(P1).semitones 0

   ::

   abjad.NamedInterval(‘+P8’).semitones 12

   ::

   abjad.NamedInterval(‘-P8’).semitones -12

   Returns number.

’’’

1. Gets staff spaces of named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’).staff_spaces 8

   ::

   abjad.NamedInterval(‘-M9’).staff_spaces -8

   ::

   abjad.NamedInterval(P1).staff_spaces 0

   ::

   abjad.NamedInterval(‘+P8’).staff_spaces 7

   ::

   abjad.NamedInterval(‘-P8’).staff_spaces -7

   Returns nonnegative integer.

Instance Methods: Special Methods

’’’

1. Gets absolute value of named interval.

   • Example —

   ::

   abs(abjad.NamedInterval(‘+M9’)) NamedInterval(‘+M9’)

   ::

   abs(abjad.NamedInterval(‘-M9’)) NamedInterval(‘+M9’)

   Returns named interval.

’’’

1. Adds argument to named interval.

   • Example —

   ::

   abjad.NamedInterval(M9) + abjad.NamedInterval(M2) NamedInterval(‘+M10’)

   Returns new named interval.

def

copy(self, *arguments): r

1. •

   def copy(self, *arguments): r

’’’

1. Is true when named interval equal argument.

   Otherwise false.

   • Example —

   ::

   interval_1 = abjad.NamedInterval(m2) interval_2 = abjad.NamedInterval(m2) interval_3 = abjad.NamedInterval(m9)

   ::

   interval_1 == interval_1 True interval_1 == interval_2 True interval_1 == interval_3 False

   ::

   interval_2 == interval_1 True interval_2 == interval_2 True interval_2 == interval_3 False

   ::

   interval_3 == interval_1 False interval_3 == interval_2 False interval_3 == interval_3 True

’’’

1. Hashes named interval.

   Returns number.

’’’

1. Is true when argument is a named interval with a number greater

   than that of this named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’) < abjad.NamedInterval(‘+M10’) True

   • Example —

   Also true when argument is a named interval with a number equal to this named interval and with semitones greater than this named interval:

   ::

   abjad.NamedInterval(‘+m9’) < abjad.NamedInterval(‘+M9’) True

   • Example —

   Otherwise false:

   ::

   abjad.NamedInterval(‘+M9’) < abjad.NamedInterval(‘+M2’) False

   Returns true or false.

’’’

1. Multiplies named interval by argument.

   • Example —

   ::

   3 * abjad.NamedInterval(‘+M9’) NamedInterval(‘+aug25’)

   Returns new named interval.

’’’

1. Negates named interval.

   • Example —

   ::

   -abjad.NamedInterval(‘+M9’) NamedInterval(‘-M9’)

   • Example —

   ::

   -abjad.NamedInterval(‘-M9’) NamedInterval(‘+M9’)

   Returns new named interval.

’’’

1. Adds named interval to argument.

   • Example —

   ::

   abjad.NamedInterval(M9) + abjad.NamedInterval(M2) NamedInterval(‘+M10’)

   Returns new named interval.

’’’

1. Multiplies argument by named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’) * 3 NamedInterval(‘+aug25’)

   Returns new named interval.

’’’

1. Gets string representation of named interval.

   • Example —

   ::

   str(abjad.NamedInterval(‘+M9’)) ‘+M9’

   Returns string.

’’’

1. Subtracts argument from named interval.

   • Example —

   ::

   abjad.NamedInterval(‘+M9’) - abjad.NamedInterval(‘+M2’) NamedInterval(‘+P8’)

   ::

   abjad.NamedInterval(‘+M2’) - abjad.NamedInterval(‘+M9’) NamedInterval(‘-P8’)

   Returns new named interval.

Instance Methods

’’’

1. Transposes pitch_carrier by named interval.

   • Example —

   Transposes chord:

   ::

   chord = abjad.Chord(“<c’ e’ g’>4”)

   ::

   interval = abjad.NamedInterval(‘+m2’) interval.transpose(chord) Chord(“<df’ f’ af’>4”)

   Returns new (copied) object of pitch_carrier type.