scirs2_optimize::differentiable_optimization::kkt_sensitivity

Struct NlpGrad

pub struct NlpGrad {
    pub dl_df_params: Vec<f64>,
    pub dl_dg_params: Vec<Vec<f64>>,
    pub dl_dh_params: Vec<Vec<f64>>,
    pub dx_adj: Vec<f64>,
    pub dlambda_adj: Vec<f64>,
    pub dnu_adj: Vec<f64>,
}

Expand description

Gradients for a general nonlinear program via the adjoint method.

Fields§

§dl_df_params: Vec<f64>

Gradient of loss w.r.t. objective gradient parameters (n).

§dl_dg_params: Vec<Vec<f64>>

Gradient of loss w.r.t. inequality constraint parameters (m × n adjoint).

§dl_dh_params: Vec<Vec<f64>>

Gradient of loss w.r.t. equality constraint parameters (p × n adjoint).

§dx_adj: Vec<f64>

Adjoint of primal variables (dx_adj).

§dlambda_adj: Vec<f64>

Adjoint of inequality duals (dlambda_adj).

§dnu_adj: Vec<f64>

Adjoint of equality duals (dnu_adj).

Trait Implementations§

Source §

impl Clone for NlpGrad

Source §

fn clone(&self) -> NlpGrad

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 NlpGrad

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for NlpGrad

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 §