Struct Partial 

pub struct Partial {
    pub frequency: Frequency,
    pub amplitude: Amplitude,
    pub phase: Phase,
    pub tag: PartialTag,
}

A single sinusoidal component of a tone.

Fields

frequency: Frequency

Frequency of the component.

amplitude: Amplitude

Linear amplitude of the component.

phase: Phase

Starting phase of the component.

tag: PartialTag

Semantic source of the component within a tone.

Implementations

impl Partial

pub fn new( frequency: Frequency, amplitude: Amplitude, phase: Phase, ) -> Result<Self, SoundCoreError>

Builds a validated partial, normalizing the phase and rejecting invalid frequency or amplitude values.

pub fn tagged( frequency: Frequency, amplitude: Amplitude, phase: Phase, tag: PartialTag, ) -> Result<Self, SoundCoreError>

Builds a validated tagged partial, normalizing the phase and rejecting invalid frequency, amplitude, phase, or tag values.

Trait Implementations

impl Clone for Partial

fn clone(&self) -> Partial

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Partial

impl Debug for Partial

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

Formats the value using the given formatter.

impl PartialEq for Partial

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Partial