conspire 0.7.7

The Rust interface to conspire.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

use super::super::{Quantity, Scalar};
use crate::ABS_TOL;

/// Absolute error tolerances.
///
/// A constrained problem meets two quantities of different units, so one
/// number cannot serve them both. Which units those are is settled by the
/// problem rather than chosen here, so each is named where it is read back
/// rather than where it is set.
#[derive(Clone, Copy, Debug)]
pub struct Tolerances {
    /// Absolute error tolerance on the constraints.
    pub constraint: Scalar,
    /// Absolute error tolerance on the residual.
    pub residual: Scalar,
}

impl Tolerances {
    /// The tolerance on the constraint violation, as the unit it is met in.
    pub const fn constraint<U>(&self) -> Quantity<U> {
        Quantity::new(self.constraint)
    }
    /// The tolerance on the residual, as the unit it is met in.
    pub const fn residual<U>(&self) -> Quantity<U> {
        Quantity::new(self.residual)
    }
}

impl Default for Tolerances {
    fn default() -> Self {
        Self {
            constraint: ABS_TOL,
            residual: ABS_TOL,
        }
    }
}