Enum ReferentialEvidence 

pub enum ReferentialEvidence {
    Chord {
        label: String,
        chord: ChordTemplate,
    },
    Scale {
        label: String,
        scale: Scale,
    },
    KeyRegion {
        label: String,
        key: Key,
        preferred_root: Option<PitchClass>,
    },
    PitchRatio {
        label: String,
        ratios: Vec<PitchRatio>,
        policy: RatioPolicy,
    },
    Mask {
        label: String,
        mask: PitchClassMask,
    },
}

Supported named evidence for one referential subset.

Variants

Chord

A named chord-template target.

Fields

label: String

Stable caller-facing label for the chord evidence.

chord: ChordTemplate

Exact chord template used to name the subset.

Scale

A named scale target.

Fields

label: String

Stable caller-facing label for the scale evidence.

scale: Scale

Exact scale used to test subset membership.

KeyRegion

A named key-region target with optional preferred root for labeling.

Fields

label: String

Stable caller-facing label for the key-region evidence.

key: Key

Key context used for membership and roman-numeral naming.

preferred_root: Option<PitchClass>

Preferred root used when the subset needs an explicit harmonic root.

PitchRatio

Exact ratio evidence for the subset’s voices.

Fields

label: String

Stable caller-facing label for the ratio evidence.

ratios: Vec<PitchRatio>

Exact root-relative ratios attached to the subset.

policy: RatioPolicy

Canonicalization policy used while evaluating the ratios.

Mask

Caller-declared mask evidence.

Fields

label: String

Stable caller-facing label for the mask evidence.

mask: PitchClassMask

Exact unordered pitch-class evidence supplied by the caller.

Implementations

impl ReferentialEvidence

pub fn label(&self) -> &str

Returns the stable evidence label supplied by the caller.

pub const fn kind(&self) -> ReferentialEvidenceKind

Returns the evidence kind.

Trait Implementations

impl Clone for ReferentialEvidence

fn clone(&self) -> ReferentialEvidence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferentialEvidence

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

Formats the value using the given formatter.

impl Eq for ReferentialEvidence

impl PartialEq for ReferentialEvidence

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReferentialEvidence