Simple dataclass used to store the configuration of the program. More...

#include <Configuration.h>

Public Types
enum class	Optimiser { GUROBI , ALGLIB , HIGHS }
	Underlying optimiser to use. More...

enum class	Estimator { KERNEL_RIDGE_REGRESSOR }
	Estimator class to use for regression. More...

enum class	Kernel { GAUSSIAN_KERNEL }
	Kernel class to use for the estimator. More...

enum class	FeatureMap { LINEAR_TRUNCATED_FOURIER_FEATURE_MAP , CONSTANT_TRUNCATED_FOURIER_FEATURE_MAP , LOG_TRUNCATED_FOURIER_FEATURE_MAP }
	Feature map class to use for transformation. More...

Public Member Functions
	Configuration ()=default
	Construct a new Configuration object.

int &	m_verbose ()
	Get read-only access to the `verbose` parameter of the configuration.

const int &	verbose () const
	Get read-write access to the `verbose` parameter of the configuration.

int &	m_seed ()
	Get read-only access to the `seed` parameter of the configuration.

const int &	seed () const
	Get read-write access to the `seed` parameter of the configuration.

bool &	m_plot ()
	Get read-only access to the `plot` parameter of the configuration.

const bool &	plot () const
	Get read-write access to the `plot` parameter of the configuration.

bool &	m_verify ()
	Get read-only access to the `verify` parameter of the configuration.

const bool &	verify () const
	Get read-write access to the `verify` parameter of the configuration.

std::string &	m_problem_log_file ()
	Get read-only access to the `problem_log_file` parameter of the configuration.

const std::string &	problem_log_file () const
	Get read-write access to the `problem_log_file` parameter of the configuration.

std::string &	m_iis_log_file ()
	Get read-only access to the `iis_log_file` parameter of the configuration.

const std::string &	iis_log_file () const
	Get read-write access to the `iis_log_file` parameter of the configuration.

std::function< Matrix(Matrix)> &	m_system_dynamics ()
	Get read-only access to the `system_dynamics` parameter of the configuration.

const std::function< Matrix(Matrix)> &	system_dynamics () const
	Get read-write access to the `system_dynamics` parameter of the configuration.

std::unique_ptr< Set > &	m_X_bounds ()
	Get read-only access to the `X_bounds` parameter of the configuration.

const std::unique_ptr< Set > &	X_bounds () const
	Get read-write access to the `X_bounds` parameter of the configuration.

std::unique_ptr< Set > &	m_X_init ()
	Get read-only access to the `X_init` parameter of the configuration.

const std::unique_ptr< Set > &	X_init () const
	Get read-write access to the `X_init` parameter of the configuration.

std::unique_ptr< Set > &	m_X_unsafe ()
	Get read-only access to the `X_unsafe` parameter of the configuration.

const std::unique_ptr< Set > &	X_unsafe () const
	Get read-write access to the `X_unsafe` parameter of the configuration.

Matrix &	m_x_samples ()
	Get read-only access to the `x_samples` parameter of the configuration.

const Matrix &	x_samples () const
	Get read-write access to the `x_samples` parameter of the configuration.

Matrix &	m_xp_samples ()
	Get read-only access to the `xp_samples` parameter of the configuration.

const Matrix &	xp_samples () const
	Get read-write access to the `xp_samples` parameter of the configuration.

Matrix &	m_f_xp_samples ()
	Get read-only access to the `f_xp_samples` parameter of the configuration.

const Matrix &	f_xp_samples () const
	Get read-write access to the `f_xp_samples` parameter of the configuration.

int &	m_num_samples ()
	Get read-only access to the `num_samples` parameter of the configuration.

const int &	num_samples () const
	Get read-write access to the `num_samples` parameter of the configuration.

double &	m_noise_scale ()
	Get read-only access to the `noise_scale` parameter of the configuration.

const double &	noise_scale () const
	Get read-write access to the `noise_scale` parameter of the configuration.

double &	m_lambda ()
	Get read-only access to the `lambda` parameter of the configuration.

