Struct ClarabelOptions 

pub struct ClarabelOptions { /* private fields */ }

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

impl ClarabelOptions

pub fn verbosity(&self) -> Verbosity

Get crate-level verbosity.

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

Get immutable reference to raw Clarabel settings.

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

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

• 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 Topp3Profile 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.

Example

The example below shows the shared status-handling pattern for expert Clarabel APIs.

use copp::diag::CoppError;
use copp::solver::copp2_socp::{
    ClarabelOptionsBuilder, Copp2Problem, copp2_socp_expert,
};

fn inspect(problem: &Copp2Problem<'_, usize>) -> Result<(), CoppError> {
    let options = ClarabelOptionsBuilder::new()
        .allow_almost_solved(true)
        .build()?;

    let (profile, solution) = copp2_socp_expert(problem, &options)?;

    if options.is_allow(solution.status) {
        let a = profile.expect("accepted status should provide a profile");
        println!("accepted profile length = {}", a.len());
    } else {
        println!("solver status was not accepted: {:?}", solution.status);
    }

    Ok(())
}