Struct PitchMap 

pub struct PitchMap {
    pub domain: OctaveSpace,
    pub image: Vec<Option<i32>>,
    pub policy: PitchMapPolicy,
}

Partial map from folded source classes to absolute target offsets.

Fields

domain: OctaveSpace

Source octave-like domain.

image: Vec<Option<i32>>

Per-source-class target offsets. None records a hole.

policy: PitchMapPolicy

Policy for holes during pitch application.

Implementations

impl PitchMap

pub fn new( domain: OctaveSpace, image: Vec<Option<i32>>, policy: PitchMapPolicy, ) -> Result<Self, MapError>

Builds a pitch map and verifies that the image covers the whole domain.

pub fn identity(domain: OctaveSpace, policy: PitchMapPolicy) -> Self

Builds an identity map over domain.

pub fn chromatic_delta(semitones: i32) -> Self

Builds a chromatic transposition map in twelve-tone semitone space.

pub fn rotation(domain: OctaveSpace, steps: i32, policy: PitchMapPolicy) -> Self

Builds a pitch-class rotation map over any octave space.

pub fn inversion(axis: PitchClass) -> Self

Builds a twelve-tone inversion map around axis.

pub fn pitch_class_substitution( from: PitchClass, to: PitchClass, policy: PitchMapPolicy, ) -> Self

Builds a twelve-tone pitch-class substitution map.

pub fn from_scale(scale: Scale, policy: PitchMapPolicy) -> Self

Builds a partial scale-lock map whose holes are handled by policy.

pub fn is_partial(&self) -> bool

Returns true when at least one source class has no direct image.

pub fn map_pitch(&self, pitch: Pitch) -> Result<PitchMapResult, MapError>

Applies the map to a pitch, returning the pitch and an explicit witness.

pub fn inverse_witnesses(&self) -> Vec<MapInverseWitness>

Returns grouped direct inverse witnesses for every target value.

pub fn has_partial_inverse(&self) -> bool

Returns true when the direct inverse is incomplete or many-to-one.

Trait Implementations

impl Clone for PitchMap

fn clone(&self) -> PitchMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PitchMap

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

Formats the value using the given formatter.

impl Eq for PitchMap

impl PartialEq for PitchMap

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PitchMap