const double &	lambda () const
	Get read-write access to the `lambda` parameter of the configuration.

double &	m_sigma_f ()
	Get read-only access to the `sigma_f` parameter of the configuration.

const double &	sigma_f () const
	Get read-write access to the `sigma_f` parameter of the configuration.

Vector &	m_sigma_l ()
	Get read-only access to the `sigma_l` parameter of the configuration.

const Vector &	sigma_l () const
	Get read-write access to the `sigma_l` parameter of the configuration.

int &	m_num_frequencies ()
	Get read-only access to the `num_frequencies` parameter of the configuration.

const int &	num_frequencies () const
	Get read-write access to the `num_frequencies` parameter of the configuration.

double &	m_oversample_factor ()
	Get read-only access to the `oversample_factor` parameter of the configuration.

const double &	oversample_factor () const
	Get read-write access to the `oversample_factor` parameter of the configuration.

int &	m_lattice_resolution ()
	Get read-only access to the `lattice_resolution` parameter of the configuration.

const int &	lattice_resolution () const
	Get read-write access to the `lattice_resolution` parameter of the configuration.

double &	m_gamma ()
	Get read-only access to the `gamma` parameter of the configuration.

const double &	gamma () const
	Get read-write access to the `gamma` parameter of the configuration.

double &	m_C_coeff ()
	Get read-only access to the `C_coeff` parameter of the configuration.

const double &	C_coeff () const
	Get read-write access to the `C_coeff` parameter of the configuration.

int &	m_time_horizon ()
	Get read-only access to the `time_horizon` parameter of the configuration.

const int &	time_horizon () const
	Get read-write access to the `time_horizon` parameter of the configuration.

double &	m_epsilon ()
	Get read-only access to the `epsilon` parameter of the configuration.

const double &	epsilon () const
	Get read-write access to the `epsilon` parameter of the configuration.

double &	m_b_norm ()
	Get read-only access to the `b_norm` parameter of the configuration.

const double &	b_norm () const
	Get read-write access to the `b_norm` parameter of the configuration.

double &	m_b_kappa ()
	Get read-only access to the `b_kappa` parameter of the configuration.

const double &	b_kappa () const
	Get read-write access to the `b_kappa` parameter of the configuration.

Estimator &	m_estimator ()
	Get read-only access to the `estimator` parameter of the configuration.

const Estimator &	estimator () const
	Get read-write access to the `estimator` parameter of the configuration.

Kernel &	m_kernel ()
	Get read-only access to the `kernel` parameter of the configuration.

const Kernel &	kernel () const
	Get read-write access to the `kernel` parameter of the configuration.

FeatureMap &	m_feature_map ()
	Get read-only access to the `feature_map` parameter of the configuration.

const FeatureMap &	feature_map () const
	Get read-write access to the `feature_map` parameter of the configuration.

Optimiser &	m_optimiser ()
	Get read-only access to the `optimiser` parameter of the configuration.

const Optimiser &	optimiser () const
	Get read-write access to the `optimiser` parameter of the configuration.

Detailed Description

Simple dataclass used to store the configuration of the program.

Member Enumeration Documentation

◆ Estimator

enum class lucid::Configuration::Estimator

strong

Estimator class to use for regression.

Enumerator
KERNEL_RIDGE_REGRESSOR	Kernel Ridge Regressor. Default option.

◆ FeatureMap

enum class lucid::Configuration::FeatureMap

strong

Feature map class to use for transformation.

Enumerator
LINEAR_TRUNCATED_FOURIER_FEATURE_MAP	Linear Truncated Fourier Feature Map. Default option.
CONSTANT_TRUNCATED_FOURIER_FEATURE_MAP	Constant Truncated Fourier Feature Map.
LOG_TRUNCATED_FOURIER_FEATURE_MAP	Log Truncated Fourier Feature Map.

◆ Kernel

enum class lucid::Configuration::Kernel

strong

Kernel class to use for the estimator.

Enumerator
GAUSSIAN_KERNEL	Gaussian Kernel. Default option.

◆ Optimiser

enum class lucid::Configuration::Optimiser

strong

