ConstrainedResult

amari_optimization::constrained

Struct ConstrainedResult

pub struct ConstrainedResult<T: Float> {
    pub solution: Vec<T>,
    pub objective_value: T,
    pub lambda: Vec<T>,
    pub mu: Vec<T>,
    pub constraint_violations: Vec<T>,
    pub iterations: usize,
    pub converged: bool,
    pub kkt_error: T,
}

Expand description

Results from constrained optimization

Fields§

§solution: Vec<T>

Optimal solution

§objective_value: T

Optimal objective value

§lambda: Vec<T>

Lagrange multipliers for inequality constraints

§mu: Vec<T>

Lagrange multipliers for equality constraints

§constraint_violations: Vec<T>

Final constraint violations

§iterations: usize

Number of iterations performed

§converged: bool

Convergence status

§kkt_error: T

KKT error (measure of optimality)

Trait Implementations§

impl<T: Clone + Float> Clone for ConstrainedResult<T>

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

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T: Debug + Float> Debug for ConstrainedResult<T>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T> Freeze for ConstrainedResult<T>
where T: Freeze,

impl<T> RefUnwindSafe for ConstrainedResult<T>
where T: RefUnwindSafe,

impl<T> Send for ConstrainedResult<T>
where T: Send,

impl<T> Sync for ConstrainedResult<T>
where T: Sync,

impl<T> Unpin for ConstrainedResult<T>
where T: Unpin,

impl<T> UnwindSafe for ConstrainedResult<T>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V