Struct optimization_engine::core::problem::Problem[−][src]

pub struct Problem<'a, GradientType, ConstraintType, CostType> where
    GradientType: Fn(&[f64], &mut [f64]) -> FunctionCallResult,
    CostType: Fn(&[f64], &mut f64) -> FunctionCallResult,
    ConstraintType: Constraint,  { /* fields omitted */ }

Expand description

Definition of an optimisation problem

The definition of an optimisation problem involves:

the gradient of the cost function
the cost function
the set of constraints, which is described by implementations of Constraint

Implementations

[src]

impl<'a, GradientType, ConstraintType, CostType> Problem<'a, GradientType, ConstraintType, CostType> where
 GradientType: Fn(&[f64 ], &mut [f64 ]) -> FunctionCallResult,
 CostType: Fn(&[f64 ], &mut f64) -> FunctionCallResult,
 ConstraintType: Constraint,

[src]

pub fn new(
 constraints: &'a ConstraintType,
 cost_gradient: GradientType,
 cost: CostType
) -> Problem<'a, GradientType, ConstraintType, CostType>

Construct a new instance of an optimisation problem

Arguments

constraints constraints
cost_gradient gradient of the cost function
cost cost function

Returns

New instance of Problem

Auto Trait Implementations

impl<'a, GradientType, ConstraintType, CostType> RefUnwindSafe for Problem<'a, GradientType, ConstraintType, CostType> where
 ConstraintType: RefUnwindSafe,
 CostType: RefUnwindSafe,
 GradientType: RefUnwindSafe,

impl<'a, GradientType, ConstraintType, CostType> Send for Problem<'a, GradientType, ConstraintType, CostType> where
 ConstraintType: Sync,
 CostType: Send,
 GradientType: Send,

impl<'a, GradientType, ConstraintType, CostType> Sync for Problem<'a, GradientType, ConstraintType, CostType> where
 ConstraintType: Sync,
 CostType: Sync,
 GradientType: Sync,

impl<'a, GradientType, ConstraintType, CostType> Unpin for Problem<'a, GradientType, ConstraintType, CostType> where
CostType: Unpin,
GradientType: Unpin,

impl<'a, GradientType, ConstraintType, CostType> UnwindSafe for Problem<'a, GradientType, ConstraintType, CostType> where
 ConstraintType: RefUnwindSafe,
 CostType: UnwindSafe,
 GradientType: UnwindSafe,

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct optimization_engine::core::problem::Problem[−][src]

Implementations

impl<'a, GradientType, ConstraintType, CostType> Problem<'a, GradientType, ConstraintType, CostType> where
    GradientType: Fn(&[f64 ], &mut [f64 ]) -> FunctionCallResult,
    CostType: Fn(&[f64 ], &mut f64) -> FunctionCallResult,
    ConstraintType: Constraint,

pub fn new(
    constraints: &'a ConstraintType,
    cost_gradient: GradientType,
    cost: CostType
) -> Problem<'a, GradientType, ConstraintType, CostType>

Arguments

Returns

Auto Trait Implementations

impl<'a, GradientType, ConstraintType, CostType> RefUnwindSafe for Problem<'a, GradientType, ConstraintType, CostType> where
    ConstraintType: RefUnwindSafe,
    CostType: RefUnwindSafe,
    GradientType: RefUnwindSafe,

impl<'a, GradientType, ConstraintType, CostType> Send for Problem<'a, GradientType, ConstraintType, CostType> where
    ConstraintType: Sync,
    CostType: Send,
    GradientType: Send,

impl<'a, GradientType, ConstraintType, CostType> Sync for Problem<'a, GradientType, ConstraintType, CostType> where
    ConstraintType: Sync,
    CostType: Sync,
    GradientType: Sync,

impl<'a, GradientType, ConstraintType, CostType> Unpin for Problem<'a, GradientType, ConstraintType, CostType> where
CostType: Unpin,
GradientType: Unpin,

impl<'a, GradientType, ConstraintType, CostType> UnwindSafe for Problem<'a, GradientType, ConstraintType, CostType> where
    ConstraintType: RefUnwindSafe,
    CostType: UnwindSafe,
    GradientType: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct optimization_engine::core::problem::Problem[−][src]

Implementations

impl<'a, GradientType, ConstraintType, CostType> Problem<'a, GradientType, ConstraintType, CostType> where GradientType: Fn(&[f64], &mut [f64]) -> FunctionCallResult, CostType: Fn(&[f64], &mut f64) -> FunctionCallResult, ConstraintType: Constraint,

pub fn new( constraints: &'a ConstraintType, cost_gradient: GradientType, cost: CostType) -> Problem<'a, GradientType, ConstraintType, CostType>

Arguments

Returns

Auto Trait Implementations

impl<'a, GradientType, ConstraintType, CostType> RefUnwindSafe for Problem<'a, GradientType, ConstraintType, CostType> where ConstraintType: RefUnwindSafe, CostType: RefUnwindSafe, GradientType: RefUnwindSafe,

impl<'a, GradientType, ConstraintType, CostType> Send for Problem<'a, GradientType, ConstraintType, CostType> where ConstraintType: Sync, CostType: Send, GradientType: Send,

impl<'a, GradientType, ConstraintType, CostType> Sync for Problem<'a, GradientType, ConstraintType, CostType> where ConstraintType: Sync, CostType: Sync, GradientType: Sync,

impl<'a, GradientType, ConstraintType, CostType> Unpin for Problem<'a, GradientType, ConstraintType, CostType> where CostType: Unpin, GradientType: Unpin,

impl<'a, GradientType, ConstraintType, CostType> UnwindSafe for Problem<'a, GradientType, ConstraintType, CostType> where ConstraintType: RefUnwindSafe, CostType: UnwindSafe, GradientType: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<'a, GradientType, ConstraintType, CostType> Problem<'a, GradientType, ConstraintType, CostType> where
GradientType: Fn(&[f64 ], &mut [f64 ]) -> FunctionCallResult,
CostType: Fn(&[f64 ], &mut f64) -> FunctionCallResult,
ConstraintType: Constraint,

pub fn new(
constraints: &'a ConstraintType,
cost_gradient: GradientType,
cost: CostType
) -> Problem<'a, GradientType, ConstraintType, CostType>

impl<'a, GradientType, ConstraintType, CostType> RefUnwindSafe for Problem<'a, GradientType, ConstraintType, CostType> where
ConstraintType: RefUnwindSafe,
CostType: RefUnwindSafe,
GradientType: RefUnwindSafe,

impl<'a, GradientType, ConstraintType, CostType> Send for Problem<'a, GradientType, ConstraintType, CostType> where
ConstraintType: Sync,
CostType: Send,
GradientType: Send,

impl<'a, GradientType, ConstraintType, CostType> Sync for Problem<'a, GradientType, ConstraintType, CostType> where
ConstraintType: Sync,
CostType: Sync,
GradientType: Sync,

impl<'a, GradientType, ConstraintType, CostType> Unpin for Problem<'a, GradientType, ConstraintType, CostType> where
CostType: Unpin,
GradientType: Unpin,

impl<'a, GradientType, ConstraintType, CostType> UnwindSafe for Problem<'a, GradientType, ConstraintType, CostType> where
ConstraintType: RefUnwindSafe,
CostType: UnwindSafe,
GradientType: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,