Struct OctaveSpace 

pub struct OctaveSpace {
    pub divisions: NonZeroU16,
}

A positive modular division count for octave-like pitch spaces.

PitchClass and Pitch remain fixed to the canonical 12-class, MIDI-compatible pitch identity. OctaveSpace is for algorithms that need floor decomposition or circular distance in another positive division count.

Examples

use sim_lib_pitch_core::{split_floor, OctaveSpace};

let twelve = OctaveSpace::new(12).unwrap();
assert_eq!(split_floor(-13, twelve), (-2, 11));

Fields

divisions: NonZeroU16

Positive divisions in one octave-like cycle.

Implementations

impl OctaveSpace

pub fn new(divisions: u16) -> Result<Self, PitchError>

Constructs an octave space, rejecting zero-sized spaces.

pub fn twelve_tone() -> Self

Returns the canonical 12-division semitone space.

pub fn len(self) -> u16

Returns the positive division count.

pub fn is_empty(self) -> bool

Returns true because an OctaveSpace is always non-empty.

Trait Implementations

impl Clone for OctaveSpace

fn clone(&self) -> OctaveSpace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OctaveSpace

impl Debug for OctaveSpace

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

Formats the value using the given formatter.

impl Eq for OctaveSpace

impl Hash for OctaveSpace

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 OctaveSpace

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OctaveSpace