SearchTree

abstract class quantizationtools.SearchTree(definition=None)

Abstract base class from which concrete SearchTree subclasses inherit.

SearchTrees encapsulate strategies for generating collections of QGrids, given a set of QEventProxy instances as input.

They allow composers to define the degree and quality of nested rhythmic subdivisions in the quantization output. That is to say, they allow composers to specify what sorts of tuplets and ratios of pulses may be contained within other tuplets, to arbitrary levels of nesting.

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

Bases

Attribute summary

default_definition The default search tree definition.
definition The search tree definition.
__call__(q_grid) Calls search tree.
__eq__(expr) Is true when expr is a search tree with definition equal to that of this search tree.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes search tree.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

abstract SearchTree.default_definition

The default search tree definition.

Returns dictionary.

SearchTree.definition

The search tree definition.

Returns dictionary.

Special methods

SearchTree.__call__(q_grid)

Calls search tree.

SearchTree.__eq__(expr)

Is true when expr is a search tree with definition equal to that of this search tree. 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.

SearchTree.__hash__()

Hashes search tree.

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

Returns integer.

(AbjadObject).__ne__(expr)

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

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.