scirs2_optimize::constrained::augmented_lagrangian

Struct AugmentedLagrangianResult

pub struct AugmentedLagrangianResult {
    pub x: Array1<f64>,
    pub fun: f64,
    pub lambda_eq: Option<Array1<f64>>,
    pub lambda_ineq: Option<Array1<f64>>,
    pub nit: usize,
    pub nfev: usize,
    pub success: bool,
    pub message: String,
    pub penalty: f64,
    pub constraint_violation: f64,
    pub optimality: f64,
}

Expand description

Result from augmented Lagrangian optimization

Fields§

§x: Array1<f64>

Optimal solution

§fun: f64

Optimal objective value

§lambda_eq: Option<Array1<f64>>

Lagrange multipliers for equality constraints

§lambda_ineq: Option<Array1<f64>>

Lagrange multipliers for inequality constraints

§nit: usize

Number of outer iterations

§nfev: usize

Total number of function evaluations

§success: bool

Success flag

§message: String

Status message

§penalty: f64

Final penalty parameter

§constraint_violation: f64

Final constraint violation

§optimality: f64

Final optimality measure

Trait Implementations§

Source §

impl Clone for AugmentedLagrangianResult

Source §

fn clone(&self) -> AugmentedLagrangianResult

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

Source §

impl Debug for AugmentedLagrangianResult

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for AugmentedLagrangianResult

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> CloneToUninit for T
where T: Clone,

Source §

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

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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 §