Skip to main content

DifferentiableQP

Struct DifferentiableQP 

Source
pub struct DifferentiableQP {
    pub q: Vec<Vec<f64>>,
    pub c: Vec<f64>,
    pub g: Vec<Vec<f64>>,
    pub h: Vec<f64>,
    pub a: Vec<Vec<f64>>,
    pub b: Vec<f64>,
}
Expand description

A differentiable QP layer.

Holds the problem data and supports forward solving and backward (gradient) computation.

Fields§

§q: Vec<Vec<f64>>

Quadratic cost matrix Q (n×n, symmetric positive semi-definite).

§c: Vec<f64>

Linear cost vector c (n).

§g: Vec<Vec<f64>>

Inequality constraint matrix G (m×n): Gx ≤ h.

§h: Vec<f64>

Inequality constraint rhs h (m).

§a: Vec<Vec<f64>>

Equality constraint matrix A (p×n): Ax = b.

§b: Vec<f64>

Equality constraint rhs b (p).

Implementations§

Source§

impl DifferentiableQP

Source

pub fn new( q: Vec<Vec<f64>>, c: Vec<f64>, g: Vec<Vec<f64>>, h: Vec<f64>, a: Vec<Vec<f64>>, b: Vec<f64>, ) -> OptimizeResult<Self>

Create a new differentiable QP.

§Arguments
  • q – n×n cost matrix (must be symmetric PSD).
  • c – n-dimensional linear cost.
  • g – m×n inequality constraint matrix.
  • h – m-dimensional inequality rhs.
  • a – p×n equality constraint matrix.
  • b – p-dimensional equality rhs.
Source

pub fn n(&self) -> usize

Number of primal variables.

Source

pub fn m(&self) -> usize

Number of inequality constraints.

Source

pub fn p(&self) -> usize

Number of equality constraints.

Source

pub fn forward(&self, config: &DiffQPConfig) -> OptimizeResult<DiffQPResult>

Solve the QP (forward pass).

Uses a primal-dual interior-point method with Mehrotra predictor- corrector steps.

Source

pub fn backward( &self, result: &DiffQPResult, dl_dx: &[f64], config: &DiffQPConfig, ) -> OptimizeResult<ImplicitGradient>

Backward pass: compute gradients of loss w.r.t. QP parameters.

Given the upstream gradient dl/dx*, returns the implicit gradients dl/d{Q, c, G, h, A, b}.

Source

pub fn batched_forward( params_list: &[DifferentiableQP], config: &DiffQPConfig, ) -> OptimizeResult<Vec<DiffQPResult>>

Solve multiple QPs with the same structure but different parameters.

This is a convenience method; each QP is solved independently.

Trait Implementations§

Source§

impl Clone for DifferentiableQP

Source§

fn clone(&self) -> DifferentiableQP

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 DifferentiableQP

Source§

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

Formats the value using the given formatter. 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,