.. _moduleSearchBase:

music21.search.base
===================

.. WARNING: DO NOT EDIT THIS FILE:
   AUTOMATICALLY GENERATED.
   PLEASE EDIT THE .py FILE DIRECTLY.

.. automodule:: music21.search.base

SearchMatch
-----------

.. autoclass:: music21.search.base.SearchMatch

.. rubric:: :class:`~music21.search.base.SearchMatch` bases

- :class:`~music21.search.base.SearchMatch`

.. rubric:: :class:`~music21.search.base.SearchMatch` instance variables

.. attribute:: SearchMatch.elStart

	The first element that matches the list.

.. attribute:: SearchMatch.els

	A tuple of all the matching elements.

.. attribute:: SearchMatch.index

	The index in the iterator at which the first element can be found

.. attribute:: SearchMatch.iterator

	The iterator which produced these elements.

StreamSearcher
--------------

.. autoclass:: music21.search.base.StreamSearcher

.. rubric:: :class:`~music21.search.base.StreamSearcher` methods

.. automethod:: music21.search.base.StreamSearcher.noteNameAlgorithm

.. automethod:: music21.search.base.StreamSearcher.rhythmAlgorithm

.. automethod:: music21.search.base.StreamSearcher.run

.. automethod:: music21.search.base.StreamSearcher.wildcardAlgorithm

Wildcard
--------

.. autoclass:: music21.search.base.Wildcard

.. rubric:: :class:`~music21.search.base.Wildcard` bases

- :class:`~music21.base.Music21Object`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.search.base.Wildcard` read-only properties

Read-only properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.beat`
   - :attr:`~music21.base.Music21Object.beatDuration`
   - :attr:`~music21.base.Music21Object.beatStr`
   - :attr:`~music21.base.Music21Object.beatStrength`
   - :attr:`~music21.base.Music21Object.hasEditorialInformation`
   - :attr:`~music21.base.Music21Object.hasStyleInformation`
   - :attr:`~music21.base.Music21Object.measureNumber`

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.search.base.Wildcard` read/write properties

Read/write properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.derivation`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.editorial`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`
   - :attr:`~music21.base.Music21Object.style`

.. rubric:: :class:`~music21.search.base.Wildcard` methods

Methods inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.__eq__`
   - :meth:`~music21.base.Music21Object.clearCache`
   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getOffsetInHierarchy`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :meth:`~music21.base.Music21Object.mergeAttributes`
   - :meth:`~music21.base.Music21Object.next`
   - :meth:`~music21.base.Music21Object.previous`
   - :meth:`~music21.base.Music21Object.purgeLocations`
   - :meth:`~music21.base.Music21Object.purgeOrphans`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.sortTuple`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.search.base.Wildcard` instance variables

Instance variables inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.sites`

WildcardDuration
----------------

.. autoclass:: music21.search.base.WildcardDuration

.. rubric:: :class:`~music21.search.base.WildcardDuration` bases

- :class:`~music21.duration.Duration`
- :class:`~music21.prebase.ProtoM21Object`
- :class:`~music21.common.objects.SlottedObjectMixin`

.. rubric:: :class:`~music21.search.base.WildcardDuration` read-only properties

Read-only properties inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.Duration.fullName`
   - :attr:`~music21.duration.Duration.isComplex`
   - :attr:`~music21.duration.Duration.ordinal`
   - :attr:`~music21.duration.Duration.quarterLengthNoTuplets`

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.search.base.WildcardDuration` read/write properties

Read/write properties inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.Duration.components`
   - :attr:`~music21.duration.Duration.dotGroups`
   - :attr:`~music21.duration.Duration.dots`
   - :attr:`~music21.duration.Duration.linked`
   - :attr:`~music21.duration.Duration.quarterLength`
   - :attr:`~music21.duration.Duration.tuplets`
   - :attr:`~music21.duration.Duration.type`

.. rubric:: :class:`~music21.search.base.WildcardDuration` methods

Methods inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.Duration.__eq__`
   - :meth:`~music21.duration.Duration.addDurationTuple`
   - :meth:`~music21.duration.Duration.aggregateTupletMultiplier`
   - :meth:`~music21.duration.Duration.appendTuplet`
   - :meth:`~music21.duration.Duration.augmentOrDiminish`
   - :meth:`~music21.duration.Duration.clear`
   - :meth:`~music21.duration.Duration.componentIndexAtQtrPosition`
   - :meth:`~music21.duration.Duration.componentStartTime`
   - :meth:`~music21.duration.Duration.consolidate`
   - :meth:`~music21.duration.Duration.currentComponents`
   - :meth:`~music21.duration.Duration.getGraceDuration`
   - :meth:`~music21.duration.Duration.informClient`
   - :meth:`~music21.duration.Duration.sliceComponentAtPosition`
   - :meth:`~music21.duration.Duration.splitDotGroups`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.search.base.WildcardDuration` instance variables

Instance variables inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.Duration.client`
   - :attr:`~music21.duration.Duration.expressionIsInferred`

Functions
---------

.. autofunction:: music21.search.base.approximateNoteSearch

.. autofunction:: music21.search.base.approximateNoteSearchNoRhythm

.. autofunction:: music21.search.base.approximateNoteSearchOnlyRhythm

.. autofunction:: music21.search.base.approximateNoteSearchWeighted

.. autofunction:: music21.search.base.mostCommonMeasureRhythms

.. autofunction:: music21.search.base.noteNameRhythmicSearch

.. autofunction:: music21.search.base.noteNameSearch

.. autofunction:: music21.search.base.rhythmicSearch

.. autofunction:: music21.search.base.streamSearchBase

.. autofunction:: music21.search.base.translateDiatonicStreamToString

.. autofunction:: music21.search.base.translateDurationToBytes

.. autofunction:: music21.search.base.translateIntervalsAndSpeed

.. autofunction:: music21.search.base.translateNoteTieToByte

.. autofunction:: music21.search.base.translateNoteToByte

.. autofunction:: music21.search.base.translateNoteWithDurationToBytes

.. autofunction:: music21.search.base.translateStreamToString

.. autofunction:: music21.search.base.translateStreamToStringNoRhythm

.. autofunction:: music21.search.base.translateStreamToStringOnlyRhythm