selection_is_full¶

auxjad.get.selection_is_full(selection: abjad.select.Selection) → bool [source]¶

Returns a bool representing whether the last measure of an input abjad.Selection is fully filled in or not.

Basic usage:

Returns True if the last measure of a selection is full, otherwise returns False. If no time signature is encountered at the beginning, it uses LilyPond’s convention and considers the container as in 4/4.

>>> container1 = abjad.Container(r"c'4 d'4 e'4 f'4")
>>> container2 = abjad.Container(r"c'4 d'4 e'4")
>>> container3 = abjad.Container(r"c'4 d'4 e'4 f'4 | c'4")
>>> container4 = abjad.Container(r"c'4 d'4 e'4 f'4 | c'4 d'4 e'4 f'4")
>>> auxjad.get.selection_is_full(container1[:])
True
>>> auxjad.get.selection_is_full(container2[:])
False
>>> auxjad.get.selection_is_full(container3[:])
False
>>> auxjad.get.selection_is_full(container4[:])
True

Note

Auxjad automatically adds this function as an extension function to abjad.get. It can thus be used from either auxjad.get or abjad.get namespaces. Therefore, the two lines below are equivalent:

>>> container = abjad.Container(r"c'4 d'4 e'4 f'4")
>>> auxjad.get.selection_is_full(container[:])
True
>>> abjad.get.selection_is_full(container[:])
True

Time signature changes:

Handles any time signatures as well as changes of time signature.

>>> container1 = abjad.Container(r"\time 4/4 c'4 d'4 e'4 f'4")
>>> container2 = abjad.Container(r"\time 3/4 a2. \time 2/4 r2")
>>> container3 = abjad.Container(r"\time 5/4 g1 ~ g4 \time 4/4 af'2")
>>> container4 = abjad.Container(r"\time 6/8 c'2 ~ c'8")
>>> auxjad.get.selection_is_full(container1[:])
True
>>> auxjad.get.selection_is_full(container2[:])
True
>>> auxjad.get.selection_is_full(container3[:])
False
>>> auxjad.get.selection_is_full(container4[:])
False

Partial time signatures:

Correctly handles partial time signatures.

>>> container = abjad.Container(r"c'4 d'4 e'4 f'4")
>>> time_signature = abjad.TimeSignature((3, 4), partial=(1, 4))
>>> abjad.attach(time_signature, container[0])
>>> auxjad.get.selection_is_full(container[:])
True

Multi-measure rests:

It also handles multi-measure rests.

>>> container1 = abjad.Container(r"R1")
>>> container2 = abjad.Container(r"\time 3/4 R1 * 3/4 \time 2/4 r2")
>>> container3 = abjad.Container(r"\time 5/4 R1 * 5/4 \time 4/4 g''4")
>>> container4 = abjad.Container(r"\time 6/8 R1 * 1/2")
>>> auxjad.get.selection_is_full(container1[:])
True
>>> auxjad.get.selection_is_full(container2[:])
True
>>> auxjad.get.selection_is_full(container3[:])
False
>>> auxjad.get.selection_is_full(container4[:])
False

Error

If a selection is malformed, i.e. it has an underfilled measure before a time signature change, the function raises a ValueError exception. This is also the case when a selection starts in the middle of a measure.

>>> container = abjad.Container(r"\time 5/4 g''1 \time 4/4 f'1")
>>> auxjad.get.selection_is_full(container[:])
ValueError: 'selection' is malformed, with an underfull measure
preceding a time signature change

Warning

The input selection must be a contiguous logical voice. When dealing with a container with multiple subcontainers (e.g. a score containing multiple staves), the best approach is to cycle through these subcontainers, applying this function to them individually.