Struct persichetti::serialism::ToneRow

pub struct ToneRow<const D: usize> { /* fields omitted */ }

Implementations

impl<const D: usize> ToneRow<D>

pub fn new(p0: [usize; D]) -> Result<ToneRow<D>, ToneRowError>

pub fn p(&self, index: usize) -> [usize; D]

Retrieve a prime row. If you need the retrograde, call rev on it.

Panics

Panics if the index is out of bounds.

pub fn prime(&self, index: usize, conversion: Convert) -> [Note; D]

Retrieve a prime row. Prime rows are numbered by the number of half steps above P₀ that they are. For example, P₄ is 4 half-steps higher than P₀. If you need a Retrograde of a prime row, use rev in combination with this function. Retrogrades have the same number as their associated prime, i.e., R_n is the retrograde of P_n.

Panics

Panics if the index is out of bounds

pub fn i(&self, index: usize) -> [usize; D]

Retrieve a prime row as a numeric array. If you need the retrograde, call rev on it.

Panics

Panics if the index is out of bounds.

pub fn inversion(&self, index: usize, conversion: Convert) -> [Note; D]

Retrieve an inversion. Inversions are numbered by the number of half steps above I₀ that they are. For example, I₄ is 4 half-steps higher than I₀. If you need a Retrograde of a prime row, use rev in combination with this function. Retrogrades have the same number as their associated prime, i.e., R_n is the retrograde of P_n.

Panics

Panics if the index is out of bounds

Trait Implementations

impl<const D: usize> Clone for ToneRow<D>

fn clone(&self) -> ToneRow<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for ToneRow<D>

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

Formats the value using the given formatter.

impl<const D: usize> Eq for ToneRow<D>

impl<const D: usize> PartialEq<ToneRow<D>> for ToneRow<D>

fn eq(&self, other: &ToneRow<D>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ToneRow<D>) -> bool

This method tests for !=.

impl<const D: usize> StructuralEq for ToneRow<D>

impl<const D: usize> StructuralPartialEq for ToneRow<D>