Struct Rectangle 

pub struct Rectangle<'a, T = f64> { /* private fields */ }

A rectangle, $R = \{x \in \mathbb{R}^n {}:{} x_{\min} {}\leq{} x {}\leq{} x_{\max}\}$

A set of the form $\{x \in \mathbb{R}^n {}:{} x_{\min} {}\leq{} x {}\leq{} x_{\max}\}$, where $\leq$ is meant in the element-wise sense and either of $x_{\min}$ and $x_{\max}$ can be equal to infinity.

Implementations

impl<'a, T: Float> Rectangle<'a, T>

pub fn new(xmin: Option<&'a [T]>, xmax: Option<&'a [T]>) -> Self

Construct a new rectangle with given $x_{\min}$ and $x_{\max}$

Arguments

• xmin: minimum value of x
• xmax: maximum value of x

Note

Rectangle does not copy xmin and xmax internally; it only keeps a reference. You may set one of xmin and xmax to None (but not both).

Panics

The method panics if:

• Both xmin and xmax are None (use NoConstraints instead)
• Both xmin and xmax have been provided, but they have incompatible dimensions

Example

use optimization_engine::constraints::{Constraint, Rectangle};

let xmin = [-1.0, 0.0];
let xmax = [1.0, 2.0];
let rectangle = Rectangle::new(Some(&xmin), Some(&xmax));
let mut x = [3.0, -4.0];
rectangle.project(&mut x).unwrap();

Trait Implementations

impl<'a, T: Clone> Clone for Rectangle<'a, T>

fn clone(&self) -> Rectangle<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Float> Constraint<T> for Rectangle<'a, T>

fn project(&self, x: &mut [T]) -> FunctionCallResult

Projection onto the set, that is,

fn is_convex(&self) -> bool

Returns true if and only if the set is convex

impl<'a, T: Copy> Copy for Rectangle<'a, T>