Skip to main content

ToneStudy

Struct ToneStudy 

Source
pub struct ToneStudy { /* private fields */ }
Expand description

One positive-weight, independently certified coherent tone.

Implementations§

Source§

impl ToneStudy

Source

pub fn solve( problem: InterferenceProblem, plane: SamplingPlane, weight: f64, solver: ReferencePhasorSolver, ) -> Result<Self, MultiToneError>

Solves and seals one weighted frequency component.

The weight is checked before propagation work. The returned study owns the exact problem and plane used by the solver, so its field cannot be separated from or paired with different sampling evidence.

Source

pub fn problem(&self) -> &InterferenceProblem

Returns the exact coherent problem solved for this tone.

Source

pub fn frequency(&self) -> Hertz

Returns this tone’s frequency.

Source

pub fn weight(&self) -> f64

Returns this tone’s finite, strictly positive composition weight.

Source

pub fn plane(&self) -> SamplingPlane

Returns the exact physical plane on which this tone was solved.

Source

pub fn field(&self) -> &HostPhasorField

Borrows this tone’s complete coherent phasor field.

Source

pub fn evidence(&self) -> &SolveEvidence

Borrows the immutable evidence produced by this tone’s solve.

Source

pub fn sampling_certificate(&self) -> SamplingCertificate

Returns this component’s sampling certificate.

Trait Implementations§

Source§

impl Clone for ToneStudy

Source§

fn clone(&self) -> ToneStudy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToneStudy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ToneStudy

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ToneStudy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.