Struct ConvergenceCriterion 

#[non_exhaustive]
pub struct ConvergenceCriterion<F: Scalar = f64> {
    pub test: ConvergenceTest,
    pub evidence: ConvergenceEvidence<F>,
}

One precisely identified predicate and the measurements used to evaluate it.

Construct records with Self::new, Self::upper_bound, or Self::custom. Fields remain public for reading, moving, and assignment; destructuring must include ... Future optional metadata must default to behavior compatible with existing constructors. Optional reporting metadata belongs on this record so existing ConvergenceEvidence variant fields can stay fixed.

Struct literals are unavailable outside Basin:

use basin::{ConvergenceCriterion, ConvergenceEvidence, ConvergenceTest};

let criterion = ConvergenceCriterion::<f64> {
    test: ConvergenceTest::NoFreeParameters,
    evidence: ConvergenceEvidence::NoFreeParameters,
};

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

test: ConvergenceTest

The mathematical predicate that passed.

evidence: ConvergenceEvidence<F>

Measurements from the stopping decision.

Implementations

impl<F: Scalar> ConvergenceCriterion<F>

pub fn new(test: ConvergenceTest, evidence: ConvergenceEvidence<F>) -> Self

Construct a predicate report from its identity and evidence.

pub fn upper_bound( test: ConvergenceTest, value: F, bound: F, tolerance: F, reference: Option<F>, ) -> Self

Construct a predicate report with its measured value and bound.

pub fn custom( key: impl Into<String>, definition: impl Into<String>, measurements: Vec<Measurement<F>>, ) -> Self

Construct a namespaced predicate with its definition and measurements.

Trait Implementations

impl<F: Clone + Scalar> Clone for ConvergenceCriterion<F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Scalar> Debug for ConvergenceCriterion<F>

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

Formats the value using the given formatter.

impl<'de, F> Deserialize<'de> for ConvergenceCriterion<F>

where F: Deserialize<'de> + Scalar,

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: PartialEq + Scalar> PartialEq for ConvergenceCriterion<F>

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

Equality operator ==.

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

Inequality operator !=.

impl<F> Serialize for ConvergenceCriterion<F>

where F: Serialize + Scalar,

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: PartialEq + Scalar> StructuralPartialEq for ConvergenceCriterion<F>