Residuals Class Reference
Last update: 16.07.2025The estimator class creates an abstraction for classes the QualityMeasure may be evaluated for in the MOP framework. It abstracts the essential data necessary in an quality measurement which can be done based on Three information: Approximation: This is data estimated using any approximation type CrossValidation: This is data that is estimated explicitly using cross-validation sets generated by the MOP handler AdjustmentCoefficient: This is a value in the range 1,...,N where N is the number of samples provided to the Estimator. More...
Public Member Functions | |
| virtual string | __getstate__ () |
| Serialization helpers for Python. This function allows the serialization of the REsiduals from inside Python. It can be used to serialize the residuals to store with custom model implementation. More... | |
| virtual | __setstate_internal (string state) |
| De-serialization helper fro python. This function gets called from a python function defined in the SWIG-Layer that provides de-serialization capabilities for the state encoded as a string. It finalizes setting an instances state from the given string. More... | |
| virtual uint64_t | adjustmentCoefficient () override |
| A function returning the AdjustmentCoefficient when called. | |
| virtual uint64_t | adjustmentCoefficientRef () override |
| A function returning the AdjustmentCoefficient when called. | |
| virtual Matrix | approximationValues () override |
| Destructor. More... | |
| virtual Matrix | approximationValuesRef () override |
| A function returning the Approximation data when called. | |
| virtual Matrix | crossValidationValues () override |
| A function return the CrossValidation data when called. | |
| virtual Matrix | crossValidationValuesRef () override |
| A function return the CrossValidation data when called. | |
| Residuals | operator= (Residuals other) |
| Copy-Assignment. | |
| virtual Matrix | originalValues () |
| A function return the original data when called. | |
| virtual Matrix | originalValuesRef () |
| A function return the original data when called. | |
| Residuals () | |
| Constructor. | |
| Residuals (Matrix approx_values, Matrix cv_values, Matrix original_values, uint64_t adj_coeff) | |
| Constructor that initializes the Residuals with its data. More... | |
| Residuals (Residuals other) | |
| Copy-Constructor. | |
| template<class Archive > | |
| serialize (Archive ar, number) | |
| serializes this object, see boost::serialization More... | |
Friends | |
| class | boost::serialization::access |
Detailed Description
The estimator class creates an abstraction for classes the QualityMeasure may be evaluated for in the MOP framework. It abstracts the essential data necessary in an quality measurement which can be done based on Three information: Approximation: This is data estimated using any approximation type CrossValidation: This is data that is estimated explicitly using cross-validation sets generated by the MOP handler AdjustmentCoefficient: This is a value in the range 1,...,N where N is the number of samples provided to the Estimator.
Constructor & Destructor Documentation
◆ Residuals()
Constructor that initializes the Residuals with its data.
- Parameters
-
approx_values The approximation values for the given input points Can be identical to the cv_values cv_values The cross-validation values on the input points. These are expected to be computed on base of the MOPs selection of a segmentation of the input values. This selection needs to be consistent for all models in a competition. original_values The values used originally dduring the training. adj_coeff The adjustment coefficient.
Member Function Documentation
◆ __getstate__()
|
virtual |
Serialization helpers for Python. This function allows the serialization of the REsiduals from inside Python. It can be used to serialize the residuals to store with custom model implementation.
- Returns
- The Residuals state as a string
◆ __setstate_internal()
|
virtual |
De-serialization helper fro python. This function gets called from a python function defined in the SWIG-Layer that provides de-serialization capabilities for the state encoded as a string. It finalizes setting an instances state from the given string.
- Parameters
-
state The residuals state encoded as string
◆ approximationValues()
|
overridevirtual |
◆ serialize()
| serialize | ( | Archive | ar, |
| number | |||
| ) |
serializes this object, see boost::serialization
- Parameters
-
ar the boost archive version the version number
