Enum Bound

pub enum Bound<T> {
    NoBound,
    LowerBound(T),
    UpperBound(T),
    LowerAndUpperBound(T, T),
}

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 unbounded Algorithms using parameter space transformations (experimental).

Variants

NoBound

(-inf, +inf)

LowerBound(T)

(min, +inf)

UpperBound(T)

(-inf, max)

LowerAndUpperBound(T, T)

(min, max)

Implementations

impl<T> Bound<T>

where T: Float + Scalar + Debug,

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

Checks whether the given value is compatible with the bounds.

pub fn lower(&self) -> T

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

pub fn upper(&self) -> T

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

pub fn at_bound(&self, value: T) -> 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: &[T], bounds: Option<&Vec<Self>>) -> DVector<T>

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: &[T], bounds: Option<&Vec<Self>>) -> DVector<T>

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<T: Clone> Clone for Bound<T>

fn clone(&self) -> Bound<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Bound<T>

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

Formats the value using the given formatter.

impl<T> Default for Bound<T>

fn default() -> Bound<T>

Returns the “default value” for a type.

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

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Bound<T>

where T: Scalar + Float + Display,

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

Formats the value using the given formatter.

impl<T> From<(T, T)> for Bound<T>

where T: Scalar + Float,

fn from(value: (T, T)) -> Self

Converts to this type from the input type.

impl<T> Serialize for Bound<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for Bound<T>