Underlying optimiser to use.

Enumerator
GUROBI	Gurobi optimiser. Default option.
ALGLIB	Alglib optimiser.
HIGHS	HiGHS optimiser.

Member Function Documentation

◆ b_kappa()

const double & lucid::Configuration::b_kappa ( ) const

inlinenodiscard

Get read-write access to the b_kappa parameter of the configuration.

Default to 1.0

Returns: b_kappa parameter of the configuration

◆ b_norm()

const double & lucid::Configuration::b_norm ( ) const

inlinenodiscard

Get read-write access to the b_norm parameter of the configuration.

Default to 1.0

Returns: b_norm parameter of the configuration

◆ C_coeff()

const double & lucid::Configuration::C_coeff ( ) const

inlinenodiscard

Get read-write access to the C_coeff parameter of the configuration.

Default to 1.0

Returns: C_coeff parameter of the configuration

◆ epsilon()

const double & lucid::Configuration::epsilon ( ) const

inlinenodiscard

Get read-write access to the epsilon parameter of the configuration.

Default to 0.0

Returns: epsilon parameter of the configuration

◆ estimator()

const Estimator & lucid::Configuration::estimator ( ) const

inlinenodiscard

Get read-write access to the estimator parameter of the configuration.

Default to Estimator::KERNEL_RIDGE_REGRESSOR

Returns: estimator parameter of the configuration

◆ f_xp_samples()

const Matrix & lucid::Configuration::f_xp_samples ( ) const

inlinenodiscard

Get read-write access to the f_xp_samples parameter of the configuration.

Default to emptyMatrix

Returns: f_xp_samples parameter of the configuration

◆ feature_map()

const FeatureMap & lucid::Configuration::feature_map ( ) const

inlinenodiscard

Get read-write access to the feature_map parameter of the configuration.

Default to FeatureMap::LINEAR_TRUNCATED_FOURIER_FEATURE_MAP

Returns: feature_map parameter of the configuration

◆ gamma()

const double & lucid::Configuration::gamma ( ) const

inlinenodiscard

Get read-write access to the gamma parameter of the configuration.

Default to 1.0

Returns: gamma parameter of the configuration

◆ iis_log_file()

const std::string & lucid::Configuration::iis_log_file ( ) const

inlinenodiscard

Get read-write access to the iis_log_file parameter of the configuration.

Default to ""

Returns: iis_log_file parameter of the configuration

◆ kernel()

const Kernel & lucid::Configuration::kernel ( ) const

inlinenodiscard

Get read-write access to the kernel parameter of the configuration.

Default to Kernel::GAUSSIAN_KERNEL

Returns: kernel parameter of the configuration

◆ lambda()

const double & lucid::Configuration::lambda ( ) const

inlinenodiscard

Get read-write access to the lambda parameter of the configuration.

Default to 1e-6

Returns: lambda parameter of the configuration

◆ lattice_resolution()

const int & lucid::Configuration::lattice_resolution ( ) const

inlinenodiscard

Get read-write access to the lattice_resolution parameter of the configuration.

Default to -1

Returns: lattice_resolution parameter of the configuration

◆ m_b_kappa()

double & lucid::Configuration::m_b_kappa ( )

inline

Get read-only access to the b_kappa parameter of the configuration.

Default to 1.0

Returns: b_kappa parameter of the configuration

◆ m_b_norm()

double & lucid::Configuration::m_b_norm ( )

inline

Get read-only access to the b_norm parameter of the configuration.

Default to 1.0

Returns: b_norm parameter of the configuration

◆ m_C_coeff()

double & lucid::Configuration::m_C_coeff ( )

inline

Get read-only access to the C_coeff parameter of the configuration.

Default to 1.0

Returns: C_coeff parameter of the configuration

◆ m_epsilon()

double & lucid::Configuration::m_epsilon ( )

inline

Get read-only access to the epsilon parameter of the configuration.

Default to 0.0

Returns: epsilon parameter of the configuration

◆ m_estimator()

Estimator & lucid::Configuration::m_estimator ( )

inline

