Enum Triads 

pub enum Triads {
    Major = 0,
    Minor = 1,
    Augmented = 2,
    Diminished = 3,
}

The Triads implementation enumerates the allowed triad classifications determined by the intervals between the chord factors.

Variants

Major = 0

Minor = 1

Augmented = 2

Diminished = 3

Implementations

impl Triads

pub const fn is_major(&self) -> bool

Returns true if the enum is Triads::Major otherwise false

pub const fn is_minor(&self) -> bool

Returns true if the enum is Triads::Minor otherwise false

pub const fn is_augmented(&self) -> bool

Returns true if the enum is Triads::Augmented otherwise false

pub const fn is_diminished(&self) -> bool

Returns true if the enum is Triads::Diminished otherwise false

impl Triads

pub fn from_class<C>(class: C) -> Self

where C: TriadType,

pub fn is<T: TriadType>(&self, class: T) -> bool

pub const fn major() -> Self

a functional constructor for the Major variant

pub const fn minor() -> Self

a functional constructor for the Minor variant

pub const fn augmented() -> Self

a functional constructor for the Augmented variant

pub const fn diminished() -> Self

a functional constructor for the Diminished variant

pub fn try_from_notes(a: isize, b: isize, c: isize) -> Result<Self, TriadError>

try to derive a classification for a triad from three notes

pub fn try_from_arr(notes: [isize; 3]) -> Result<Self, TriadError>

try to determine the class of a triad from an array of three notes

pub const fn relative(&self) -> Self

returns the class relative to the current variant; for major and minor triads its rather straightforward

pub const fn intervals(&self) -> [usize; 3]

returns the intervals corresponding to the triad type as arrays of three usize values ordered as: [root_to_third, root_to_fifth, third_to_fifth]

pub const fn thirds(&self) -> (usize, usize)

returns the two third intervals defining the current variant

pub const fn root(&self) -> usize

returns the interval between the root and third chord factors

pub const fn root_ref(&self) -> &usize

returns a reference to the interval between the root and third chord factors

pub const fn third(&self) -> usize

returns the interval between the third and fifth chord factors

pub const fn third_ref(&self) -> &usize

returns a reference to the interval between the third and fifth chord factors

pub const fn fifth(&self) -> usize

returns the interval between the root and fifth chord factors

pub const fn fifth_ref(&self) -> &usize

returns a reference to the interval between the root and fifth chord factors

pub fn is_valid(&self, root: usize, third: usize, fifth: usize) -> bool

returns true if the given chord factors satisfy the requirements of the current class

pub fn validate<T>(&self, [r, t, f]: &[T; 3]) -> bool

where T: Copy + PartialEq + FromPrimitive + ToPrimitive + PitchMod<Output = T> + Sub<Output = T>,

validate a chord’s composition satisfies the requirements of the current class

Trait Implementations

impl AsRef<str> for Triads

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Triads

fn clone(&self) -> Triads

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Triads

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

Formats the value using the given formatter.

impl Default for Triads

fn default() -> Triads

Returns the “default value” for a type.

impl Display for Triads

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

Formats the value using the given formatter.

impl From<Augmented> for Triads

fn from(_value: Augmented) -> Self

Converts to this type from the input type.

impl From<Diminished> for Triads

fn from(_value: Diminished) -> Self

Converts to this type from the input type.

impl From<Major> for Triads

fn from(_value: Major) -> Self

Converts to this type from the input type.

impl From<Minor> for Triads

fn from(_value: Minor) -> Self

Converts to this type from the input type.

impl From<Triads> for i128

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for i16

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for i32

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for i64

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for i8

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for isize

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for u128

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for u16

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for u32

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for u64

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for u8

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<Triads> for usize

fn from(value: Triads) -> Self

Converts to this type from the input type.

impl From<i128> for Triads

fn from(value: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Triads

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Triads

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Triads

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Triads

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Triads

fn from(value: isize) -> Self

Converts to this type from the input type.

impl From<u128> for Triads

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Triads

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Triads

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Triads

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Triads

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Triads

fn from(value: usize) -> Self

Converts to this type from the input type.

impl FromStr for Triads

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Triads, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Triads

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 Index<Factors> for Triads

type Output = usize

The returned type after indexing.

fn index(&self, index: Factors) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IntoEnumIterator for Triads

type Iterator = TriadsIter

fn iter() -> TriadsIter

impl Ord for Triads

fn cmp(&self, other: &Triads) -> 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.

impl<C: TriadType> PartialEq<C> for Triads

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Triads

fn partial_cmp(&self, other: &Triads) -> 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 Relative for Triads

type Rel = Triads

fn rel(&self) -> Self::Rel

impl TriadType for Triads

fn new() -> Self

fn is_major(&self) -> bool

fn is_minor(&self) -> bool

fn is_augmented(&self) -> bool

fn is_diminished(&self) -> bool

fn root(&self) -> usize

fn fifth(&self) -> usize

fn third(&self) -> usize

fn dynamic(&self) -> Triads

consumes the instance, returning a variant of the [TriadClass] enum

impl TryFrom<&str> for Triads

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Triads, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<Triads> for Augmented

type Error = TriadError

The type returned in the event of a conversion error.

fn try_from(value: Triads) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Triads> for Diminished

type Error = TriadError

The type returned in the event of a conversion error.

fn try_from(value: Triads) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Triads> for Major

type Error = TriadError

The type returned in the event of a conversion error.

fn try_from(value: Triads) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Triads> for Minor

type Error = TriadError

The type returned in the event of a conversion error.

fn try_from(value: Triads) -> Result<Self, Self::Error>

Performs the conversion.

impl VariantArray for Triads

const VARIANTS: &'static [Self]

impl VariantNames for Triads

const VARIANTS: &'static [&'static str]

Names of the variants of this enum

impl Copy for Triads

impl Eq for Triads