Struct TranspositionChecker 

pub struct TranspositionChecker { /* private fields */ }

A set of pitches and its transpositions: music21’s TranspositionChecker.

Implementations

impl TranspositionChecker

pub fn new(pitches: Vec<Pitch>) -> Result<Self>

A checker of pitches.

Errors

No pitches, which music21 refuses too.

pub fn pitches(&self) -> &[Pitch]

The pitches checked.

pub fn transpositions(&self) -> Result<Vec<Vec<Pitch>>>

The set moved up by each of 0 to 11 semitones, spelled as music21 spells a pitch moved by a number: music21’s getTranspositions.

Errors

A pitch that cannot be moved.

pub fn normal_orders(&self) -> Result<Vec<Vec<u8>>>

The normal order of each transposition: music21’s listNormalOrders.

Errors

A pitch that cannot be moved.

pub fn distinct_normal_orders(&self) -> Result<Vec<Vec<u8>>>

The normal orders, each once, in the order first met: music21’s listDistinctNormalOrders.

Errors

A pitch that cannot be moved.

pub fn distinct_count(&self) -> Result<usize>

How many distinct transpositions the set has: music21’s numDistinctTranspositions.

use music21_rs::{Pitch, analysis::transposition::TranspositionChecker};

let augmented = ["C4", "E4", "G#4"].iter().map(|n| n.parse()).collect::<Result<_, _>>()?;
assert_eq!(TranspositionChecker::new(augmented)?.distinct_count()?, 4);

Errors

A pitch that cannot be moved.

pub fn distinct_chords(&self) -> Result<Vec<Chord>>

A chord of each distinct normal order, spelled as music21 spells a chord of pitch-class numbers: music21’s getChordsOfDistinctTranspositions.

Errors

A pitch that cannot be moved.

pub fn distinct_pitches(&self) -> Result<Vec<Vec<Pitch>>>

The pitches of each of those chords: music21’s getPitchesOfDistinctTranspositions.

Errors

A pitch that cannot be moved.

Trait Implementations

impl Clone for TranspositionChecker

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TranspositionChecker

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TranspositionChecker

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TranspositionChecker

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TranspositionChecker

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TranspositionChecker