Get read-only access to the estimator parameter of the configuration.

Default to Estimator::KERNEL_RIDGE_REGRESSOR

Returns: estimator parameter of the configuration

◆ m_f_xp_samples()

Matrix & lucid::Configuration::m_f_xp_samples ( )

inline

Get read-only access to the f_xp_samples parameter of the configuration.

Default to emptyMatrix

Returns: f_xp_samples parameter of the configuration

◆ m_feature_map()

FeatureMap & lucid::Configuration::m_feature_map ( )

inline

Get read-only access to the feature_map parameter of the configuration.

Default to FeatureMap::LINEAR_TRUNCATED_FOURIER_FEATURE_MAP

Returns: feature_map parameter of the configuration

◆ m_gamma()

double & lucid::Configuration::m_gamma ( )

inline

Get read-only access to the gamma parameter of the configuration.

Default to 1.0

Returns: gamma parameter of the configuration

◆ m_iis_log_file()

std::string & lucid::Configuration::m_iis_log_file ( )

inline

Get read-only access to the iis_log_file parameter of the configuration.

Default to ""

Returns: iis_log_file parameter of the configuration

◆ m_kernel()

Kernel & lucid::Configuration::m_kernel ( )

inline

Get read-only access to the kernel parameter of the configuration.

Default to Kernel::GAUSSIAN_KERNEL

Returns: kernel parameter of the configuration

◆ m_lambda()

double & lucid::Configuration::m_lambda ( )

inline

Get read-only access to the lambda parameter of the configuration.

Default to 1e-6

Returns: lambda parameter of the configuration

◆ m_lattice_resolution()

int & lucid::Configuration::m_lattice_resolution ( )

inline

Get read-only access to the lattice_resolution parameter of the configuration.

Default to -1

Returns: lattice_resolution parameter of the configuration

◆ m_noise_scale()

double & lucid::Configuration::m_noise_scale ( )

inline

Get read-only access to the noise_scale parameter of the configuration.

Default to 0.01

Returns: noise_scale parameter of the configuration

◆ m_num_frequencies()

int & lucid::Configuration::m_num_frequencies ( )

inline

Get read-only access to the num_frequencies parameter of the configuration.

Default to 10

Returns: num_frequencies parameter of the configuration

◆ m_num_samples()

int & lucid::Configuration::m_num_samples ( )

inline

Get read-only access to the num_samples parameter of the configuration.

Default to 1000

Returns: num_samples parameter of the configuration

◆ m_optimiser()

Optimiser & lucid::Configuration::m_optimiser ( )

inline

Get read-only access to the optimiser parameter of the configuration.

Default to Optimiser::GUROBI

Returns: optimiser parameter of the configuration

◆ m_oversample_factor()

double & lucid::Configuration::m_oversample_factor ( )

inline

Get read-only access to the oversample_factor parameter of the configuration.

Default to 2.0

Returns: oversample_factor parameter of the configuration

◆ m_plot()

bool & lucid::Configuration::m_plot ( )

inline

Get read-only access to the plot parameter of the configuration.

Default to false

Returns: plot parameter of the configuration

◆ m_problem_log_file()

std::string & lucid::Configuration::m_problem_log_file ( )

inline

Get read-only access to the problem_log_file parameter of the configuration.

Default to ""

Returns: problem_log_file parameter of the configuration

◆ m_seed()

int & lucid::Configuration::m_seed ( )

inline

Get read-only access to the seed parameter of the configuration.

Default to -1

Returns: seed parameter of the configuration

◆ m_sigma_f()

double & lucid::Configuration::m_sigma_f ( )

inline

Get read-only access to the sigma_f parameter of the configuration.

Default to 1.0

Returns: sigma_f parameter of the configuration

◆ m_sigma_l()

Vector & lucid::Configuration::m_sigma_l ( )

inline

Get read-only access to the sigma_l parameter of the configuration.

Default to Vector::Constant(1

Returns: sigma_l parameter of the configuration

See also: 1.0)

◆ m_system_dynamics()

std::function< Matrix(Matrix)> & lucid::Configuration::m_system_dynamics ( )

