## On this page

  

 

 # ScalarMOP2 Class Reference

 Last update: 16.07.2025 

Represents a [ScalarMOP2](class_scalar_m_o_p2.xhtml "Represents a ScalarMOP2. "). [More...](class_scalar_m_o_p2.xhtml#details)

## <a name="pub-methods"></a>Public Member Functions

[Matrix](class_matrix.xhtml) [activeVariables](struct_scalar_m_o_p.xhtml#aeff7712c6be709d07b90e54d33c9a83b) (::data\_handler::DataHandlerBase datahandler, uint64\_t output) Return the the variable active for the selected output. [More...](#aeff7712c6be709d07b90e54d33c9a83b)  
 [Matrix](class_matrix.xhtml) [constantInputs](struct_scalar_m_o_p.xhtml#a0072c7edd32f9b19075446dad7edc9a3) (::data\_handler::DataHandlerBase datahandler) Return the the variables inactive for all outputs (the constant inputs) [More...](#a0072c7edd32f9b19075446dad7edc9a3)  
 [Matrix](class_matrix.xhtml) [copInputs](class_scalar_m_o_p2.xhtml#a0b81b6a4c59a313ee4a3726ef15198ff) () override [Matrix](class_matrix.xhtml) [copInputs](struct_scalar_m_o_p.xhtml#ade1a270ad8071b90c3c7f058e50c6fe4) (::data\_handler::DataHandlerBase datahandler) Compute the individual CoPs of second order for each input of given order for all outputs from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler. [More...](#ade1a270ad8071b90c3c7f058e50c6fe4)  
 [Matrix](class_matrix.xhtml) [copInputs](struct_scalar_m_o_p.xhtml#a8b244b702328986d0f27bf31422fc825) (::data\_handler::DataHandlerBase datahandler, uint64\_t output) Compute the individual CoPs of second order for each input of given order for a single output from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler. [More...](#a8b244b702328986d0f27bf31422fc825)  
 [Matrix](class_matrix.xhtml) [copInputsFirstOrder](struct_scalar_m_o_p.xhtml#a64b05f1ce4c1a6a54a1722e958f6b5a7) (::data\_handler::DataHandlerBase datahandler) Compute the individual CoPs of first order for each input of given order for all outputs from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler. [More...](#a64b05f1ce4c1a6a54a1722e958f6b5a7)  
 [Matrix](class_matrix.xhtml) [copInputsFirstOrder](struct_scalar_m_o_p.xhtml#af448d71b8e87e16c4834a9336b0b8cd4) (::data\_handler::DataHandlerBase datahandler, uint64\_t output) Compute the individual CoPs of given order for each input of given order for a single output from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler. [More...](#af448d71b8e87e16c4834a9336b0b8cd4)  
 [Matrix](class_matrix.xhtml) [copTotal](class_scalar_m_o_p2.xhtml#a9478ebe1f21c003b6a6713f9887404a9) () override [Matrix](class_matrix.xhtml) [copTotal](struct_scalar_m_o_p.xhtml#ad3cca8494b6fe38ce6e0ae0fc1ec0ea0) (::data\_handler::DataHandlerBase datahandler) Return the total [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the given datahandler. [More...](#ad3cca8494b6fe38ce6e0ae0fc1ec0ea0)  
 number [copTotal](struct_scalar_m_o_p.xhtml#a389cab7799d534fa23da5bdf9dadf5a7) (::data\_handler::DataHandlerBase datahandler, uint64\_t output) Return the total [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") of the given output the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler. [More...](#a389cab7799d534fa23da5bdf9dadf5a7)  
 [Matrix](class_matrix.xhtml) [crossValidation](struct_scalar_m_o_p.xhtml#a5ca8403b074f9c323bd0083fdf23cb1a) (::data\_handler::DataHandlerBase datahandler) Returns the cross validation values. [More...](#a5ca8403b074f9c323bd0083fdf23cb1a)  
 <a id="a4f1fd8a1bf196a0f3831ef80b03018bf"></a>[Matrix](class_matrix.xhtml) **crossValidation** (::data\_handler::DataHandlerBase datahandler, uint64\_t output) [Matrix](class_matrix.xhtml) [cvOutputs](class_scalar_m_o_p2.xhtml#a9e570d404efb87792edb8a69468b08ea) () override <a id="a79be2c06dfcee07bba626528d9bd9d05"></a>[Matrix](class_matrix.xhtml) **cvOutputs** (number output) [Matrix](class_matrix.xhtml) [evaluate](struct_scalar_m_o_p.xhtml#a98b1fc2fcda4a9254ddd2aa26af5c25d) (::data\_handler::DataHandlerBase datahandler, [Matrix](class_matrix.xhtml) values) Evaluate the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values with bounds check. [More...](#a98b1fc2fcda4a9254ddd2aa26af5c25d)  
 [Matrix](class_matrix.xhtml) [evaluate](struct_scalar_m_o_p.xhtml#a7f80257761b6720ce42d765f0c92e791) (::data\_handler::DataHandlerBase datahandler, [Matrix](class_matrix.xhtml) values, uint64\_t output) Evaluate the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values. Only evaluate the given output. With bounds check. [More...](#a7f80257761b6720ce42d765f0c92e791)  
 [Matrix](class_matrix.xhtml) [evaluate](class_scalar_m_o_p2.xhtml#ab8c54941abc35581947aca7a9eec4a67) ([Matrix](class_matrix.xhtml) x, bool extrapolate=false) override <a id="afcb19963ed87bc6e4f0392e0bdb8b1e4"></a>[Matrix](class_matrix.xhtml) **evaluate** ([Matrix](class_matrix.xhtml) x, uint64\_t output, bool extrapolate=false) override [Matrix](class_matrix.xhtml) [evaluateExtrapolate](struct_scalar_m_o_p.xhtml#a69f65698745dd36dadeb1699989f2bb2) (::data\_handler::DataHandlerBase datahandler, [Matrix](class_matrix.xhtml) values) Evaluate the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values no bounds check. [More...](#a69f65698745dd36dadeb1699989f2bb2)  
 [Matrix](class_matrix.xhtml) [evaluateExtrapolate](struct_scalar_m_o_p.xhtml#a2287b9e41a600402b5e7db0ca7108304) (::data\_handler::DataHandlerBase datahandler, [Matrix](class_matrix.xhtml) values, uint64\_t output) Evaluate the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values. Only evaluate the given output. No bounds check. [More...](#a2287b9e41a600402b5e7db0ca7108304)  
 <a id="a8b3ffc01e6b14aa676de1ff2e0b0f354"></a>[Matrix](class_matrix.xhtml) **evaluateExtrapolate** ([Matrix](class_matrix.xhtml) x) std::vector&lt; string &gt; [filterActiveSampleIds](struct_scalar_m_o_p.xhtml#a883e85901256157c66e0ecbd2ab7bcb0) (::data\_handler::DataHandlerBase datahandler, std::vector&lt; string &gt; sample\_ids, uint64\_t model) Return the the samples id active for the selected output from the given list of sample\_ids. [More...](#a883e85901256157c66e0ecbd2ab7bcb0)  
 std::vector&lt; string &gt; [filterConstantInputNames](struct_scalar_m_o_p.xhtml#a24f86122329b61107d3e1bf72d041a5f) (::data\_handler::DataHandlerBase datahandler, std::vector&lt; string &gt; input\_names) Filter the list of input names such that only the constant ones are returned The Input names need to be in the order as given on the training of the [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat..."). [More...](#a24f86122329b61107d3e1bf72d041a5f)  
 <a id="a3a167b2584a0f19b2c0bc459a5550427"></a>[Matrix](class_matrix.xhtml) **getFilter** () override <a id="a0f2711f719705ed032ae7d6d1777ba96"></a>[Matrix](class_matrix.xhtml) **getMean** () override [Matrix](class_matrix.xhtml) [getSensitivities](class_scalar_m_o_p2.xhtml#a7100ac1182593b63e0add2d1b5fd337d) () override <a id="a1c76104a8899ec67b919eb7a58464e35"></a>[Matrix](class_matrix.xhtml) **inputs** () bool [isValid](struct_scalar_m_o_p.xhtml#a54ae75757bd7c8c3936ab036df6d18e3) (::data\_handler::DataHandlerBase datahandler) checks the settings [More...](#a54ae75757bd7c8c3936ab036df6d18e3)  
 bool [isValid](class_scalar_m_o_p2.xhtml#aed2ba0e21a4f1861eb180b952c358c47) () override destructor [More...](#aed2ba0e21a4f1861eb180b952c358c47)  
 <a id="a17aa44b18ae334f8dcf88422a0c2a1ae"></a>[Matrix](class_matrix.xhtml) [lowerBounds](class_scalar_m_o_p2.xhtml#a17aa44b18ae334f8dcf88422a0c2a1ae) () override Returns a column vector of lower bound values of input parameters in DoE.   
 string [modelDescription](struct_scalar_m_o_p.xhtml#ad04e65da7a41baf081cbf4100367de57) (::data\_handler::DataHandlerBase datahandler, std::size\_t output) Return the description of the model computing the output for the SclarMOP in the datahandler. [More...](#ad04e65da7a41baf081cbf4100367de57)  
 string [modelName](struct_scalar_m_o_p.xhtml#a9ae8a26a8e856cb73692244eadaa54e0) (::data\_handler::DataHandlerBase datahandler, uint64\_t output) Return the name of the model computing the output for the SclarMOP in the datahandler. [More...](#a9ae8a26a8e856cb73692244eadaa54e0)  
 int [numInputs](class_scalar_m_o_p2.xhtml#af97b2d60070ccca6c53008bc806877e9) () override int [numOutputs](class_scalar_m_o_p2.xhtml#a333f4531815f086a341c25c9f96031d7) () override number [numSamples](class_scalar_m_o_p2.xhtml#a2c303f59c86c12698b207fc148f35354) () override <a id="acef46d597e2cba70bc3ea316d7f1ec60"></a>[Matrix](class_matrix.xhtml) **outputs** () [Matrix](class_matrix.xhtml) [predictionError](struct_scalar_m_o_p.xhtml#a8fc71ccbaa1350b7f88140bf7a6ded02) (::data\_handler::DataHandlerBase datahandler) Estimate the prediction error for [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values. [More...](#a8fc71ccbaa1350b7f88140bf7a6ded02)  
 number [predictionError](struct_scalar_m_o_p.xhtml#a356e1b51c7ff0f01849dbdd20b355238) (::data\_handler::DataHandlerBase datahandler, uint64\_t output) Estimate the prediction error for [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values for the given output. [More...](#a356e1b51c7ff0f01849dbdd20b355238)  
 [Matrix](class_matrix.xhtml) [qualityMeasureTotal](struct_scalar_m_o_p.xhtml#a5851787f9ce075375b9e0aa2934505ff) (::data\_handler::DataHandlerBase datahandler, ::quality\_measure::QualityMeasureBase quality\_measure) Return the total quality measure w.r.t. the expected responses from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the given datahandler. [More...](#a5851787f9ce075375b9e0aa2934505ff)  
 number [qualityMeasureTotal](struct_scalar_m_o_p.xhtml#acaa360031f26d42e06a8f7b63b19198a) (::data\_handler::DataHandlerBase datahandler, ::quality\_measure::QualityMeasureBase quality\_measure, uint64\_t output) Return the total quality measure w.r.t. the expected responses for the given output from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the given datahandler. [More...](#acaa360031f26d42e06a8f7b63b19198a)  
 [Matrix](class_matrix.xhtml) [sampleStatus](struct_scalar_m_o_p.xhtml#a9403b938a192208b16bd52cd1c5b5b42) (::data\_handler::DataHandlerBase datahandler) Return the the samples active/inactive for all models. [More...](#a9403b938a192208b16bd52cd1c5b5b42)  
 [Matrix](class_matrix.xhtml) [sampleStatus](struct_scalar_m_o_p.xhtml#a7b607b96e2ecb071ace9443a07dab932) (::data\_handler::DataHandlerBase datahandler, uint64\_t model) Return the the samples id active for the selected output from the given list of sample\_ids. [More...](#a7b607b96e2ecb071ace9443a07dab932)  
  [save](class_scalar_m_o_p2.xhtml#a218b0399e3457bfd38e19d93b931bf04) (string path, bool replace\_files=false) Saves the [ScalarMOP2](class_scalar_m_o_p2.xhtml "Represents a ScalarMOP2. ") to a file. [More...](#a218b0399e3457bfd38e19d93b931bf04)  
 <a id="af84f4ac3e10254b76293d2b577b4ecb4"></a> [ScalarMOP2](class_scalar_m_o_p2.xhtml#af84f4ac3e10254b76293d2b577b4ecb4) () default constructor. Creates an empty (unusable) [ScalarMOP2](class_scalar_m_o_p2.xhtml "Represents a ScalarMOP2. ") object.   
  [ScalarMOP2](class_scalar_m_o_p2.xhtml#acf4812bb4ced934b59d1b4637ddb7222) ([ScalarMOP2](class_scalar_m_o_p2.xhtml) other) copy constructor [More...](#acf4812bb4ced934b59d1b4637ddb7222)  
 <a id="a939cb7584e25886e7b2bfa8e63b3d83c"></a>[Matrix](class_matrix.xhtml) [upperBounds](class_scalar_m_o_p2.xhtml#a939cb7584e25886e7b2bfa8e63b3d83c) () override Returns a column vector of upper bound values of input parameters in DoE.   
  [writeOMDB](class_scalar_m_o_p2.xhtml#a9bcf490489c0ab8bd7c03ac56b73175d) (string path, bool replace\_files=false) Writes an optiSLang monitoring database file. [More...](#a9bcf490489c0ab8bd7c03ac56b73175d)  
 ## <a name="pub-static-methods"></a>Static Public Member Functions

static [ScalarMOP2](class_scalar_m_o_p2.xhtml) [load](class_scalar_m_o_p2.xhtml#a51ecdbc9e794da047bee35d361d1e94a) (string path) Loads the [ScalarMOP2](class_scalar_m_o_p2.xhtml "Represents a ScalarMOP2. ") from a file. [More...](#a51ecdbc9e794da047bee35d361d1e94a)  
 ## <a name="member-group"></a>Serialization

<a id="ac98d07dd8f7b70e16ccb9a01abf56b9c"></a>class **boost::serialization::access** bool [operator==](class_scalar_m_o_p2.xhtml#a941ef3bf9087203b5ec8fc93e8125e94) ([ScalarMOP2](class_scalar_m_o_p2.xhtml) other) [ScalarMOP2](class_scalar_m_o_p2.xhtml) [operator=](class_scalar_m_o_p2.xhtml#afb3b70a636532bae75ef199f06915a09) ([ScalarMOP2](class_scalar_m_o_p2.xhtml) other) overrides the default assignment operator [More...](#afb3b70a636532bae75ef199f06915a09)  
 <a id="details" name="details"></a>## Detailed Description

Represents a [ScalarMOP2](class_scalar_m_o_p2.xhtml "Represents a ScalarMOP2. ").

CopyrightDYNARDO Austria GmbHThe meta model is a mathematical function which approximates one or multiple output quantities from values of one or multiple input quantities.



## Constructor &amp; Destructor Documentation

<a id="acf4812bb4ced934b59d1b4637ddb7222"></a>## [◆ ](#acf4812bb4ced934b59d1b4637ddb7222)ScalarMOP2()

 [ScalarMOP2](class_scalar_m_o_p2.xhtml)  ( [ScalarMOP2](class_scalar_m_o_p2.xhtml)  *other*) 

copy constructor

Parameters otherthe [ScalarMOP2](class_scalar_m_o_p2.xhtml "Represents a ScalarMOP2. ") object to be copied from 



## Member Function Documentation

<a id="aeff7712c6be709d07b90e54d33c9a83b"></a>## [◆ ](#aeff7712c6be709d07b90e54d33c9a83b)activeVariables()

 [Matrix](class_matrix.xhtml) activeVariables  ( ::data\_handler::DataHandlerBase  *datahandler*,    uint64\_t  *output*   )   inherited 

Return the the variable active for the selected output.

Parameters datahandlerThe database to take the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") from outputThe selected output ReturnsA vector of bools specifying for each input if it is active 



<a id="a0072c7edd32f9b19075446dad7edc9a3"></a>## [◆ ](#a0072c7edd32f9b19075446dad7edc9a3)constantInputs()

 [Matrix](class_matrix.xhtml) constantInputs  ( ::data\_handler::DataHandlerBase  *datahandler*)   inherited 

Return the the variables inactive for all outputs (the constant inputs)

Parameters datahandlerThe database to take the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") from ReturnsA vector of bools specifying for each input if it is constant 



<a id="a0b81b6a4c59a313ee4a3726ef15198ff"></a>## [◆ ](#a0b81b6a4c59a313ee4a3726ef15198ff)copInputs() \[1/3\]

 [Matrix](class_matrix.xhtml) copInputs  ( )   override 

Returnsthe individual [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") values of each input for each output The [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") matrix is organized as follows:- each column corresponds to one design variable
- each row corresponds to one output variable





<a id="ade1a270ad8071b90c3c7f058e50c6fe4"></a>## [◆ ](#ade1a270ad8071b90c3c7f058e50c6fe4)copInputs() \[2/3\]

 [Matrix](class_matrix.xhtml) copInputs  ( ::data\_handler::DataHandlerBase  *datahandler*)   inherited 

Compute the individual CoPs of second order for each input of given order for all outputs from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler.

Parameters datahandlerThe datahandler Returnsthe individual [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") values of each input for each output The [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") matrix is organized as follows:- each column corresponds to one design variable
- each row corresponds to one output variable





<a id="a8b244b702328986d0f27bf31422fc825"></a>## [◆ ](#a8b244b702328986d0f27bf31422fc825)copInputs() \[3/3\]

 [Matrix](class_matrix.xhtml) copInputs  ( ::data\_handler::DataHandlerBase  *datahandler*,    uint64\_t  *output*   )   inherited 

Compute the individual CoPs of second order for each input of given order for a single output from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler.

Parameters datahandlerThe datahandler outputThe output to compute for Returnsthe individual [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") values of each input for a single output output The [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") matrix is organized as follows:- each column corresponds to one design variable
- each row corresponds to one output variable





<a id="a64b05f1ce4c1a6a54a1722e958f6b5a7"></a>## [◆ ](#a64b05f1ce4c1a6a54a1722e958f6b5a7)copInputsFirstOrder() \[1/2\]

 [Matrix](class_matrix.xhtml) copInputsFirstOrder  ( ::data\_handler::DataHandlerBase  *datahandler*)   inherited 

Compute the individual CoPs of first order for each input of given order for all outputs from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler.

Parameters datahandlerThe datahandler Returnsthe individual [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") values of each input for each output The [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") matrix is organized as follows:- each column corresponds to one design variable
- each row corresponds to one output variable





<a id="af448d71b8e87e16c4834a9336b0b8cd4"></a>## [◆ ](#af448d71b8e87e16c4834a9336b0b8cd4)copInputsFirstOrder() \[2/2\]

 [Matrix](class_matrix.xhtml) copInputsFirstOrder  ( ::data\_handler::DataHandlerBase  *datahandler*,    uint64\_t  *output*   )   inherited 

Compute the individual CoPs of given order for each input of given order for a single output from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler.

Parameters datahandlerThe datahandler outputThe output to compute for Returnsthe individual [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") values of each input for a single output output The [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") matrix is organized as follows:- each column corresponds to one design variable
- each row corresponds to one output variable





<a id="a9478ebe1f21c003b6a6713f9887404a9"></a>## [◆ ](#a9478ebe1f21c003b6a6713f9887404a9)copTotal() \[1/3\]

 [Matrix](class_matrix.xhtml) copTotal  ( )   override 

Returnsa column vector which contains the total [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") for each output variable 



<a id="ad3cca8494b6fe38ce6e0ae0fc1ec0ea0"></a>## [◆ ](#ad3cca8494b6fe38ce6e0ae0fc1ec0ea0)copTotal() \[2/3\]

 [Matrix](class_matrix.xhtml) copTotal  ( ::data\_handler::DataHandlerBase  *datahandler*)   inherited 

Return the total [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the given datahandler.

Parameters datahandlerThe datahandler ReturnsThe total [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") of all outputs 



<a id="a389cab7799d534fa23da5bdf9dadf5a7"></a>## [◆ ](#a389cab7799d534fa23da5bdf9dadf5a7)copTotal() \[3/3\]

 number copTotal  ( ::data\_handler::DataHandlerBase  *datahandler*,    uint64\_t  *output*   )   inherited 

Return the total [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") of the given output the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler.

Parameters datahandlerThe datahandler outputThe output to compute the [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") for ReturnsThe total [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") of given output 



<a id="a5ca8403b074f9c323bd0083fdf23cb1a"></a>## [◆ ](#a5ca8403b074f9c323bd0083fdf23cb1a)crossValidation()

 [Matrix](class_matrix.xhtml) crossValidation  ( ::data\_handler::DataHandlerBase  *datahandler*)   inherited 

Returns the cross validation values.

Parameters datahandlerThe datahandler containing the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") Returnscross validation data from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") 



<a id="a9e570d404efb87792edb8a69468b08ea"></a>## [◆ ](#a9e570d404efb87792edb8a69468b08ea)cvOutputs()

 [Matrix](class_matrix.xhtml) cvOutputs  ( )   override 

Returnsa matrix which contains the cross-validated values for each output variable 



<a id="a98b1fc2fcda4a9254ddd2aa26af5c25d"></a>## [◆ ](#a98b1fc2fcda4a9254ddd2aa26af5c25d)evaluate() \[1/3\]

 [Matrix](class_matrix.xhtml) evaluate  ( ::data\_handler::DataHandlerBase  *datahandler*,    [Matrix](class_matrix.xhtml)  *values*   )   inherited 

Evaluate the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values with bounds check.

Parameters datahandlerThe datahandler containing the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") valuesThe values to evaluate the scalarMOP on ReturnsValues approximated by the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") 



<a id="a7f80257761b6720ce42d765f0c92e791"></a>## [◆ ](#a7f80257761b6720ce42d765f0c92e791)evaluate() \[2/3\]

 [Matrix](class_matrix.xhtml) evaluate  ( ::data\_handler::DataHandlerBase  *datahandler*,    [Matrix](class_matrix.xhtml)  *values*,    uint64\_t  *output*   )   inherited 

Evaluate the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values. Only evaluate the given output. With bounds check.

Parameters datahandlerThe datahandler containing the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") valuesThe values to evaluate the scalarMOP on outputThe output to evaluate ReturnsValues approximated by the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") 



<a id="ab8c54941abc35581947aca7a9eec4a67"></a>## [◆ ](#ab8c54941abc35581947aca7a9eec4a67)evaluate() \[3/3\]

 [Matrix](class_matrix.xhtml) evaluate  ( [Matrix](class_matrix.xhtml)  *x*,    bool  *extrapolate* = `false`   )   override 

Parameters xthe inputs to be evaluated. Each column is one set of inputs, e.g. each column represents a single design, e.g. numRows = numInputs; The input values must be be within the original sampling bounds! extrapolateExtrapolate values outside the sample boundaries Returnsmatrix of output variable values as approximated by the meta model; each column represents a single design, e.g. numRows = numOutputs; numCols = x.numCols() 



<a id="a69f65698745dd36dadeb1699989f2bb2"></a>## [◆ ](#a69f65698745dd36dadeb1699989f2bb2)evaluateExtrapolate() \[1/2\]

 [Matrix](class_matrix.xhtml) evaluateExtrapolate  ( ::data\_handler::DataHandlerBase  *datahandler*,    [Matrix](class_matrix.xhtml)  *values*   )   inherited 

Evaluate the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values no bounds check.

Parameters datahandlerThe datahandler containing the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") valuesThe values to evaluate the scalarMOP on ReturnsValues approximated by the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") 



<a id="a2287b9e41a600402b5e7db0ca7108304"></a>## [◆ ](#a2287b9e41a600402b5e7db0ca7108304)evaluateExtrapolate() \[2/2\]

 [Matrix](class_matrix.xhtml) evaluateExtrapolate  ( ::data\_handler::DataHandlerBase  *datahandler*,    [Matrix](class_matrix.xhtml)  *values*,    uint64\_t  *output*   )   inherited 

Evaluate the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values. Only evaluate the given output. No bounds check.

Parameters datahandlerThe datahandler containing the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") valuesThe values to evaluate the scalarMOP on outputThe output to evaluate ReturnsValues approximated by the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") 



<a id="a883e85901256157c66e0ecbd2ab7bcb0"></a>## [◆ ](#a883e85901256157c66e0ecbd2ab7bcb0)filterActiveSampleIds()

 std::vector&lt;string&gt; filterActiveSampleIds  ( ::data\_handler::DataHandlerBase  *datahandler*,    std::vector&lt; string &gt;  *sample\_ids*,    uint64\_t  *model*   )   inherited 

Return the the samples id active for the selected output from the given list of sample\_ids.

Parameters datahandlerThe database to take the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") from sample\_idsA list of sample ids corresponding to the used samples modelThe selected model ReturnsA vector of strings representing the ids of the active samples 



<a id="a24f86122329b61107d3e1bf72d041a5f"></a>## [◆ ](#a24f86122329b61107d3e1bf72d041a5f)filterConstantInputNames()

 std::vector&lt;string&gt; filterConstantInputNames  ( ::data\_handler::DataHandlerBase  *datahandler*,    std::vector&lt; string &gt;  *input\_names*   )   inherited 

Filter the list of input names such that only the constant ones are returned The Input names need to be in the order as given on the training of the [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...").

Parameters datahandlerThe database to take the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") from input\_namesThe names of the inputs in the order of the training ReturnsA list of input names representing the constant inputs 



<a id="a7100ac1182593b63e0add2d1b5fd337d"></a>## [◆ ](#a7100ac1182593b63e0add2d1b5fd337d)getSensitivities()

 [Matrix](class_matrix.xhtml) getSensitivities  ( )   override 

Returnsthe individual [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") values of each input for each output The sensitivities matrix is organized as follows:- The first column contains the total [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") for each output variable
- The other columns contain the [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") matrix organized as follows:
    - each column corresponds to one design variable
    - each row corresponds to one output variable





<a id="a54ae75757bd7c8c3936ab036df6d18e3"></a>## [◆ ](#a54ae75757bd7c8c3936ab036df6d18e3)isValid() \[1/2\]

 bool isValid  ( ::data\_handler::DataHandlerBase  *datahandler*)   inherited 

checks the settings

Parameters datahandlerThe datahandler we refer to Returnstrue iff the datahandler may be accessed 



<a id="aed2ba0e21a4f1861eb180b952c358c47"></a>## [◆ ](#aed2ba0e21a4f1861eb180b952c358c47)isValid() \[2/2\]

 bool isValid  ( )   override 

destructor

returns true if the [ScalarMOP2](class_scalar_m_o_p2.xhtml "Represents a ScalarMOP2. ") is valid





<a id="a51ecdbc9e794da047bee35d361d1e94a"></a>## [◆ ](#a51ecdbc9e794da047bee35d361d1e94a)load()

 static [ScalarMOP2](class_scalar_m_o_p2.xhtml) load  ( string  *path*)   static 

Loads the [ScalarMOP2](class_scalar_m_o_p2.xhtml "Represents a ScalarMOP2. ") from a file.

Parameters pathThe path to read the file from 



<a id="ad04e65da7a41baf081cbf4100367de57"></a>## [◆ ](#ad04e65da7a41baf081cbf4100367de57)modelDescription()

 string modelDescription  ( ::data\_handler::DataHandlerBase  *datahandler*,    std::size\_t  *output*   )   inherited 

Return the description of the model computing the output for the SclarMOP in the datahandler.

Parameters datahandlerThe datahandler outputThe output under consideration ReturnsA string containing the description of the model 



<a id="a9ae8a26a8e856cb73692244eadaa54e0"></a>## [◆ ](#a9ae8a26a8e856cb73692244eadaa54e0)modelName()

 string modelName  ( ::data\_handler::DataHandlerBase  *datahandler*,    uint64\_t  *output*   )   inherited 

Return the name of the model computing the output for the SclarMOP in the datahandler.

Parameters datahandlerThe datahandler outputThe output under consideration ReturnsA string containing the name of the model 



<a id="af97b2d60070ccca6c53008bc806877e9"></a>## [◆ ](#af97b2d60070ccca6c53008bc806877e9)numInputs()

 int numInputs  ( )   override 

Returnsthe number of input variables 



<a id="a333f4531815f086a341c25c9f96031d7"></a>## [◆ ](#a333f4531815f086a341c25c9f96031d7)numOutputs()

 int numOutputs  ( )   override 

Returnsthe number of output variables 



<a id="a2c303f59c86c12698b207fc148f35354"></a>## [◆ ](#a2c303f59c86c12698b207fc148f35354)numSamples()

 number numSamples  ( )   override 

Returnsnumber of samples used to establish [ScalarMOP2](class_scalar_m_o_p2.xhtml "Represents a ScalarMOP2. ") 



<a id="afb3b70a636532bae75ef199f06915a09"></a>## [◆ ](#afb3b70a636532bae75ef199f06915a09)operator=()

 [ScalarMOP2](class_scalar_m_o_p2.xhtml) operator=  ( [ScalarMOP2](class_scalar_m_o_p2.xhtml)  *other*) 

overrides the default assignment operator

Parameters otherthe source object Returnsa reference to this object 



<a id="a941ef3bf9087203b5ec8fc93e8125e94"></a>## [◆ ](#a941ef3bf9087203b5ec8fc93e8125e94)operator==()

 bool operator==  ( [ScalarMOP2](class_scalar_m_o_p2.xhtml)  *other*) 

Parameters otherthe other object to be compared with Returnstrue if both objects contain the same content 



<a id="a8fc71ccbaa1350b7f88140bf7a6ded02"></a>## [◆ ](#a8fc71ccbaa1350b7f88140bf7a6ded02)predictionError() \[1/2\]

 [Matrix](class_matrix.xhtml) predictionError  ( ::data\_handler::DataHandlerBase  *datahandler*)   inherited 

Estimate the prediction error for [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values.

Parameters datahandlerThe datahandler containing the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") ReturnsThe prediction error 



<a id="a356e1b51c7ff0f01849dbdd20b355238"></a>## [◆ ](#a356e1b51c7ff0f01849dbdd20b355238)predictionError() \[2/2\]

 number predictionError  ( ::data\_handler::DataHandlerBase  *datahandler*,    uint64\_t  *output*   )   inherited 

Estimate the prediction error for [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the datahandler on the given values for the given output.

Parameters datahandlerThe datahandler containing the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") outputThe selected output ReturnsValues approximated by the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") 



<a id="a5851787f9ce075375b9e0aa2934505ff"></a>## [◆ ](#a5851787f9ce075375b9e0aa2934505ff)qualityMeasureTotal() \[1/2\]

 [Matrix](class_matrix.xhtml) qualityMeasureTotal  ( ::data\_handler::DataHandlerBase  *datahandler*,    ::quality\_measure::QualityMeasureBase  *quality\_measure*   )   inherited 

Return the total quality measure w.r.t. the expected responses from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the given datahandler.

Parameters datahandlerThe datahandler quality\_measureThe quality measure ReturnsThe total quality measure of all outputs w.r.t. the expected responses 



<a id="acaa360031f26d42e06a8f7b63b19198a"></a>## [◆ ](#acaa360031f26d42e06a8f7b63b19198a)qualityMeasureTotal() \[2/2\]

 number qualityMeasureTotal  ( ::data\_handler::DataHandlerBase  *datahandler*,    ::quality\_measure::QualityMeasureBase  *quality\_measure*,    uint64\_t  *output*   )   inherited 

Return the total quality measure w.r.t. the expected responses for the given output from the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") in the given datahandler.

Parameters datahandlerThe datahandler quality\_measureThe quality measure outputThe output to compute for ReturnsThe total quality measure of all outputs w.r.t. the expected responses 



<a id="a9403b938a192208b16bd52cd1c5b5b42"></a>## [◆ ](#a9403b938a192208b16bd52cd1c5b5b42)sampleStatus() \[1/2\]

 [Matrix](class_matrix.xhtml) sampleStatus  ( ::data\_handler::DataHandlerBase  *datahandler*)   inherited 

Return the the samples active/inactive for all models.

Parameters datahandlerThe database to take the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") from ReturnsA matrix of bools specifying for each sample/model if it is active/inactive 



<a id="a7b607b96e2ecb071ace9443a07dab932"></a>## [◆ ](#a7b607b96e2ecb071ace9443a07dab932)sampleStatus() \[2/2\]

 [Matrix](class_matrix.xhtml) sampleStatus  ( ::data\_handler::DataHandlerBase  *datahandler*,    uint64\_t  *model*   )   inherited 

Return the the samples id active for the selected output from the given list of sample\_ids.

Parameters datahandlerThe database to take the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") from modelThe selected model ReturnsA vector of bools specifying for each samples if it is active/inactive for the model 



<a id="a218b0399e3457bfd38e19d93b931bf04"></a>## [◆ ](#a218b0399e3457bfd38e19d93b931bf04)save()

 save  ( string  *path*,    bool  *replace\_files* = `false`   ) 

Saves the [ScalarMOP2](class_scalar_m_o_p2.xhtml "Represents a ScalarMOP2. ") to a file.

Parameters pathThe path to write the file to replace\_filesif true, then an already existin gfile will be replaced 



<a id="a9bcf490489c0ab8bd7c03ac56b73175d"></a>## [◆ ](#a9bcf490489c0ab8bd7c03ac56b73175d)writeOMDB()

 writeOMDB  ( string  *path*,    bool  *replace\_files* = `false`   ) 

Writes an optiSLang monitoring database file.

Parameters pathThe path to write the file to replace\_filesif true, then an already existin gfile will be replaced