Skip to main content

ObjectiveKind

Enum ObjectiveKind 

Source
pub enum ObjectiveKind<S: Scalar> {
    Linear {
        c: Vec<S>,
    },
    Quadratic {
        h_row_major: Vec<S>,
        c: Vec<S>,
        n: usize,
    },
    Minimize {
        func: ScalarFn<S>,
        grad: Option<VectorFn<S>>,
    },
    LeastSquares {
        residual: VectorFn<S>,
        jacobian: Option<VectorFn<S>>,
        n_residuals: usize,
    },
    MultiObjective {
        funcs: Vec<ScalarFn<S>>,
    },
}
Expand description

Whether the objective is a scalar function or a least-squares residual.

Variants§

§

Linear

Linear objective: min c^T x

Fields

§c: Vec<S>
§

Quadratic

Quadratic objective: min 1/2 x^T H x + c^T x H stored row-major as Vec<S> (n*n), must be positive semi-definite.

Fields

§h_row_major: Vec<S>
§c: Vec<S>
§

Minimize

Fields

§func: ScalarFn<S>
§grad: Option<VectorFn<S>>
§

LeastSquares

Fields

§residual: VectorFn<S>
§jacobian: Option<VectorFn<S>>
§n_residuals: usize
§

MultiObjective

Multi-objective: minimize [f1(x), f2(x), …] simultaneously.

Fields

§funcs: Vec<ScalarFn<S>>

Auto Trait Implementations§

§

impl<S> Freeze for ObjectiveKind<S>

§

impl<S> !RefUnwindSafe for ObjectiveKind<S>

§

impl<S> !Send for ObjectiveKind<S>

§

impl<S> !Sync for ObjectiveKind<S>

§

impl<S> Unpin for ObjectiveKind<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for ObjectiveKind<S>

§

impl<S> !UnwindSafe for ObjectiveKind<S>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V