CoppClarabelSettings Struct Reference

Advanced raw Clarabel solver settings. More...

#include <core.h>

Data Fields
uint32_t	max_iter
	Maximum number of interior-point iterations.
double	time_limit
	Maximum solve time in seconds.
bool	verbose
	Enable Clarabel's internal solver log.
double	max_step_fraction
	Maximum interior-point step length.
double	tol_gap_abs
	Absolute duality-gap tolerance.
double	tol_gap_rel
	Relative duality-gap tolerance.
double	tol_feas
	Primal/dual feasibility tolerance.
double	tol_infeas_abs
	Absolute infeasibility tolerance.
double	tol_infeas_rel
	Relative infeasibility tolerance.
double	tol_ktratio
	Kappa/tau tolerance.
double	reduced_tol_gap_abs
	Reduced absolute duality-gap tolerance for almost-solved status.
double	reduced_tol_gap_rel
	Reduced relative duality-gap tolerance for almost-solved status.
double	reduced_tol_feas
	Reduced feasibility tolerance for almost-solved status.
double	reduced_tol_infeas_abs
	Reduced absolute infeasibility tolerance for almost-solved status.
double	reduced_tol_infeas_rel
	Reduced relative infeasibility tolerance for almost-solved status.
double	reduced_tol_ktratio
	Reduced kappa/tau tolerance for almost-solved status.
bool	equilibrate_enable
	Enable data equilibration before solving.
uint32_t	equilibrate_max_iter
	Maximum number of equilibration iterations.
double	equilibrate_min_scaling
	Minimum equilibration scaling.
double	equilibrate_max_scaling
	Maximum equilibration scaling.
double	linesearch_backtrack_step
	Backtracking factor used by the line search.
double	min_switch_step_length
	Minimum step length for asymmetric-cone switching.
double	min_terminate_step_length
	Minimum step length for termination checks.
uint32_t	max_threads
	Maximum solver threads.
bool	direct_kkt_solver
	Whether to use a direct KKT solver.
enum CoppClarabelDirectSolveMethod	direct_solve_method
	Direct linear solver method.
bool	static_regularization_enable
	Enable static KKT regularization.
double	static_regularization_constant
	Static KKT regularization constant.
double	static_regularization_proportional
	Static KKT regularization proportional term.
bool	dynamic_regularization_enable
	Enable dynamic KKT regularization.
double	dynamic_regularization_eps
	Dynamic regularization threshold.
double	dynamic_regularization_delta
	Dynamic regularization shift.
bool	iterative_refinement_enable
	Enable iterative refinement for direct solves.
double	iterative_refinement_reltol
	Iterative-refinement relative tolerance.
double	iterative_refinement_abstol
	Iterative-refinement absolute tolerance.
uint32_t	iterative_refinement_max_iter
	Iterative-refinement maximum iterations.
double	iterative_refinement_stop_ratio
	Iterative-refinement stalling ratio.
bool	presolve_enable
	Enable Clarabel presolve.
bool	input_sparse_dropzeros
	Drop structural zeros from sparse inputs before solving.

Detailed Description

Advanced raw Clarabel solver settings.

This mirrors the clarabel::solver::DefaultSettings<f64> fields available in the current build. Optional Clarabel backends, such as FAER or Pardiso, are selected through direct_solve_method; if the linked Clarabel was not compiled with that backend, the solve returns a solver/options error.

Field Documentation

max_iter

uint32_t CoppClarabelSettings::max_iter

Maximum number of interior-point iterations.

time_limit

double CoppClarabelSettings::time_limit

Maximum solve time in seconds.

verbose

bool CoppClarabelSettings::verbose

Enable Clarabel's internal solver log.

max_step_fraction

double CoppClarabelSettings::max_step_fraction

Maximum interior-point step length.

tol_gap_abs

double CoppClarabelSettings::tol_gap_abs

Absolute duality-gap tolerance.

tol_gap_rel

double CoppClarabelSettings::tol_gap_rel

Relative duality-gap tolerance.

tol_feas

double CoppClarabelSettings::tol_feas

Primal/dual feasibility tolerance.

tol_infeas_abs

double CoppClarabelSettings::tol_infeas_abs