inline

Get read-only access to the system_dynamics parameter of the configuration.

Default to nullptr

Returns: system_dynamics parameter of the configuration

◆ m_time_horizon()

int & lucid::Configuration::m_time_horizon ( )

inline

Get read-only access to the time_horizon parameter of the configuration.

Default to 5

Returns: time_horizon parameter of the configuration

◆ m_verbose()

int & lucid::Configuration::m_verbose ( )

inline

Get read-only access to the verbose parameter of the configuration.

Default to 3

Returns: verbose parameter of the configuration

◆ m_verify()

bool & lucid::Configuration::m_verify ( )

inline

Get read-only access to the verify parameter of the configuration.

Default to false

Returns: verify parameter of the configuration

◆ m_X_bounds()

std::unique_ptr< Set > & lucid::Configuration::m_X_bounds ( )

inline

Get read-only access to the X_bounds parameter of the configuration.

Default to nullptr

Returns: X_bounds parameter of the configuration

◆ m_X_init()

std::unique_ptr< Set > & lucid::Configuration::m_X_init ( )

inline

Get read-only access to the X_init parameter of the configuration.

Default to nullptr

Returns: X_init parameter of the configuration

◆ m_x_samples()

Matrix & lucid::Configuration::m_x_samples ( )

inline

Get read-only access to the x_samples parameter of the configuration.

Default to emptyMatrix

Returns: x_samples parameter of the configuration

◆ m_X_unsafe()

std::unique_ptr< Set > & lucid::Configuration::m_X_unsafe ( )

inline

Get read-only access to the X_unsafe parameter of the configuration.

Default to nullptr

Returns: X_unsafe parameter of the configuration

◆ m_xp_samples()

Matrix & lucid::Configuration::m_xp_samples ( )

inline

Get read-only access to the xp_samples parameter of the configuration.

Default to emptyMatrix

Returns: xp_samples parameter of the configuration

◆ noise_scale()

const double & lucid::Configuration::noise_scale ( ) const

inlinenodiscard

Get read-write access to the noise_scale parameter of the configuration.

Default to 0.01

Returns: noise_scale parameter of the configuration

◆ num_frequencies()

const int & lucid::Configuration::num_frequencies ( ) const

inlinenodiscard

Get read-write access to the num_frequencies parameter of the configuration.

Default to 10

Returns: num_frequencies parameter of the configuration

◆ num_samples()

const int & lucid::Configuration::num_samples ( ) const

inlinenodiscard

Get read-write access to the num_samples parameter of the configuration.

Default to 1000

Returns: num_samples parameter of the configuration

◆ optimiser()

const Optimiser & lucid::Configuration::optimiser ( ) const

inlinenodiscard

Get read-write access to the optimiser parameter of the configuration.

Default to Optimiser::GUROBI

Returns: optimiser parameter of the configuration

◆ oversample_factor()

const double & lucid::Configuration::oversample_factor ( ) const

inlinenodiscard

Get read-write access to the oversample_factor parameter of the configuration.

Default to 2.0

Returns: oversample_factor parameter of the configuration

◆ plot()

const bool & lucid::Configuration::plot ( ) const

inlinenodiscard

Get read-write access to the plot parameter of the configuration.

Default to false

Returns: plot parameter of the configuration

◆ problem_log_file()

const std::string & lucid::Configuration::problem_log_file ( ) const

inlinenodiscard

Get read-write access to the problem_log_file parameter of the configuration.

Default to ""

Returns: problem_log_file parameter of the configuration

◆ seed()

const int & lucid::Configuration::seed ( ) const

inlinenodiscard

Get read-write access to the seed parameter of the configuration.

Default to -1

Returns: seed parameter of the configuration

◆ sigma_f()

const double & lucid::Configuration::sigma_f ( ) const

inlinenodiscard

Get read-write access to the sigma_f parameter of the configuration.

Default to 1.0

Returns: sigma_f parameter of the configuration

◆ sigma_l()

const Vector & lucid::Configuration::sigma_l ( ) const

inlinenodiscard

