Skip to main content

ConstraintSet

Enum ConstraintSet 

Source
pub enum ConstraintSet {
    Dense(LinearInequalityConstraints),
    KhatriRaoCone(KhatriRaoConeConstraints),
    BlockDiagonal {
        blocks: Vec<PlacedConstraintBlock>,
        total_cols: usize,
    },
}
Expand description

Closed union of the constraint carriers the blockwise solvers accept.

Variants§

§

Dense(LinearInequalityConstraints)

Explicit rows, exactly as today.

§

KhatriRaoCone(KhatriRaoConeConstraints)

Factored Khatri-Rao nonnegativity cone.

§

BlockDiagonal

Block-diagonal composition over disjoint column ranges of a joint coefficient vector (the multi-block joint-Newton assembly). Row ids are the concatenation of the member row ids in order.

Fields

§total_cols: usize

Implementations§

Source§

impl ConstraintSet

Source

pub fn block_diagonal( blocks: Vec<PlacedConstraintBlock>, total_cols: usize, ) -> Result<Self, String>

Validated block-diagonal composition: member column ranges must lie inside the joint width and must not overlap.

Source

pub fn nrows(&self) -> usize

Source

pub fn ncols(&self) -> usize

Source

pub fn values(&self, beta: ArrayView1<'_, f64>) -> Result<Array1<f64>, String>

Raw constraint values (dense) / factored functional values (cone).

Source

pub fn bound(&self, row: usize) -> Result<f64, String>

Right-hand sides (b dense; cone bounds are zero unless delta-shifted).

Source

pub fn row_norm(&self, row: usize) -> Result<f64, String>

Source

pub fn shifted_to_delta( &self, beta: ArrayView1<'_, f64>, ) -> Result<Self, String>

The same constraint system expressed in delta coordinates around beta: A(β + δ) ≥ b ⇔ Aδ ≥ b − Aβ. The matrix carrier is shared; only the O(nrows) bounds change.

Source

pub fn max_scaled_violation( &self, beta: ArrayView1<'_, f64>, ) -> Result<(f64, Option<usize>), String>

Scaled violation sweep: max_r (b_r − (Aβ)_r) / ‖a_r‖ restricted to non-vacuous rows, plus the arg-max row. Matches the canonicalized dense geometry (unit rows) without materializing it.

This is THE feasibility metric: β is feasible exactly when the value returned here is at or below PRIMAL_FEASIBILITY_TOL.

A vacuous row (‖a‖ = 0) with a bound at or below zero is 0 ≥ b, true for every β, and contributes nothing. A vacuous row with a POSITIVE bound is 0 ≥ b > 0: no β satisfies it, so its violation is infinite and the feasible set is empty. Reporting that as +∞ — rather than skipping the row — is what makes this metric agree with ConstraintSetOps::scaled_slack, which already answers −∞ for exactly this row, and keeps a gate built on this metric from silently admitting an unsatisfiable system.

A row that cannot be decided by comparison — a non-finite row norm, bound or a·β — is refused rather than skipped (gam#2721): feasibility of an iterate that is not a number is undefined, and violation > worst being false for NaN would report the neutral 0.0 — “nothing is violated” — for exactly the iterate this metric exists to catch.

Source

pub fn max_feasible_step( &self, beta: ArrayView1<'_, f64>, delta: ArrayView1<'_, f64>, skip_rows: &[usize], ) -> Result<(f64, Option<usize>), String>

Largest t ∈ [0, 1] with β + t·δ feasible for every row, together with the first blocking row (the EXACT ratio test of a primal active-set method — zero tolerance, raw slacks). Rows already violated at β are reported as blocking at t = 0.

This is the pivot rule: it answers “where does this chord cross a hyperplane in exact arithmetic”, and its consumers (the feasible-chord clipper) want exactly that. It is NOT the rule for sizing a Newton step — a globalization that demands exact feasibility rejects steps this carrier’s own contract calls feasible. Use ConstraintSet::max_contract_feasible_step for that.

Like the contract rule, this one is TOTAL (gam#2721): a row that cannot be decided by comparison — a non-finite row norm, bound, a·β or a·δ — and that was not explicitly skipped is refused, because every comparison it would otherwise feed is false for NaN and the answer would be an unlimited t = 1.

Source

pub fn gather_rows( &self, rows: &[usize], ) -> Result<LinearInequalityConstraints, String>

Materialize the requested rows densely (KKT systems on the active set).

Source

pub fn to_dense(&self) -> Result<LinearInequalityConstraints, String>

Exact dense equivalent of the whole set (tests / small systems only).

Trait Implementations§

Source§

impl Clone for ConstraintSet

Source§

fn clone(&self) -> ConstraintSet

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConstraintSet

Source§

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

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

impl From<LinearInequalityConstraints> for ConstraintSet

Source§

fn from(dense: LinearInequalityConstraints) -> Self

Converts to this type from the input type.

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

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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