Struct PitchClassSet 

pub struct PitchClassSet {
    pub classes: HashSet<PitchClass>,
}

A collection of unique pitch classes, used in atonal music analysis.

Provides set theory operations like normal form, prime form, and interval class vectors.

Fields

classes: HashSet<PitchClass>

Implementations

impl PitchClassSet

pub fn new(classes: Vec<PitchClass>) -> Self

pub fn from_u8_values(values: Vec<u8>) -> Self

pub fn from_pitches(pitches: &[Pitch]) -> Self

pub fn normal_form(&self) -> PitchClassSet

Computes the normal form of the pitch class set.

Normal form is the most compact ordering of the set, starting from 0, with the smallest possible span. This provides a canonical representation for comparing sets regardless of transposition.

pub fn prime_form(&self) -> PitchClassSet

Computes the prime form of the pitch class set.

Prime form is the most compact form among the set and its inversion, providing a canonical representation that’s invariant under both transposition and inversion. This is used to identify set classes.

pub fn set_class(&self) -> Vec<PitchClassSet>

Generates all members of the set class (transpositions and inversions).

Returns all 24 possible transformations (12 transpositions × 2 for inversion) of the set, which together form the complete set class.

pub fn interval_class_vector(&self) -> [u8; 6]

Calculates the interval class vector of the set.

Returns a 6-element array counting occurrences of each interval class (1-6) between all pairs of pitch classes in the set. This provides a unique “fingerprint” for many set classes, useful for analysis and comparison.

Returns

Array where index 0 = minor seconds/major sevenths (ic1), index 1 = major seconds/minor sevenths (ic2), etc.

Trait Implementations

impl Clone for PitchClassSet

fn clone(&self) -> PitchClassSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PitchClassSet

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

Formats the value using the given formatter.

impl Eq for PitchClassSet

impl Hash for PitchClassSet

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 Invert for PitchClassSet

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

Inverts the musical object around the specified axis.

impl Ord for PitchClassSet

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PitchClassSet

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PitchClassSet

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for PitchClassSet

impl Transpose for PitchClassSet

fn transpose(&self, semitones: i32) -> Self

Transposes the musical object by the specified number of semitones.