Skip to main content

QpLayer

pub struct QpLayer { /* private fields */ }
Expand description

An ADMM-based differentiable QP layer.

Stores problem data and the last forward-pass solution for use in the backward pass.

Implementations§

Source§

impl QpLayer

Source

pub fn new() -> Self

Create a new QP layer with default configuration.

Source

pub fn with_config(config: QpLayerConfig) -> Self

Create a new QP layer with custom configuration.

Source

pub fn forward( &mut self, q: Vec<Vec<f64>>, c: Vec<f64>, a_eq: Vec<Vec<f64>>, b_eq: Vec<f64>, g_ineq: Vec<Vec<f64>>, h_ineq: Vec<f64>, ) -> OptimizeResult<DiffOptResult>

Solve the QP (forward pass).

Uses ADMM with warm-start. The constraint matrix C = [A_eq; G_ineq] is stacked, and z is projected onto the feasible set:

z_eq = b_eq (equality: exact satisfaction) z_ineq = min(z_ineq_raw, h_ineq) (inequality: clamp to ≤ h)

§Arguments
  • q – n×n cost matrix (symmetric PSD).
  • c – n linear cost vector.
  • a_eq – p×n equality constraint matrix.
  • b_eq – p equality rhs.
  • g_ineq – m×n inequality constraint matrix.
  • h_ineq – m inequality rhs.
Source

pub fn backward(&self, dl_dx: &[f64]) -> OptimizeResult<DiffOptGrad>

Backward pass: compute parameter gradients via KKT sensitivity.

Uses the active-set at the solution to identify binding inequality constraints, stacks them with equality constraints, and calls kkt_sensitivity on the resulting system.

§Arguments
  • dl_dx – upstream gradient dL/dx (length n).
§Errors

Returns OptimizeError::ComputationError if no forward pass has been run, or if the KKT system is singular.

Source

pub fn last_solution(&self) -> Option<&[f64]>

Access the cached solution from the last forward pass.

Source

pub fn reset_warm_start(&mut self)

Reset warm-start cache.

Trait Implementations§

Source§

impl Clone for QpLayer

Source§

fn clone(&self) -> QpLayer

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 QpLayer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for QpLayer

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. 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

Source§

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