Struct SolveReport 

pub struct SolveReport {
    pub converged: bool,
    pub max_residual: Scalar,
    pub iterations: usize,
    pub phases: Vec<Phase>,
    pub dof: usize,
    pub free_points: BTreeMap<PointId, bool>,
    pub free_curves: BTreeMap<CurveId, bool>,
    pub failed_constraints: Vec<ConstraintId>,
    pub unproven: Vec<String>,
}

The outcome of a solve.

Fields

converged: bool

Every constraint holds (to geop_core_math::solvers::system::RELATIVE_TOLERANCE of the sketch size).

max_residual: Scalar

Largest remaining constraint residual, in sketch units: an upper bound.

iterations: usize

phases: Vec<Phase>

Each minimization of the solve.

dof: usize

Remaining degrees of freedom: variables minus independent constraints — which are independent decided over the box an enclosure of the solution chose them over (see geop_core_math::solvers::system::System::freedom).

free_points: BTreeMap<PointId, bool>

Per point: whether it can still move without violating a constraint.

free_curves: BTreeMap<CurveId, bool>

Per curve: whether any of its points or its own sweep/radius can still change.

failed_constraints: Vec<ConstraintId>

The constraints left unsatisfied (conflicting or unreachable), empty when converged.

unproven: Vec<String>

Why no true solution near where the solve ended is proven, if none is: the constraints that conflict there, by id, or what is singular (see Sketch::enclose, which encloses it).

Trait Implementations

impl Clone for SolveReport

fn clone(&self) -> SolveReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SolveReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SolveReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SolveReport

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SolveReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SolveReport