Skip to main content

ClarabelOptions

Struct ClarabelOptions 

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

Shared options for Clarabel-based optimization routines.

Field semantics:

  • verbosity: crate-level diagnostics switch used by this crate’s algorithms;
  • clarabel_settings: low-level Clarabel solver configuration passed to DefaultSolver::new.
  • allow_*: policy switches for accepting non-ideal Clarabel statuses when deciding whether an extracted a profile is considered usable by wrapper APIs. More details in ClarabelOptions::is_allow.
  • priority rule at build time: if verbosity <= Verbosity::Summary, builder will force clarabel_settings.verbose = false to avoid duplicate logs from both layers.

Implementations§

Source§

impl ClarabelOptions

Source

pub fn verbosity(&self) -> Verbosity

Get crate-level verbosity.

Source

pub fn clarabel_settings(&self) -> &DefaultSettings<f64>

Get immutable reference to raw Clarabel settings.

Source

pub fn is_allow(&self, status: SolverStatus) -> bool

Return whether a solver status (clarabel::solver::SolverStatus) is accepted by current policy.
Policy summary:

  • clarabel::solver::SolverStatus::Solved is always accepted;
  • selected non-ideal statuses are accepted only if their corresponding allow_* switch is enabled;
  • all other statuses are rejected.

Typical wrapper behavior based on this predicate:

  • accepted status (true) => return (Some(copp_solution), clarabel_solution);
  • rejected status (false) => return (None, clarabel_solution);
  • regardless of acceptance, always return full Clarabel solution for advanced users to inspect convergence and diagnostics.
  • copp_solution is typically a: Vec<f64> in TOPP2/COPP2 or (a: Vec<f64>, b: Vec<f64>, num_stationary: (usize, usize)) in TOPP3/COPP3. You can call clarabel_to_copp2_solution or clarabel_to_copp3_solution to generate a copp_solution from a clarabel_solution with a valid clarabel_solution.x.
  • clarabel_solution is the full DefaultSolution<f64> returned by Clarabel, which may contain useful information for expert users even when status is not ideal.

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> 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

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
§

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

§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.