Absolute infeasibility tolerance.

tol_infeas_rel

double CoppClarabelSettings::tol_infeas_rel

Relative infeasibility tolerance.

tol_ktratio

double CoppClarabelSettings::tol_ktratio

Kappa/tau tolerance.

reduced_tol_gap_abs

double CoppClarabelSettings::reduced_tol_gap_abs

Reduced absolute duality-gap tolerance for almost-solved status.

reduced_tol_gap_rel

double CoppClarabelSettings::reduced_tol_gap_rel

Reduced relative duality-gap tolerance for almost-solved status.

reduced_tol_feas

double CoppClarabelSettings::reduced_tol_feas

Reduced feasibility tolerance for almost-solved status.

reduced_tol_infeas_abs

double CoppClarabelSettings::reduced_tol_infeas_abs

Reduced absolute infeasibility tolerance for almost-solved status.

reduced_tol_infeas_rel

double CoppClarabelSettings::reduced_tol_infeas_rel

Reduced relative infeasibility tolerance for almost-solved status.

reduced_tol_ktratio

double CoppClarabelSettings::reduced_tol_ktratio

Reduced kappa/tau tolerance for almost-solved status.

equilibrate_enable

bool CoppClarabelSettings::equilibrate_enable

Enable data equilibration before solving.

equilibrate_max_iter

uint32_t CoppClarabelSettings::equilibrate_max_iter

Maximum number of equilibration iterations.

equilibrate_min_scaling

double CoppClarabelSettings::equilibrate_min_scaling

Minimum equilibration scaling.

equilibrate_max_scaling

double CoppClarabelSettings::equilibrate_max_scaling

Maximum equilibration scaling.

linesearch_backtrack_step

double CoppClarabelSettings::linesearch_backtrack_step

Backtracking factor used by the line search.

min_switch_step_length

double CoppClarabelSettings::min_switch_step_length

Minimum step length for asymmetric-cone switching.

min_terminate_step_length

double CoppClarabelSettings::min_terminate_step_length

Minimum step length for termination checks.

max_threads

uint32_t CoppClarabelSettings::max_threads

Maximum solver threads.

0 lets Clarabel choose.

direct_kkt_solver

bool CoppClarabelSettings::direct_kkt_solver

Whether to use a direct KKT solver.

Clarabel currently requires true.

direct_solve_method

enum CoppClarabelDirectSolveMethod CoppClarabelSettings::direct_solve_method

Direct linear solver method.

static_regularization_enable

bool CoppClarabelSettings::static_regularization_enable

Enable static KKT regularization.

static_regularization_constant

double CoppClarabelSettings::static_regularization_constant

Static KKT regularization constant.

static_regularization_proportional

double CoppClarabelSettings::static_regularization_proportional

Static KKT regularization proportional term.

dynamic_regularization_enable

bool CoppClarabelSettings::dynamic_regularization_enable

Enable dynamic KKT regularization.

dynamic_regularization_eps

double CoppClarabelSettings::dynamic_regularization_eps

Dynamic regularization threshold.

dynamic_regularization_delta

double CoppClarabelSettings::dynamic_regularization_delta

Dynamic regularization shift.

iterative_refinement_enable

bool CoppClarabelSettings::iterative_refinement_enable

Enable iterative refinement for direct solves.

iterative_refinement_reltol

double CoppClarabelSettings::iterative_refinement_reltol

Iterative-refinement relative tolerance.

iterative_refinement_abstol

double CoppClarabelSettings::iterative_refinement_abstol

Iterative-refinement absolute tolerance.

iterative_refinement_max_iter

uint32_t CoppClarabelSettings::iterative_refinement_max_iter

Iterative-refinement maximum iterations.

iterative_refinement_stop_ratio

double CoppClarabelSettings::iterative_refinement_stop_ratio

Iterative-refinement stalling ratio.

presolve_enable

bool CoppClarabelSettings::presolve_enable

Enable Clarabel presolve.

input_sparse_dropzeros

bool CoppClarabelSettings::input_sparse_dropzeros

Drop structural zeros from sparse inputs before solving.

---

The documentation for this struct was generated from the following file:

• bindings/c/include/copp/core.h