pub struct ToneStudy { /* private fields */ }Expand description
One positive-weight, independently certified coherent tone.
Implementations§
Source§impl ToneStudy
impl ToneStudy
Sourcepub fn solve(
problem: InterferenceProblem,
plane: SamplingPlane,
weight: f64,
solver: ReferencePhasorSolver,
) -> Result<Self, MultiToneError>
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.
Sourcepub fn problem(&self) -> &InterferenceProblem
pub fn problem(&self) -> &InterferenceProblem
Returns the exact coherent problem solved for this tone.
Sourcepub fn plane(&self) -> SamplingPlane
pub fn plane(&self) -> SamplingPlane
Returns the exact physical plane on which this tone was solved.
Sourcepub fn field(&self) -> &HostPhasorField
pub fn field(&self) -> &HostPhasorField
Borrows this tone’s complete coherent phasor field.
Sourcepub fn evidence(&self) -> &SolveEvidence
pub fn evidence(&self) -> &SolveEvidence
Borrows the immutable evidence produced by this tone’s solve.
Sourcepub fn sampling_certificate(&self) -> SamplingCertificate
pub fn sampling_certificate(&self) -> SamplingCertificate
Returns this component’s sampling certificate.
Trait Implementations§
impl StructuralPartialEq for ToneStudy
Auto Trait Implementations§
impl Freeze for ToneStudy
impl RefUnwindSafe for ToneStudy
impl Send for ToneStudy
impl Sync for ToneStudy
impl Unpin for ToneStudy
impl UnsafeUnpin for ToneStudy
impl UnwindSafe for ToneStudy
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more