Struct PyConstraintStats 

pub struct PyConstraintStats {
    pub mean_residual: f64,
    pub max_residual: f64,
    pub mean_iterations: f64,
    pub warm_start_rate: f64,
    /* private fields */
}

Solver and constraint quality statistics.

Fields

mean_residual: f64

Mean solver residual per step.

max_residual: f64

Maximum residual observed.

mean_iterations: f64

Mean solver iterations used.

warm_start_rate: f64

Warm-start hit rate (fraction of constraints using warm start).

Implementations

impl PyConstraintStats

pub fn new() -> Self

Create empty stats.

pub fn record( &mut self, residual: f64, iterations: u32, warm_start_fraction: f64, )

Record a solver step.

pub fn is_converging(&self, threshold: f64) -> bool

True if the solver is converging well.

Trait Implementations

impl Clone for PyConstraintStats

fn clone(&self) -> PyConstraintStats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyConstraintStats

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

Formats the value using the given formatter.

impl Default for PyConstraintStats

fn default() -> PyConstraintStats

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PyConstraintStats

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PyConstraintStats

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

where __S: Serializer,

Serialize this value into the given Serde serializer.