Struct ClarabelOptionsBuilder 

pub struct ClarabelOptionsBuilder {
    pub clarabel_settings: DefaultSettings<f64>,
    pub allow_almost_solved: bool,
    pub allow_max_iterations: bool,
    pub allow_max_time: bool,
    pub allow_callback_terminated: bool,
    pub allow_insufficient_progress: bool,
    pub verbosity: Verbosity,
}

Builder for ClarabelOptions.

Usage policy:

• Keep default path minimal for common users (new);
• Allow expert tuning with raw Clarabel settings (with_clarabel_setting);
• By default, SolverStatus::Solved and SolverStatus::AlmostSolved are accepted; all other allow_* switches default to false;
• Normalize output behavior in build by applying verbosity-vs-clarabel logging precedence.

Fields

clarabel_settings: DefaultSettings<f64>

Raw Clarabel settings that will be embedded into built options.

allow_almost_solved: bool

Whether to accept SolverStatus::AlmostSolved as usable.

allow_max_iterations: bool

Whether to accept SolverStatus::MaxIterations as usable.

allow_max_time: bool

Whether to accept SolverStatus::MaxTime as usable.

allow_callback_terminated: bool

Whether to accept SolverStatus::CallbackTerminated as usable.

allow_insufficient_progress: bool

Whether to accept SolverStatus::InsufficientProgress as usable.

verbosity: Verbosity

Verbosity level for diagnostics during reachability analysis.

Implementations

impl ClarabelOptionsBuilder

pub fn new() -> Self

Create a builder with crate default Clarabel settings. Defaults:

• verbosity = Verbosity::Silent;
• clarabel_settings = default_clarabel_settings();
• allow_almost_solved = true, all other allow_* switches are false.

pub fn with_clarabel_setting(clarabel_settings: DefaultSettings<f64>) -> Self

Create a builder from caller-provided Clarabel settings. This is intended for users who need direct control over Clarabel tolerances, limits, or linear-solver behavior.

Example

The example below starts from raw Clarabel settings and then lets the shared builder normalize verbosity policy.

use copp::diag::Verbosity;
use copp::solver::copp2_socp::ClarabelOptionsBuilder;
use clarabel::solver::DefaultSettings;

let custom = DefaultSettings::<f64> {
    tol_gap_rel: 1e-7,
    max_iter: 300,
    verbose: true,
    ..Default::default()
};

let options = ClarabelOptionsBuilder::with_clarabel_setting(custom)
    .verbosity(Verbosity::Debug)
    .build()
    .expect("valid options");

assert!(options.clarabel_settings().tol_gap_rel <= 1.01e-7);

pub fn verbosity(self, verbosity: Verbosity) -> Self

Set crate-level verbosity used by solver wrappers and algorithm diagnostics.

pub fn clarabel_setting(self, clarabel_settings: DefaultSettings<f64>) -> Self

Replace Clarabel settings in the builder.

pub fn allow_almost_solved(self, allow: bool) -> Self

Allow SolverStatus::AlmostSolved. This is enabled by default; pass false for a strict solved-only policy. Rationale: AlmostSolved usually means the solver is very close to strict tolerances and the returned primal vector is often practically usable.

Integration contract used by wrapper APIs:

• if status is SolverStatus::Solved or enabled by allow_*, wrapper returns Some(a);
• otherwise wrapper returns None;
• in both branches, full Clarabel solution should still be returned to support expert post-analysis.

pub fn allow_max_iterations(self, allow: bool) -> Self

Allow SolverStatus::MaxIterations. Meaning: solver stopped because iteration cap was reached.

pub fn allow_max_time(self, allow: bool) -> Self

Allow SolverStatus::MaxTime. Meaning: solver stopped because time budget was reached.

pub fn allow_callback_terminated(self, allow: bool) -> Self

Allow SolverStatus::CallbackTerminated. Meaning: solver was terminated by user callback logic.

pub fn allow_insufficient_progress(self, allow: bool) -> Self

Allow SolverStatus::InsufficientProgress. Meaning: solver progress was judged insufficient before full convergence.

pub fn build(self) -> Result<ClarabelOptions, CoppError>

Build finalized ClarabelOptions. Normalization rule: if verbosity <= Verbosity::Summary, clarabel_settings.verbose is forcibly set to false. This keeps output ownership at crate level and avoids interleaved duplicate logs.

Trait Implementations

impl Default for ClarabelOptionsBuilder

fn default() -> Self

Returns the “default value” for a type.