ComputeCoefficientOfDetermination< TYPE > Class Template Reference
Last update: 16.07.2025a struct which collects settings for computing the Coefficient Of Determination More...
Public Member Functions | |
| check (Structure database) | |
| checks the settings on plausibility It throws an exception if there is a problem with the settings. Important: It tries to find out all problems with these settings and then exits the routine. More... | |
| compute (Structure database) | |
| computes the coefficient of determination of multiple sets of samples with another set of scalar samples If the selected designs for two correlated quantities are different, then the minimum common range of designs is detected and used for analysis. More... | |
| ComputeCoefficientOfDetermination (DataObjectContainer the_field_data, DataObjectContainer the_scalar_data) | |
| constructor which sets suitable defaults for all members More... | |
Public Attributes | |
| bool | adjusted |
| is true if the C.o.D. is "adjusted" (default) | |
| DataObjectContainer | field_data |
| field samples | |
| DataObjectContainer::string_vector_type | field_quantity_idents |
| the feld quantities to be analyzed. If a quantity ident does not exist in field_data, no error appears. The CoD is computed for each of these quantities. | |
| DataObjectContainer::string_vector_type | new_design_idents |
| the new design idents for each CoefficientOfDetermination object. The dimension and index space must fit the one of field_quantity_idents | |
| DataObjectContainer::string_vector_type | new_quantity_idents |
| the new quantity idents for each CoefficientOfDetermination object. The dimension and index space must fit the one of field_quantity_idents | |
| bool | overwrite_existing |
| is true if already existing output data objects will be replaced. In this case, also all depending objects of the already existing one will be deleted. | |
| DataObjectContainer | scalar_data |
| scalar samples | |
| DataObjectContainer::string_vector_type | scalar_quantity_idents |
| the scalar quantities to be analyzed. If a quantity ident does not exist in scalar_data, no error appears. For each field data quantity, a regression model is created. In this regression model, the support points are determined by taking ALL given scalar quantities. | |
Detailed Description
template<dataobject_types TYPE>
class ComputeCoefficientOfDetermination< TYPE >
a struct which collects settings for computing the Coefficient Of Determination
- Template Parameters
-
TYPE the field data type
Constructor & Destructor Documentation
◆ ComputeCoefficientOfDetermination()
| ComputeCoefficientOfDetermination | ( | DataObjectContainer | the_field_data, |
| DataObjectContainer | the_scalar_data | ||
| ) |
constructor which sets suitable defaults for all members
- Parameters
-
the_field_data the subset of field data to be token as input. the_scalar_data the subset of scalar data to be token as input. All quantity idents are extracted. Then for each of the n field quantities one creates a single regression model from what the C.o.D. can be comouted. The regression model contains the specified scalar quantities. (n*1 new objects will be computed). As a default, the new C.o.D. field objects are appended to the field data quantities as individual designs. The design name is "cod[scalar_quantity_ident]". If multiple scalar quantities are selected, then the default ident is "cod[multiple]".
Member Function Documentation
◆ check()
| check | ( | Structure | database | ) |
checks the settings on plausibility It throws an exception if there is a problem with the settings. Important: It tries to find out all problems with these settings and then exits the routine.
- Parameters
-
database the SoS structure
◆ compute()
| compute | ( | Structure | database | ) |
computes the coefficient of determination of multiple sets of samples with another set of scalar samples If the selected designs for two correlated quantities are different, then the minimum common range of designs is detected and used for analysis.
- Parameters
-
database the output object where new objects are added to
