ScsEigen::Settings class
#include <ScsEigen/Settings.h>

Contents

Public types

struct Impl

Constructors, destructors, conversion operators

Settings()
Constructor.
~Settings()

Public functions

void normalize(bool normalize)
auto normalize() const -> bool
auto scale(double scale) -> bool
Set the scaling factor.
auto scale() const -> double
Get the scaling factor.
auto rho(double rho) -> bool
Set the equality constraint scaling.
auto rho() const -> double
Get the scaling factor.
auto maxIterations(int iterations) -> bool
Set the maximum number of iterations.
auto maxIterations() const -> int
Get the number of iterations.
auto eps(double eps) -> bool
Set the convergence tolerance.
auto eps() const -> double
Get the convergence tolerance.
auto alpha(double alpha) -> bool
Set the relaxation parameter.
auto alpha() const -> double
Get the relaxation parameter.
void verbose(bool isVerbose)
Set the verbosity of the solver.
auto verbose() const -> bool
Is solver verbose?
void warmStart(bool warmStart)
Enable the warm start.
auto warmStart() const -> bool
Is warm start enabled?
auto accelerationLookback(int accelerationLookback) -> bool
Set the memory for acceleration.
auto accelerationLookback() -> int
Get the memory acceleration.
void writeDataFilename(std::string_view filename)
Set the filename used to store the data. @filename name of the file where the data will be stored.
auto writeDataFilename() const -> std::string_view
Get the filename.

Function documentation

ScsEigen::Settings::~Settings()

brief Destructor, Required for the pimpl idiom.

void ScsEigen::Settings::normalize(bool normalize)

Parameters
normalize if true the rescaling is enabled.

brief Enable the heuristic data rescaling.

bool ScsEigen::Settings::normalize() const

Returns true if the rescaling is enabled.

brief Is rescaling enabled?

bool ScsEigen::Settings::scale(double scale)

Set the scaling factor.

Parameters
scale a positive number.
Returns true in case of success, false otherwise.

double ScsEigen::Settings::scale() const

Get the scaling factor.

Returns the scaling factor.

bool ScsEigen::Settings::rho(double rho)

Set the equality constraint scaling.

Parameters
rho a positive number.
Returns true in case of success, false otherwise.

double ScsEigen::Settings::rho() const

Get the scaling factor.

Returns the scaling factor.

bool ScsEigen::Settings::maxIterations(int iterations)

Set the maximum number of iterations.

Parameters
iterations number of iterations
Returns true in case of success, false otherwise.

int ScsEigen::Settings::maxIterations() const

Get the number of iterations.

Returns the iterations.

bool ScsEigen::Settings::eps(double eps)

Set the convergence tolerance.

Parameters
eps convergence tolerance.
Returns true in case of success, false otherwise.

double ScsEigen::Settings::eps() const

Get the convergence tolerance.

Returns the tolerance.

bool ScsEigen::Settings::alpha(double alpha)

Set the relaxation parameter.

Parameters
alpha relaxation parameter.
Returns true in case of success, false otherwise.

double ScsEigen::Settings::alpha() const

Get the relaxation parameter.

Returns the parameter.

void ScsEigen::Settings::verbose(bool isVerbose)

Set the verbosity of the solver.

Parameters
isVerbose if true the solver will be verbose.

bool ScsEigen::Settings::verbose() const

Is solver verbose?

Returns true if the solver is verbose.

void ScsEigen::Settings::warmStart(bool warmStart)

Enable the warm start.

Parameters
warmStart if true the warm start is enable

bool ScsEigen::Settings::warmStart() const

Is warm start enabled?

Returns true if warm start is enabled.

bool ScsEigen::Settings::accelerationLookback(int accelerationLookback)

Set the memory for acceleration.

Returns true if the solver is verbose.

int ScsEigen::Settings::accelerationLookback()

Get the memory acceleration.

Returns the memory acceleration.

std::string_view ScsEigen::Settings::writeDataFilename() const

Get the filename.

Returns a string containing the filename.