Enum Bound

pub enum Bound {
    NoBound,
    LowerBound(f64),
    UpperBound(f64),
    LowerAndUpperBound(f64, f64),
}

An enum that describes a bound/limit on a parameter in a minimization.

Bounds take a generic T which represents some scalar numeric value. They can be used by bounded algorithms directly, or by some unbounded algorithms using parameter space transformations.

Variants

NoBound

(-inf, +inf)

LowerBound(f64)

(min, +inf)

UpperBound(f64)

(-inf, max)

LowerAndUpperBound(f64, f64)

(min, max)

Implementations

impl Bound

pub fn get_uniform(&self, rng: &mut Rng) -> f64

Get a value in the uniform distribution between lower and upper.

pub fn contains(&self, value: f64) -> bool

Checks whether the given value is compatible with the bounds.

pub fn contains_vec( bounds: &[Bound], vec: &Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>, ) -> bool

Checks whether the given DVector is compatible with the list of bounds in each coordinate.

pub fn bound_excess(&self, value: f64) -> f64

Checks whether the given value is compatible with the bound and returns 0.0 if it is, and the distance to the bound otherwise signed by whether the bound is a lower (-) or upper (+) bound.

pub fn bounds_excess( bounds: &[Bound], vec: &Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>, ) -> Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>

Checks whether each of the given DVector’s coordinates are compatible with the bounds and returns a DVector containing the result of Bound::bound_excess at each coordinate.

pub const fn lower(&self) -> f64

Returns the lower bound or -inf if there is none.

pub const fn upper(&self) -> f64

Returns the upper bound or +inf if there is none.

pub fn at_bound(&self, value: f64) -> bool

Checks if the given value is equal to one of the bounds.

TODO: his just does equality comparison right now, which probably needs to be improved to something with an epsilon (significant but not critical to most fits right now).

pub fn to_bounded( values: &[f64], bounds: Option<&Vec<Bound>>, ) -> Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>

Converts an unbounded “external” parameter into a bounded “internal” one via the transform:

Upper and lower bounds:

x_\text{int} = \arcsin\left(2\frac{x_\text{ext} - x_\text{min}}{x_\text{max} - x_\text{min}} - 1\right)

Upper bound only:

x_\text{int} = \sqrt{(x_\text{max} - x_\text{ext} + 1)^2 - 1}

Lower bound only:

x_\text{int} = \sqrt{(x_\text{ext} - x_\text{min} + 1)^2 - 1}

pub fn to_unbounded( values: &[f64], bounds: Option<&Vec<Bound>>, ) -> Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>

Converts a bounded “internal” parameter into an unbounded “external” one via the transform:

Upper and lower bounds:

x_\text{ext} = x_\text{min} + \left(\sin(x_\text{int}) + 1\right)\frac{x_\text{max} - x_\text{min}}{2}

Upper bound only:

x_\text{ext} = x_\text{max} + 1 - \sqrt{x_\text{int}^2 + 1}

Lower bound only:

x_\text{ext} = x_\text{min} - 1 + \sqrt{x_\text{int}^2 + 1}

Trait Implementations

impl Clone for Bound

fn clone(&self) -> Bound

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bound

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

Formats the value using the given formatter.

impl Default for Bound

fn default() -> Bound

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bound

fn deserialize<__D>( __deserializer: __D, ) -> Result<Bound, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Bound

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

Formats the value using the given formatter.

impl From<(Option<f64>, Option<f64>)> for Bound

fn from(value: (Option<f64>, Option<f64>)) -> Bound

Converts to this type from the input type.

impl From<(f64, f64)> for Bound

fn from(value: (f64, f64)) -> Bound

Converts to this type from the input type.

impl Serialize for Bound

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Bound