Struct euphony_core::pitch::mode::intervals::ModeIntervals

pub struct ModeIntervals {
    pub tones: &'static [Interval],
    pub steps: &'static [Interval],
    pub intervals: &'static [Interval],
}

Fields

tones: &'static [Interval]

steps: &'static [Interval]

intervals: &'static [Interval]

Implementations

impl ModeIntervals

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

pub fn collapse(
    &self,
    interval: Interval,
    rounding_strategy: RoundingStrategy
) -> Interval

pub fn checked_collapse(
    &self,
    interval: Interval,
    rounding_strategy: RoundingStrategy
) -> Option<Interval>

pub fn expand(
    &self,
    interval: Interval,
    rounding_strategy: RoundingStrategy
) -> Interval

pub fn checked_expand(
    &self,
    interval: Interval,
    rounding_strategy: RoundingStrategy
) -> Option<Interval>

Trait Implementations

impl Clone for ModeIntervals

fn clone(&self) -> ModeIntervals

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ModeIntervals

impl Debug for ModeIntervals

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

Formats the value using the given formatter.

impl Display for ModeIntervals

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

Formats the value using the given formatter.

impl Div<ModeIntervals> for Interval

type Output = Interval

The resulting type after applying the / operator.

fn div(self, mode: ModeIntervals) -> Self::Output

Performs the / operation.

impl Eq for ModeIntervals

impl Hash for ModeIntervals

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Mul<Interval> for ModeIntervals

type Output = Interval

The resulting type after applying the * operator.

fn mul(self, interval: Interval) -> Self::Output

Performs the * operation.

impl Ord for ModeIntervals

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<ModeIntervals> for ModeIntervals

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

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

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

This method tests for !=.

impl PartialOrd<ModeIntervals> for ModeIntervals

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl StructuralEq for ModeIntervals

impl StructuralPartialEq for ModeIntervals