Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123]

▼Nlucid	Root namespace for the lucid library
▼Nexception	Collection of exceptions that can be thrown by lucid
CLucidAssertionException	Exception for assertion failures
CLucidException	Base class for all exceptions in lucid
CLucidInvalidArgumentException	Exception for invalid arguments
CLucidLpSolverException	Exception in the LP solver
CLucidNotImplementedException	Exception for not yet implemented features
CLucidNotSupportedException	Exception for not supported features
CLucidOutOfRangeException	Exception for out of range errors
CLucidParserException	Exception for parser errors
CLucidPyException	Exception occurred in Python code
CLucidUnreachableException	Exception for unreachable code
▼Nplt	Lucid's matplotlib wrapper
CFillBetweenKwargs	Keyword arguments for fill_between
CPlotKwargs	Keyword arguments for the plot function
CPlotSurfaceKwargs	Keyword arguments for plot_surface
CPlotWireframeKwargs	Keyword arguments for plot_wireframe
CSaveKwargs	Keyword arguments for savefig
CScatterKwargs	Keyword arguments for scatter
CAlglibOptimiser	Linear optimiser using the Alglib mathematical library
CBarrierCertificate	Control barrier certificates (CBCs) are often used to certify the safety of a stochastic systems
CBaseScopedValue	Base class for creating a stack of scoped values of type T, identified by Tags
CConfiguration	Simple dataclass used to store the configuration of the program
CConstantTruncatedFourierFeatureMap	Truncated Fourier feature map using fixed intervals between each interval of the normal distribution
CCrossValidator	During cross-validation, the available data is split into k folds
CEllipseSet	Multidimensional ellipsoid set
CEstimator	Given two vector spaces, \( \texttip{\mathcal{X}}{Polish sample vector space} \subseteq \mathbb{R}^{d_x} \) and \( \texttip{\mathcal{Y}}{Polish sample vector space} \subseteq \mathbb{R}^{d_y} \), and a map \( f: \mathcal{X} \to \mathcal{Y} \), the Estimator's goal is to produce a model \( f^*:\mathcal{X} \to \mathcal{Y} \) that best approximates \( f \)
CFeatureMap	Map input vectors to a feature space
CFourierBarrierCertificate	Barrier certificate using a Fourier basis as a template for the function
CFourierBarrierCertificateParameters	Parameters for the Fourier barrier certificate synthesis using PSO
CFourierBarrierSynthesisProblem	LP problem to solver to achieve the Fourier barrier synthesis
CGaussianKernel	RKHS Gaussian kernel
CGradientOptimizable	Interface for objects that can be optimised using gradient-based methods (e.g., LbfgsTuner)
CGramMatrix	Gram Matrix obtained from a kernel function
CGridSearchTuner	Grid search tuning strategy for model hyperparameter optimisation
CGurobiOptimiser	Linear optimiser using the Gurobi solver
CHighsOptimiser	Linear optimiser using the HiGHS mathematical library
CIndexIterator	Iterator over all possible indexes in a given range
CInverseGramMatrix	The inverse of a Gram matrix, \( K^{-1} \), allowing transparent multiplication with vectors and matrices
CKernel	Represents a kernel function
CKernelRidgeRegressor	Ridge regressor with a kernel function
CKFold	Generic K-Fold cross-validation, where the dataset is divided into k folds
CLbfgsParameters	Structure copied from lbfgscpp, to avoid a transitive dependency on the external library in the header
CLbfgsTuner	Optimiser that uses the L-BFGS algorithm
CLeaveOneOut	Leave-One-Out cross-validation (LOOCV) is a specific type of cross-validation where the number of folds equals the number of data points in the dataset
CLinearTruncatedFourierFeatureMap	Truncated Fourier feature map using same-sized intervals between each interval of the normal distribution, from the origin to 3 standard deviations on each side
CLogTruncatedFourierFeatureMap	Truncated Fourier feature map using log-sized intervals between each interval of the normal distribution, from the origin to 3 standard deviations on each side
CMedianHeuristicTuner	Tuner that adjusts the kernel parameters using the median heuristic method
CModelEstimator	Dummy estimator that uses a user-defined function to make predictions
CMontecarloSimulation	Monte Carlo simulation for estimating the safety probability of a system
CMultiSet	Set composed of the union of multiple sets
COptimiser	Base class for optimisation solvers
CParameterValue	Parameter value used in a configurable system or application
CParameterValues	Collection of parameter values used in a configurable system or application
CParametrizable	Interface for objects that allow setting and getting parameters dynamically
CPolymorphicScopedValue	Generic scoped value class that can hold a value of type T, while interfacing with a base class B
CPolytopeSet	A convex polytope set in half-space representation
CRectSet	Rectangular set over an arbitrary number of dimensions
CScopedValueShield	A utility class that temporarily shields all current scoped values of type T and Tags
CSet	Generic set over a \( \texttip{d}{Dimension of the vector space} \) dimensional vector space \( \texttip{\mathcal{X}}{Polish sample vector space} \subseteq \mathbb{R}^d \)
CSoplexOptimiser	Linear optimiser using the SoPlex solver
CSphereSet	Multidimensional sphere set
CStats	Simple struct to hold various statistics about the execution of different components
CTensor	Lightweight tensor class
CTensorIterator	Utility class to iterate over all elements of a tensor
CTensorView	Lightweight wrapper that provides a view of a tensor
CTimer	Timer class using the steady clock (wall time)
CTimerBase	Simple timer class to evaluate the performance of the software
CTimerGuard	The TimeGuard wraps a timer object and pauses it when the guard object is destructed
CTruncatedFourierFeatureMap	Truncated Fourier feature map
CTuner	Optimise the kernel hyperparameters
Cuser_clock	Structure that will hold the user clock data
CUserTimer	Timer class using the user_clock (CPU user timer)
CValleePoussinKernel	Vallée-Poussin kernel