Struct Val 

pub struct Val { /* private fields */ }

How many steps of a tuning each prime is worth.

⟨12 19 28] is twelve-tone equal temperament read to the 5-limit: twelve steps to the octave, nineteen to the perfect twelfth, twenty-eight to the major seventeenth. Applying it to a Monzo says how many steps that interval comes to, and a comma it sends to nothing is a comma the tuning tempers out.

use music21_rs::tuningsystem::{Monzo, Val};

let twelve = Val::patent(12, 5)?;
assert_eq!(twelve.entries(), [12, 19, 28]);
assert_eq!(twelve.map(&Monzo::from_ratio(3, 2)?), 7);
assert!(twelve.tempers_out(&Monzo::from_ratio(81, 80)?));

Implementations

impl Val

pub fn new(entries: impl Into<Vec<IntegerType>>) -> Self

Builds a val from step counts, lowest prime first.

Trailing zeros are kept, unlike a monzo’s: a val saying the seventh harmonic is worth no steps at all has said something about it, while a val that stops before it has not.

pub fn patent(divisions: IntegerType, limit: IntegerType) -> Result<Self>

The patent val of divisions equal steps, read up to limit.

Each prime is mapped to the nearest whole number of steps, which is what patent means: the obvious reading, before anyone chooses a warped one. Errors for a limit that is not a prime this module carries.

pub fn entries(&self) -> &[IntegerType]

The step counts, lowest prime first.

pub fn map(&self, interval: &Monzo) -> IntegerType

How many steps the val makes interval come to.

A prime the val does not reach is read as nought steps, so ask Val::reaches first where that would be a lie rather than an answer.

pub fn reaches(&self, interval: &Monzo) -> bool

Whether the val says anything about every prime interval uses.

pub fn tempers_out(&self, comma: &Monzo) -> bool

Whether the tuning tempers comma out — maps it to no steps at all.

pub fn divisions(&self) -> IntegerType

How many steps the val divides the octave into.

That is its first entry, since the first prime is two.

pub fn limit(&self) -> Option<IntegerType>

The largest prime the val reaches, or None for an empty one.

pub fn error_cents(&self, interval: &Monzo) -> Result<FloatType>

How far off interval sounds in this tuning, in cents.

Positive is sharp of just. The step size comes from the val’s own octave, so a val mapping the octave to nothing has no answer and this is an error.

Trait Implementations

impl Clone for Val

fn clone(&self) -> Val

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Val

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

Formats the value using the given formatter.

impl Default for Val

fn default() -> Val

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Val

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 Display for Val

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

Writes the val in the wiki’s own notation, ⟨12 19 28].

impl Eq for Val

impl FromStr for Val

fn from_str(text: &str) -> Result<Self>

Reads ⟨12 19 28], and the ASCII spelling <12 19 28] beside it.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Val

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 Ord for Val

fn cmp(&self, other: &Val) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Val

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Val

fn partial_cmp(&self, other: &Val) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Val

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 Val