Get read-write access to the sigma_l parameter of the configuration.

Default to Vector::Constant(1

Returns: sigma_l parameter of the configuration

See also: 1.0)

◆ system_dynamics()

const std::function< Matrix(Matrix)> & lucid::Configuration::system_dynamics ( ) const

inlinenodiscard

Get read-write access to the system_dynamics parameter of the configuration.

Default to nullptr

Returns: system_dynamics parameter of the configuration

◆ time_horizon()

const int & lucid::Configuration::time_horizon ( ) const

inlinenodiscard

Get read-write access to the time_horizon parameter of the configuration.

Default to 5

Returns: time_horizon parameter of the configuration

◆ verbose()

const int & lucid::Configuration::verbose ( ) const

inlinenodiscard

Get read-write access to the verbose parameter of the configuration.

Default to 3

Returns: verbose parameter of the configuration

◆ verify()

const bool & lucid::Configuration::verify ( ) const

inlinenodiscard

Get read-write access to the verify parameter of the configuration.

Default to false

Returns: verify parameter of the configuration

◆ X_bounds()

const std::unique_ptr< Set > & lucid::Configuration::X_bounds ( ) const

inlinenodiscard

Get read-write access to the X_bounds parameter of the configuration.

Default to nullptr

Returns: X_bounds parameter of the configuration

◆ X_init()

const std::unique_ptr< Set > & lucid::Configuration::X_init ( ) const

inlinenodiscard

Get read-write access to the X_init parameter of the configuration.

Default to nullptr

Returns: X_init parameter of the configuration

◆ x_samples()

const Matrix & lucid::Configuration::x_samples ( ) const

inlinenodiscard

Get read-write access to the x_samples parameter of the configuration.

Default to emptyMatrix

Returns: x_samples parameter of the configuration

◆ X_unsafe()

const std::unique_ptr< Set > & lucid::Configuration::X_unsafe ( ) const

inlinenodiscard

Get read-write access to the X_unsafe parameter of the configuration.

Default to nullptr

Returns: X_unsafe parameter of the configuration

◆ xp_samples()

const Matrix & lucid::Configuration::xp_samples ( ) const

inlinenodiscard

Get read-write access to the xp_samples parameter of the configuration.

Default to emptyMatrix

Returns: xp_samples parameter of the configuration

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

lucid/util/Configuration.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Estimator

◆ FeatureMap

◆ Kernel

◆ Optimiser

Member Function Documentation

◆ b_kappa()

◆ b_norm()

◆ C_coeff()

◆ epsilon()

◆ estimator()

◆ f_xp_samples()

◆ feature_map()

◆ gamma()

◆ iis_log_file()

◆ kernel()

◆ lambda()

◆ lattice_resolution()

◆ m_b_kappa()

◆ m_b_norm()

◆ m_C_coeff()

◆ m_epsilon()

◆ m_estimator()

◆ m_f_xp_samples()

◆ m_feature_map()

◆ m_gamma()

◆ m_iis_log_file()

◆ m_kernel()

◆ m_lambda()

◆ m_lattice_resolution()

◆ m_noise_scale()

◆ m_num_frequencies()

◆ m_num_samples()

◆ m_optimiser()

◆ m_oversample_factor()

◆ m_plot()

◆ m_problem_log_file()

◆ m_seed()

◆ m_sigma_f()

◆ m_sigma_l()

◆ m_system_dynamics()

◆ m_time_horizon()

◆ m_verbose()

◆ m_verify()

◆ m_X_bounds()

◆ m_X_init()

◆ m_x_samples()

◆ m_X_unsafe()

◆ m_xp_samples()

◆ noise_scale()

◆ num_frequencies()

◆ num_samples()

◆ optimiser()

◆ oversample_factor()

◆ plot()

◆ problem_log_file()

◆ seed()

◆ sigma_f()

◆ sigma_l()

◆ system_dynamics()

◆ time_horizon()

◆ verbose()

◆ verify()

◆ X_bounds()

◆ X_init()

◆ x_samples()

◆ X_unsafe()

◆ xp_samples()