TypedCollection

abstract class datastructuretools.TypedCollection(items=None, item_class=None)

Abstract typed collection.

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.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_datastructuretools { graph [label=datastructuretools]; "abjad.tools.datastructuretools.PatternList.PatternList" [color=3, group=2, label=" ", shape=invis, style=transparent]; "abjad.tools.datastructuretools.TypedCollection.TypedCollection" [color=black, fontcolor=white, group=2, label=<<B>TypedCollection</B>>, shape=oval, style="filled, rounded"]; "abjad.tools.datastructuretools.TypedCounter.TypedCounter" [color=3, group=2, label=TypedCounter, shape=box]; "abjad.tools.datastructuretools.TypedFrozenset.TypedFrozenset" [color=3, group=2, label=TypedFrozenset, shape=box]; "abjad.tools.datastructuretools.TypedList.TypedList" [color=3, group=2, label=TypedList, shape=box]; "abjad.tools.datastructuretools.TypedOrderedDict.TypedOrderedDict" [color=3, group=2, label=TypedOrderedDict, shape=box]; "abjad.tools.datastructuretools.TypedTuple.TypedTuple" [color=3, group=2, label=TypedTuple, shape=box]; "abjad.tools.datastructuretools.TypedCollection.TypedCollection" -> "abjad.tools.datastructuretools.TypedCounter.TypedCounter"; "abjad.tools.datastructuretools.TypedCollection.TypedCollection" -> "abjad.tools.datastructuretools.TypedFrozenset.TypedFrozenset"; "abjad.tools.datastructuretools.TypedCollection.TypedCollection" -> "abjad.tools.datastructuretools.TypedList.TypedList"; "abjad.tools.datastructuretools.TypedCollection.TypedCollection" -> "abjad.tools.datastructuretools.TypedOrderedDict.TypedOrderedDict"; "abjad.tools.datastructuretools.TypedCollection.TypedCollection" -> "abjad.tools.datastructuretools.TypedTuple.TypedTuple"; "abjad.tools.datastructuretools.TypedTuple.TypedTuple" -> "abjad.tools.datastructuretools.PatternList.PatternList"; } subgraph cluster_indicatortools { graph [label=indicatortools]; "abjad.tools.indicatortools.MetronomeMarkList.MetronomeMarkList" [color=4, group=3, label=" ", shape=invis, style=transparent]; "abjad.tools.indicatortools.TimeSignatureList.TimeSignatureList" [color=4, group=3, label=" ", shape=invis, style=transparent]; } subgraph cluster_instrumenttools { graph [label=instrumenttools]; "abjad.tools.instrumenttools.ClefList.ClefList" [color=5, group=4, label=" ", shape=invis, style=transparent]; "abjad.tools.instrumenttools.InstrumentList.InstrumentList" [color=5, group=4, label=" ", shape=invis, style=transparent]; "abjad.tools.instrumenttools.PerformerList.PerformerList" [color=5, group=4, label=" ", shape=invis, style=transparent]; } subgraph cluster_markuptools { graph [label=markuptools]; "abjad.tools.markuptools.MarkupList.MarkupList" [color=6, group=5, label=" ", shape=invis, style=transparent]; } subgraph cluster_metertools { graph [label=metertools]; "abjad.tools.metertools.MeterList.MeterList" [color=7, group=6, label=" ", shape=invis, style=transparent]; "abjad.tools.metertools.OffsetCounter.OffsetCounter" [color=7, group=6, label=" ", shape=invis, style=transparent]; } subgraph cluster_pitchtools { graph [label=pitchtools]; "abjad.tools.pitchtools.PitchRangeList.PitchRangeList" [color=8, group=7, label=" ", shape=invis, style=transparent]; "abjad.tools.pitchtools.Registration.Registration" [color=8, group=7, label=" ", shape=invis, style=transparent]; "abjad.tools.pitchtools.RegistrationList.RegistrationList" [color=8, group=7, label=" ", shape=invis, style=transparent]; "abjad.tools.pitchtools.Segment.Segment" [color=8, group=7, label=" ", shape=invis, style=transparent]; "abjad.tools.pitchtools.Set.Set" [color=8, group=7, label=" ", shape=invis, style=transparent]; "abjad.tools.pitchtools.Vector.Vector" [color=8, group=7, label=" ", shape=invis, style=transparent]; } subgraph cluster_rhythmmakertools { graph [label=rhythmmakertools]; "abjad.tools.rhythmmakertools.PartitionTable.PartitionTable" [color=9, group=8, label=" ", shape=invis, style=transparent]; "abjad.tools.rhythmmakertools.RotationCounter.RotationCounter" [color=9, group=8, label=" ", shape=invis, style=transparent]; } subgraph cluster_scoretools { graph [label=scoretools]; "abjad.tools.scoretools.NoteHeadList.NoteHeadList" [color=1, group=9, label=" ", shape=invis, style=transparent]; } subgraph cluster_timespantools { graph [label=timespantools]; "abjad.tools.timespantools.CompoundInequality.CompoundInequality" [color=2, group=10, label=" ", shape=invis, style=transparent]; "abjad.tools.timespantools.TimespanList.TimespanList" [color=2, group=10, label=" ", shape=invis, style=transparent]; } subgraph cluster_tonalanalysistools { graph [label=tonalanalysistools]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.datastructuretools.TypedCollection.TypedCollection"; "abjad.tools.datastructuretools.TypedCounter.TypedCounter" -> "abjad.tools.metertools.OffsetCounter.OffsetCounter"; "abjad.tools.datastructuretools.TypedCounter.TypedCounter" -> "abjad.tools.pitchtools.Vector.Vector"; "abjad.tools.datastructuretools.TypedCounter.TypedCounter" -> "abjad.tools.rhythmmakertools.RotationCounter.RotationCounter"; "abjad.tools.datastructuretools.TypedFrozenset.TypedFrozenset" -> "abjad.tools.pitchtools.Set.Set"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.indicatortools.MetronomeMarkList.MetronomeMarkList"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.indicatortools.TimeSignatureList.TimeSignatureList"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.instrumenttools.ClefList.ClefList"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.instrumenttools.InstrumentList.InstrumentList"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.instrumenttools.PerformerList.PerformerList"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.markuptools.MarkupList.MarkupList"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.metertools.MeterList.MeterList"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.pitchtools.PitchRangeList.PitchRangeList"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.pitchtools.Registration.Registration"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.pitchtools.RegistrationList.RegistrationList"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.scoretools.NoteHeadList.NoteHeadList"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.timespantools.CompoundInequality.CompoundInequality"; "abjad.tools.datastructuretools.TypedList.TypedList" -> "abjad.tools.timespantools.TimespanList.TimespanList"; "abjad.tools.datastructuretools.TypedOrderedDict.TypedOrderedDict" -> "abjad.tools.rhythmmakertools.PartitionTable.PartitionTable"; "abjad.tools.datastructuretools.TypedTuple.TypedTuple" -> "abjad.tools.pitchtools.Segment.Segment"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

item_class Gets item class of collection.
items Gets items in collection.
__contains__(item) Is true when typed collection contains item.
__eq__(argument) Is true when argument is a typed collection with items that compare equal to those of this typed collection.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes typed collection.
__iter__() Iterates typed collection.
__len__() Gets length of typed collection.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

TypedCollection.item_class

Gets item class of collection.

Collection coerces items according to item_class.

Returns class.

TypedCollection.items

Gets items in collection.

Returns list.

Special methods

TypedCollection.__contains__(item)

Is true when typed collection contains item. Otherwise false.

Returns true or false.

TypedCollection.__eq__(argument)

Is true when argument is a typed collection with items that compare equal to those of this typed collection. Otherwise false.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

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

Returns string.

TypedCollection.__hash__()

Hashes typed collection.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

TypedCollection.__iter__()

Iterates typed collection.

Returns generator.

TypedCollection.__len__()

Gets length of typed collection.

Returns nonnegative integer.

(AbjadObject).__ne__(argument)

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

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.