utilities

Utility classes and functions.

digraph InheritanceGraph { graph [bgcolor=transparent, color=lightsteelblue2, fontname=Arial, fontsize=10, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, splines=spline, style="dashed, rounded", truecolor=true ]; node [colorscheme=pastel19, fontname=Arial, fontsize=10, height=0, penwidth=2, shape=box, style="filled, rounded", width=0 ]; edge [color=lightslategrey, penwidth=1 ]; subgraph "cluster_abjad.pitch" { graph [label="abjad.pitch"]; node [color=4]; "abjad.pitch.IntervalClassSegment.IntervalClassSegment" [URL="../api/abjad/utilities/../pitch/IntervalClassSegment.html#abjad.pitch.IntervalClassSegment.IntervalClassSegment", color=4, label="Interval\nClass\nSegment", target=_top]; "abjad.pitch.IntervalClassSet.IntervalClassSet" [URL="../api/abjad/utilities/../pitch/IntervalClassSet.html#abjad.pitch.IntervalClassSet.IntervalClassSet", color=4, label="Interval\nClass\nSet", target=_top]; "abjad.pitch.IntervalClassVector.IntervalClassVector" [URL="../api/abjad/utilities/../pitch/IntervalClassVector.html#abjad.pitch.IntervalClassVector.IntervalClassVector", color=4, label="Interval\nClass\nVector", target=_top]; "abjad.pitch.IntervalSegment.IntervalSegment" [URL="../api/abjad/utilities/../pitch/IntervalSegment.html#abjad.pitch.IntervalSegment.IntervalSegment", color=4, label="Interval\nSegment", target=_top]; "abjad.pitch.IntervalSet.IntervalSet" [URL="../api/abjad/utilities/../pitch/IntervalSet.html#abjad.pitch.IntervalSet.IntervalSet", color=4, label="Interval\nSet", target=_top]; "abjad.pitch.IntervalVector.IntervalVector" [URL="../api/abjad/utilities/../pitch/IntervalVector.html#abjad.pitch.IntervalVector.IntervalVector", color=4, label="Interval\nVector", target=_top]; "abjad.pitch.PitchClassSegment.PitchClassSegment" [URL="../api/abjad/utilities/../pitch/PitchClassSegment.html#abjad.pitch.PitchClassSegment.PitchClassSegment", color=4, label="Pitch\nClass\nSegment", target=_top]; "abjad.pitch.TwelveToneRow.TwelveToneRow" [URL="../api/abjad/utilities/../pitch/TwelveToneRow.html#abjad.pitch.TwelveToneRow.TwelveToneRow", color=4, label="Twelve\nTone\nRow", target=_top]; "abjad.pitch.PitchClassSegment.PitchClassSegment" -> "abjad.pitch.TwelveToneRow.TwelveToneRow" [minlen=1]; "abjad.pitch.PitchClassSet.PitchClassSet" [URL="../api/abjad/utilities/../pitch/PitchClassSet.html#abjad.pitch.PitchClassSet.PitchClassSet", color=4, label="Pitch\nClass\nSet", target=_top]; "abjad.pitch.PitchClassVector.PitchClassVector" [URL="../api/abjad/utilities/../pitch/PitchClassVector.html#abjad.pitch.PitchClassVector.PitchClassVector", color=4, label="Pitch\nClass\nVector", target=_top]; "abjad.pitch.PitchSegment.PitchSegment" [URL="../api/abjad/utilities/../pitch/PitchSegment.html#abjad.pitch.PitchSegment.PitchSegment", color=4, label="Pitch\nSegment", target=_top]; "abjad.pitch.PitchSet.PitchSet" [URL="../api/abjad/utilities/../pitch/PitchSet.html#abjad.pitch.PitchSet.PitchSet", color=4, label="Pitch\nSet", target=_top]; "abjad.pitch.PitchVector.PitchVector" [URL="../api/abjad/utilities/../pitch/PitchVector.html#abjad.pitch.PitchVector.PitchVector", color=4, label="Pitch\nVector", target=_top]; "abjad.pitch.Segment.Segment" [URL="../api/abjad/utilities/../pitch/Segment.html#abjad.pitch.Segment.Segment", color=4, label=Segment, shape=oval, style=bold, target=_top]; "abjad.pitch.Segment.Segment" -> "abjad.pitch.IntervalClassSegment.IntervalClassSegment" [minlen=1]; "abjad.pitch.Segment.Segment" -> "abjad.pitch.IntervalSegment.IntervalSegment" [minlen=2]; "abjad.pitch.Segment.Segment" -> "abjad.pitch.PitchClassSegment.PitchClassSegment" [minlen=1]; "abjad.pitch.Segment.Segment" -> "abjad.pitch.PitchSegment.PitchSegment" [minlen=2]; "abjad.pitch.Set.Set" [URL="../api/abjad/utilities/../pitch/Set.html#abjad.pitch.Set.Set", color=4, label=Set, shape=oval, style=bold, target=_top]; "abjad.pitch.Set.Set" -> "abjad.pitch.IntervalClassSet.IntervalClassSet" [minlen=1]; "abjad.pitch.Set.Set" -> "abjad.pitch.IntervalSet.IntervalSet" [minlen=2]; "abjad.pitch.Set.Set" -> "abjad.pitch.PitchClassSet.PitchClassSet" [minlen=1]; "abjad.pitch.Set.Set" -> "abjad.pitch.PitchSet.PitchSet" [minlen=2]; "abjad.pitch.Vector.Vector" [URL="../api/abjad/utilities/../pitch/Vector.html#abjad.pitch.Vector.Vector", color=4, label=Vector, shape=oval, style=bold, target=_top]; "abjad.pitch.Vector.Vector" -> "abjad.pitch.IntervalClassVector.IntervalClassVector" [minlen=1]; "abjad.pitch.Vector.Vector" -> "abjad.pitch.IntervalVector.IntervalVector" [minlen=2]; "abjad.pitch.Vector.Vector" -> "abjad.pitch.PitchClassVector.PitchClassVector" [minlen=1]; "abjad.pitch.Vector.Vector" -> "abjad.pitch.PitchVector.PitchVector" [minlen=2]; } subgraph "cluster_abjad.timespans" { graph [label="abjad.timespans"]; node [color=6]; "abjad.timespans.CompoundInequality.CompoundInequality" [URL="../api/abjad/utilities/../timespans/CompoundInequality.html#abjad.timespans.CompoundInequality.CompoundInequality", color=6, label="Compound\nInequality", target=_top]; "abjad.timespans.TimespanList.TimespanList" [URL="../api/abjad/utilities/../timespans/TimespanList.html#abjad.timespans.TimespanList.TimespanList", color=6, label="Timespan\nList", target=_top]; } subgraph "cluster_abjad.core" { graph [label="abjad.core"]; node [color=1]; "abjad.core.NoteHeadList.NoteHeadList" [URL="../api/abjad/utilities/../core/NoteHeadList.html#abjad.core.NoteHeadList.NoteHeadList", color=1, label="Note\nHead\nList", target=_top]; } subgraph "cluster_abjad.markups" { graph [label="abjad.markups"]; node [color=2]; "abjad.markups.MarkupList" [URL="../api/abjad/utilities/../markups.html#abjad.markups.MarkupList", color=2, label="Markup\nList", target=_top]; } subgraph "cluster_abjad.meter" { graph [label="abjad.meter"]; node [color=3]; "abjad.meter.MeterList" [URL="../api/abjad/utilities/../meter.html#abjad.meter.MeterList", color=3, label="Meter\nList", target=_top]; "abjad.meter.OffsetCounter" [URL="../api/abjad/utilities/../meter.html#abjad.meter.OffsetCounter", color=3, label="Offset\nCounter", target=_top]; } subgraph "cluster_abjad.system" { graph [label="abjad.system"]; node [color=5]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjad/utilities/../system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", color=5, label="Abjad\nObject", target=_top]; "abjad.system.AbjadValueObject.AbjadValueObject" [URL="../api/abjad/utilities/../system/AbjadValueObject.html#abjad.system.AbjadValueObject.AbjadValueObject", color=5, label="Abjad\nValue\nObject", target=_top]; "abjad.system.AbjadObject.AbjadObject" -> "abjad.system.AbjadValueObject.AbjadValueObject"; } subgraph "cluster_abjad.utilities" { graph [label="abjad.utilities"]; node [color=7]; "abjad.utilities.CyclicTuple.CyclicTuple" [URL="../api/abjad/utilities/CyclicTuple.html#abjad.utilities.CyclicTuple.CyclicTuple", color=black, fontcolor=white, label="Cyclic\nTuple", target=_top]; "abjad.utilities.Duration.Duration" [URL="../api/abjad/utilities/Duration.html#abjad.utilities.Duration.Duration", color=black, fontcolor=white, label=Duration, target=_top]; "abjad.utilities.Multiplier.Multiplier" [URL="../api/abjad/utilities/Multiplier.html#abjad.utilities.Multiplier.Multiplier", color=black, fontcolor=white, label=Multiplier, target=_top]; "abjad.utilities.Duration.Duration" -> "abjad.utilities.Multiplier.Multiplier" [minlen=1]; "abjad.utilities.Offset.Offset" [URL="../api/abjad/utilities/Offset.html#abjad.utilities.Offset.Offset", color=black, fontcolor=white, label=Offset, target=_top]; "abjad.utilities.Duration.Duration" -> "abjad.utilities.Offset.Offset" [minlen=2]; "abjad.utilities.DurationInequality.DurationInequality" [URL="../api/abjad/utilities/DurationInequality.html#abjad.utilities.DurationInequality.DurationInequality", color=black, fontcolor=white, label="Duration\nInequality", target=_top]; "abjad.utilities.Enumerator.Enumerator" [URL="../api/abjad/utilities/Enumerator.html#abjad.utilities.Enumerator.Enumerator", color=black, fontcolor=white, label=Enumerator, target=_top]; "abjad.utilities.Expression.Expression" [URL="../api/abjad/utilities/Expression.html#abjad.utilities.Expression.Expression", color=black, fontcolor=white, label=Expression, target=_top]; "abjad.utilities.Inequality.Inequality" [URL="../api/abjad/utilities/Inequality.html#abjad.utilities.Inequality.Inequality", color=black, fontcolor=white, label=Inequality, shape=oval, style="bold, filled", target=_top]; "abjad.utilities.Inequality.Inequality" -> "abjad.utilities.DurationInequality.DurationInequality" [minlen=1]; "abjad.utilities.LengthInequality.LengthInequality" [URL="../api/abjad/utilities/LengthInequality.html#abjad.utilities.LengthInequality.LengthInequality", color=black, fontcolor=white, label="Length\nInequality", target=_top]; "abjad.utilities.Inequality.Inequality" -> "abjad.utilities.LengthInequality.LengthInequality" [minlen=2]; "abjad.utilities.OrderedDict.OrderedDict" [URL="../api/abjad/utilities/OrderedDict.html#abjad.utilities.OrderedDict.OrderedDict", color=black, fontcolor=white, label="Ordered\nDict", target=_top]; "abjad.utilities.Pattern.Pattern" [URL="../api/abjad/utilities/Pattern.html#abjad.utilities.Pattern.Pattern", color=black, fontcolor=white, label=Pattern, target=_top]; "abjad.utilities.PatternTuple.PatternTuple" [URL="../api/abjad/utilities/PatternTuple.html#abjad.utilities.PatternTuple.PatternTuple", color=black, fontcolor=white, label="Pattern\nTuple", target=_top]; "abjad.utilities.PitchInequality.PitchInequality" [URL="../api/abjad/utilities/PitchInequality.html#abjad.utilities.PitchInequality.PitchInequality", color=black, fontcolor=white, label="Pitch\nInequality", target=_top]; "abjad.utilities.Sequence.Sequence" [URL="../api/abjad/utilities/Sequence.html#abjad.utilities.Sequence.Sequence", color=black, fontcolor=white, label=Sequence, target=_top]; "abjad.utilities.SortedCollection.SortedCollection" [URL="../api/abjad/utilities/SortedCollection.html#abjad.utilities.SortedCollection.SortedCollection", color=black, fontcolor=white, label="Sorted\nCollection", target=_top]; "abjad.utilities.String.String" [URL="../api/abjad/utilities/String.html#abjad.utilities.String.String", color=black, fontcolor=white, label=String, target=_top]; "abjad.utilities.TypedCollection.TypedCollection" [URL="../api/abjad/utilities/TypedCollection.html#abjad.utilities.TypedCollection.TypedCollection", color=black, fontcolor=white, label="Typed\nCollection", shape=oval, style="bold, filled", target=_top]; "abjad.utilities.TypedCollection.TypedCollection" -> "abjad.utilities.OrderedDict.OrderedDict"; "abjad.utilities.TypedCounter.TypedCounter" [URL="../api/abjad/utilities/TypedCounter.html#abjad.utilities.TypedCounter.TypedCounter", color=black, fontcolor=white, label="Typed\nCounter", target=_top]; "abjad.utilities.TypedCollection.TypedCollection" -> "abjad.utilities.TypedCounter.TypedCounter"; "abjad.utilities.TypedFrozenset.TypedFrozenset" [URL="../api/abjad/utilities/TypedFrozenset.html#abjad.utilities.TypedFrozenset.TypedFrozenset", color=black, fontcolor=white, label="Typed\nFrozenset", target=_top]; "abjad.utilities.TypedCollection.TypedCollection" -> "abjad.utilities.TypedFrozenset.TypedFrozenset"; "abjad.utilities.TypedList.TypedList" [URL="../api/abjad/utilities/TypedList.html#abjad.utilities.TypedList.TypedList", color=black, fontcolor=white, label="Typed\nList", target=_top]; "abjad.utilities.TypedCollection.TypedCollection" -> "abjad.utilities.TypedList.TypedList"; "abjad.utilities.TypedTuple.TypedTuple" [URL="../api/abjad/utilities/TypedTuple.html#abjad.utilities.TypedTuple.TypedTuple", color=black, fontcolor=white, label="Typed\nTuple", target=_top]; "abjad.utilities.TypedCollection.TypedCollection" -> "abjad.utilities.TypedTuple.TypedTuple"; "abjad.utilities.TypedTuple.TypedTuple" -> "abjad.utilities.PatternTuple.PatternTuple" [minlen=1]; } subgraph cluster_builtins { graph [label=builtins]; node [color=8]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", color=8, label=object, target=_top]; "builtins.str" [URL="https://docs.python.org/3.6/library/stdtypes.html#str", color=8, label=str, target=_top]; "builtins.object" -> "builtins.str" [minlen=2]; } subgraph "cluster_collections.abc" { graph [label="collections.abc"]; node [color=9]; "collections.abc.Collection" [URL="https://docs.python.org/3.6/library/collections.abc.html#collections.abc.Collection", color=9, label=Collection, shape=oval, style=bold, target=_top]; "collections.abc.Mapping" [URL="https://docs.python.org/3.6/library/collections.abc.html#collections.abc.Mapping", color=9, label=Mapping, shape=oval, style=bold, target=_top]; "collections.abc.Collection" -> "collections.abc.Mapping" [minlen=1]; "collections.abc.Sequence" [URL="https://docs.python.org/3.6/library/collections.abc.html#collections.abc.Sequence", color=9, label=Sequence, shape=oval, style=bold, target=_top]; "collections.abc.Collection" -> "collections.abc.Sequence"; "collections.abc.Set" [URL="https://docs.python.org/3.6/library/collections.abc.html#collections.abc.Set", color=9, label=Set, shape=oval, style=bold, target=_top]; "collections.abc.Collection" -> "collections.abc.Set" [minlen=2]; "collections.abc.Container" [URL="https://docs.python.org/3.6/library/collections.abc.html#collections.abc.Container", color=9, label=Container, shape=oval, style=bold, target=_top]; "collections.abc.Container" -> "collections.abc.Collection"; "collections.abc.Iterable" [URL="https://docs.python.org/3.6/library/collections.abc.html#collections.abc.Iterable", color=9, label=Iterable, shape=oval, style=bold, target=_top]; "collections.abc.Iterable" -> "collections.abc.Collection"; "collections.abc.Reversible" [URL="https://docs.python.org/3.6/library/collections.abc.html#collections.abc.Reversible", color=9, label=Reversible, shape=oval, style=bold, target=_top]; "collections.abc.Iterable" -> "collections.abc.Reversible" [minlen=1]; "collections.abc.MutableMapping" [URL="https://docs.python.org/3.6/library/collections.abc.html#collections.abc.MutableMapping", color=9, label="Mutable\nMapping", shape=oval, style=bold, target=_top]; "collections.abc.Mapping" -> "collections.abc.MutableMapping"; "collections.abc.MutableSequence" [URL="https://docs.python.org/3.6/library/collections.abc.html#collections.abc.MutableSequence", color=9, label="Mutable\nSequence", shape=oval, style=bold, target=_top]; "collections.abc.Reversible" -> "collections.abc.Sequence"; "collections.abc.Sequence" -> "collections.abc.MutableSequence" [minlen=1]; "collections.abc.Sized" [URL="https://docs.python.org/3.6/library/collections.abc.html#collections.abc.Sized", color=9, label=Sized, shape=oval, style=bold, target=_top]; "collections.abc.Sized" -> "collections.abc.Collection"; } subgraph cluster_fractions { graph [label=fractions]; node [color=1]; "fractions.Fraction" [URL="https://docs.python.org/3.6/library/fractions.html#fractions.Fraction", color=1, label=Fraction, target=_top]; } subgraph cluster_numbers { graph [label=numbers]; node [color=2]; "numbers.Complex" [URL="https://docs.python.org/3.6/library/numbers.html#numbers.Complex", color=2, label=Complex, shape=oval, style=bold, target=_top]; "numbers.Real" [URL="https://docs.python.org/3.6/library/numbers.html#numbers.Real", color=2, label=Real, shape=oval, style=bold, target=_top]; "numbers.Complex" -> "numbers.Real" [minlen=1]; "numbers.Number" [URL="https://docs.python.org/3.6/library/numbers.html#numbers.Number", color=2, label=Number, target=_top]; "numbers.Number" -> "numbers.Complex" [minlen=1]; "numbers.Rational" [URL="https://docs.python.org/3.6/library/numbers.html#numbers.Rational", color=2, label=Rational, shape=oval, style=bold, target=_top]; "numbers.Real" -> "numbers.Rational" [minlen=1]; } "abjad.system.AbjadObject.AbjadObject" -> "abjad.utilities.CyclicTuple.CyclicTuple" [minlen=1]; "abjad.system.AbjadObject.AbjadObject" -> "abjad.utilities.Duration.Duration"; "abjad.system.AbjadObject.AbjadObject" -> "abjad.utilities.TypedCollection.TypedCollection"; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjad.utilities.Enumerator.Enumerator" [minlen=1]; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjad.utilities.Expression.Expression" [minlen=2]; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjad.utilities.Inequality.Inequality"; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjad.utilities.Pattern.Pattern" [minlen=1]; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjad.utilities.PitchInequality.PitchInequality" [minlen=2]; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjad.utilities.Sequence.Sequence"; "abjad.utilities.TypedCounter.TypedCounter" -> "abjad.meter.OffsetCounter" [minlen=1]; "abjad.utilities.TypedCounter.TypedCounter" -> "abjad.pitch.Vector.Vector"; "abjad.utilities.TypedFrozenset.TypedFrozenset" -> "abjad.pitch.Set.Set"; "abjad.utilities.TypedList.TypedList" -> "abjad.core.NoteHeadList.NoteHeadList" [minlen=1]; "abjad.utilities.TypedList.TypedList" -> "abjad.markups.MarkupList" [minlen=2]; "abjad.utilities.TypedList.TypedList" -> "abjad.meter.MeterList" [minlen=1]; "abjad.utilities.TypedList.TypedList" -> "abjad.timespans.CompoundInequality.CompoundInequality" [minlen=2]; "abjad.utilities.TypedList.TypedList" -> "abjad.timespans.TimespanList.TimespanList" [minlen=1]; "abjad.utilities.TypedTuple.TypedTuple" -> "abjad.pitch.Segment.Segment"; "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; "builtins.object" -> "abjad.utilities.SortedCollection.SortedCollection" [minlen=1]; "builtins.object" -> "collections.abc.Container" [minlen=1]; "builtins.object" -> "collections.abc.Iterable"; "builtins.object" -> "collections.abc.Sized" [minlen=2]; "builtins.object" -> "numbers.Number" [minlen=1]; "builtins.str" -> "abjad.utilities.String.String" [minlen=1]; "collections.abc.MutableMapping" -> "abjad.utilities.OrderedDict.OrderedDict"; "collections.abc.MutableMapping" -> "abjad.utilities.TypedCounter.TypedCounter"; "collections.abc.MutableSequence" -> "abjad.utilities.TypedList.TypedList"; "collections.abc.Sequence" -> "abjad.utilities.Sequence.Sequence"; "collections.abc.Sequence" -> "abjad.utilities.TypedTuple.TypedTuple"; "collections.abc.Set" -> "abjad.utilities.TypedFrozenset.TypedFrozenset"; "fractions.Fraction" -> "abjad.utilities.Duration.Duration"; "numbers.Rational" -> "fractions.Fraction" [minlen=1]; }


Abstract Classes

TypedCollection Abstract typed collection.

Classes

CyclicTuple Cyclic tuple.
Duration Duration.
Enumerator Enumerator.
Expression Expression.
Multiplier Multiplier.
Offset Offset.
OrderedDict Ordered dictionary.
Pattern Pattern.
PatternTuple Pattern tuple.
Sequence Sequence.
SortedCollection Sorted collection.
String String.
TypedCounter Typed counter.
TypedFrozenset Typed fozen set.
TypedList Typed list.
TypedTuple Typed tuple.

Functions

compare_images Compare image_one against image_two using ImageMagick’s compare commandline tool.
list_all_classes Lists all public classes defined in path.
list_all_functions Lists all public functions defined in modules.
list_all_ide_classes Lists all public classes defined in Abjad IDE.
list_all_ide_functions Lists all public functions defined in Abjad IDE.
yield_all_modules Yields all modules encountered in path.

Inequalities

DurationInequality Duration inequality.
Inequality Inequality.
LengthInequality Length inequality.
PitchInequality Pitch inequality.