Struct PitchClassMask 

pub struct PitchClassMask(/* private fields */);

A bitmask over the twelve pitch classes, with bit n set when pitch class n is present.

The low twelve bits represent pitch classes C through B.

Examples

use sim_lib_pitch_core::PitchClass;
use sim_lib_pitch_set::PitchClassMask;

let triad = PitchClassMask::from_pitch_classes(&[PitchClass::C, PitchClass::E, PitchClass::G]);
assert_eq!(triad.count_bits(), 3);

Implementations

impl PitchClassMask

pub fn gap_form(self) -> GapForm

Return adjacent cyclic gaps for this set’s pitch classes.

PitchClassMask has set identity, so duplicate pitch classes are already collapsed and zero gaps are absent. Use gap_form_from_pitch_classes when caller-owned multiplicity must be preserved.

pub fn interval_form(self) -> IntervalForm

Return directed pairwise intervals between all pitch classes in the set.

impl PitchClassMask

pub fn new(bits: u16) -> Result<Self, PitchSetError>

Builds a pitch-class mask, rejecting any bits outside the low twelve.

pub const fn bits(self) -> u16

Returns the raw low-twelve pitch-class bits.

pub fn from_pitch_classes(pitch_classes: &[PitchClass]) -> Self

Builds a mask from a slice of pitch classes; duplicates collapse to one bit.

pub fn pitch_classes(self) -> Vec<PitchClass>

Returns the set pitch classes in ascending order.

pub fn rotate(self, semitones: i32) -> Self

Returns this mask transposed by semitones, wrapping within the octave.

pub fn invert(self, axis: PitchClass) -> Self

Returns this mask inverted about axis.

pub fn invert_tni(self, index: u8) -> Self

Returns the conventional set-theory inversion TnI, where each pitch class p maps to index - p (mod 12).

Unlike PitchClassMask::invert, this accepts every integer inversion index, including odd indices whose geometric axis lies between pitch classes.

pub fn normalize(self) -> Self

Returns the rotation of this mask with the smallest numeric value, a transposition-invariant normal form.

pub fn normal_order(self) -> Vec<PitchClass>

Returns the conventional normal order for this set.

The result preserves cardinality and is transposed so the first pitch class is C. Use PitchClassMask::normalize when the older numeric mask identity is required instead.

pub fn classify(self, equivalence: SetEquivalence) -> SetClass

Classifies this mask using the requested conventional equivalence policy.

pub fn is_subset_of(self, other: Self) -> bool

Returns true when every pitch class in self is also in other.

pub fn is_superset_of(self, other: Self) -> bool

Returns true when every pitch class in other is also in self.

pub fn complement(self) -> Self

Returns the complement of this set in the twelve pitch-class universe.

pub fn union(self, other: Self) -> Self

Returns the union of this set and other.

pub fn intersection(self, other: Self) -> Self

Returns the pitch classes shared by this set and other.

pub fn difference(self, other: Self) -> Self

Returns the pitch classes in this set but not in other.

pub fn symmetric_difference(self, other: Self) -> Self

Returns the pitch classes belonging to exactly one of the two sets.

pub fn is_disjoint_from(self, other: Self) -> bool

Returns true when this set and other share no pitch classes.

pub fn transpositional_symmetries(self) -> Vec<u8>

Returns transpositions that map this set onto itself.

pub fn inversional_symmetries(self) -> Vec<PitchClass>

Returns inversion axes that map this set onto itself.

pub fn roots(self) -> Vec<PitchClass>

Returns likely tonal roots, derived from third-stack interpretations.

pub fn is_z_related_to(self, other: Self) -> bool

Returns true when both masks have the same interval vector but distinct transposition-inversion prime forms.

pub fn count_bits(self) -> u32

Returns the number of pitch classes in the set (the population count).

pub fn interval_vector(self) -> IntervalVector

Returns the IntervalVector tallying interval classes among the set’s pitch classes.

Trait Implementations

impl Clone for PitchClassMask

fn clone(&self) -> PitchClassMask

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for PitchClassMask

impl Debug for PitchClassMask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PitchClassMask

fn default() -> PitchClassMask

Returns the “default value” for a type.

impl Eq for PitchClassMask

impl Hash for PitchClassMask

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PitchClassMask

fn eq(&self, other: &PitchClassMask) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PitchClassMask