Skip to main content

ClarabelPersistent

Struct ClarabelPersistent 

Source
pub struct ClarabelPersistent { /* private fields */ }
Expand description

A stateful Clarabel handle that keeps the built solver resident across solves.

Created by Clarabel::persistent. When the next model has the same dimensions, cone layout and P/A sparsity pattern, only the numeric data (P, q, A, b) is overwritten in place via Clarabel’s update_data, reusing the KKT symbolic factorization instead of rebuilding it. Any structural change — added/removed rows or columns, a changed sparsity pattern, a new cone, a flipped constraint sense that moves a row between cones — triggers a transparent full rebuild, so every result matches a cold Clarabel::solve.

Clarabel is an interior-point method and does not warm-start from the previous iterate, so iteration counts are unchanged; the saving is the skipped setup (equilibration structure, symbolic factorization, allocations).

In-place updates are rejected by Clarabel when presolve or structural-zero dropping altered the problem, in which case the handle falls back to a rebuild. Set presolve_enable(false) and input_sparse_dropzeros(false) (the defaults leave presolve on) to keep the fast path available.

A failed solve leaves the handle without a resident model; the next call rebuilds from scratch.

Implementations§

Source§

impl ClarabelPersistent

Source

pub fn new() -> Self

A fresh handle with no model loaded. The first solve builds it.

Source

pub fn reset(&mut self)

Drop the resident solver so the next solve rebuilds from scratch. After this, the next solve behaves exactly like a cold Clarabel::solve.

Trait Implementations§

Source§

impl Debug for ClarabelPersistent

Source§

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

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

impl Default for ClarabelPersistent

Source§

fn default() -> ClarabelPersistent

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

impl Solver for ClarabelPersistent

Source§

type Options = ClarabelOptions

Backend-specific options struct. Use () for solvers without any tunables.
Source§

fn name(&self) -> &str

Source§

fn supports(&self, kind: ModelKind) -> bool

Source§

fn solve( &mut self, model: &Model, opts: &ClarabelOptions, ) -> Result<SolverResult, SolverError>

Solves the given Model using this solver. 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> 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> 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> 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, 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