## On this page

  

 

 # TrainingPlanBase Struct Reference

 Last update: 16.07.2025 

TrainingPlan assigns a in a set of sample each sample a status on how the sample is to be treated during the training of a model. [More...](struct_training_plan_base.xhtml#details)

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

virtual std::vector&lt; string &gt; [getInputNames](struct_training_plan_base.xhtml#a15234ce024e1b13e596ff9c38df3be71) (::data\_handler::DataHandlerBase datahandler)=0 Returns the input names from the datahandler. [More...](#a15234ce024e1b13e596ff9c38df3be71)  
 virtual [Matrix](class_matrix.xhtml) [getInputs](struct_training_plan_base.xhtml#a6e262334d7e27b9f05121454531fa5b6) (::data\_handler::DataHandlerBase datahandler)=0 Returns the inputs fitting the training plan from the datahandler. [More...](#a6e262334d7e27b9f05121454531fa5b6)  
 virtual string [getMOPIdent](struct_training_plan_base.xhtml#a5df8016765ccb017b2ff5778e3e81558) ()=0 Returns the [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...") ident the TrainingPlan is created for. [More...](#a5df8016765ccb017b2ff5778e3e81558)  
 virtual std::vector&lt; string &gt; [getOutputNames](struct_training_plan_base.xhtml#a32c9c6dc56f9b1b5ad2aa3e686d172c7) (::data\_handler::DataHandlerBase datahandler)=0 Returns the output names from the datahandler. [More...](#a32c9c6dc56f9b1b5ad2aa3e686d172c7)  
 virtual [Matrix](class_matrix.xhtml) [getOutputs](struct_training_plan_base.xhtml#a8de106670ace9e349ee9c149741b8e44) (::data\_handler::DataHandlerBase datahandler)=0 Returns the outputs fitting the training plan from the datahandler. [More...](#a8de106670ace9e349ee9c149741b8e44)  
 virtual [SampleUsage](group__training__plan.xhtml#gafce529ac7282fd94c419e8bea8492268) [getSampleUsageInSet](struct_training_plan_base.xhtml#a1c4be324fc1e91c3039a49631f6e2cc9) (uint64\_t i, uint64\_t j)=0 getSampleUsageInSet accessor of the j-th sample in the i-th training set [More...](#a1c4be324fc1e91c3039a49631f6e2cc9)  
 virtual [SampleUsage](group__training__plan.xhtml#gafce529ac7282fd94c419e8bea8492268) [getSampleUsageInSetRef](struct_training_plan_base.xhtml#af67b70402c8a7610ce4a99c252f53681) (uint64\_t i, uint64\_t j)=0 getSampleUsageInSetRef non- accessor of the j-th sample in the i-th training set [More...](#af67b70402c8a7610ce4a99c252f53681)  
 virtual [ParameterImportance](group__common.xhtml#gad5ca470fd07552bf1da82219827c4ec0) [inputImportance](struct_training_plan_base.xhtml#ab9acd4287a8208fa9a32867cafaf8e46) (uint64\_t i)=0 parameter returns the ParameterImportance for the i-th parameter [More...](#ab9acd4287a8208fa9a32867cafaf8e46)  
 virtual [ParameterImportance](group__common.xhtml#gad5ca470fd07552bf1da82219827c4ec0) [inputImportanceInSubspace](struct_training_plan_base.xhtml#a60399ab71c2fcf3a21c9a613997c4822) (uint64\_t i, uint64\_t j, uint64\_t o)=0 inputImportanceInSubspace returns true if the input j is in the subspace i. [More...](#a60399ab71c2fcf3a21c9a613997c4822)  
 virtual bool [isValid](struct_training_plan_base.xhtml#aed20b1ee85452a87a9e10f39077b94a3) (::data\_handler::DataHandlerBase)=0 Checks if the training plan is valid for the give datahandler. [More...](#aed20b1ee85452a87a9e10f39077b94a3)  
 virtual uint64\_t [numInputs](struct_training_plan_base.xhtml#a5c973e14b896504b0522fc953bb3b2dc) ()=0 numInputs returns the number of inputs used and defined in this training plan [More...](#a5c973e14b896504b0522fc953bb3b2dc)  
 virtual uint64\_t [numOutputs](struct_training_plan_base.xhtml#aad28bd2bb818cf6c433e22e22768086c) ()=0 numOutputs returns the number of outputs used in this training plan [More...](#aad28bd2bb818cf6c433e22e22768086c)  
 virtual uint64\_t [numSamplesInSet](struct_training_plan_base.xhtml#a0ef7e16a9a52c22ecb59f6148accae62) (uint64\_t i)=0 numSamplesInSet returns the number of elements (samples) in the training set [More...](#a0ef7e16a9a52c22ecb59f6148accae62)  
 virtual uint64\_t [numSets](struct_training_plan_base.xhtml#ad536b0ba37fa27e95a51c0aa3afc96da) ()=0 numSets returns the number of training sets in the training plan [More...](#ad536b0ba37fa27e95a51c0aa3afc96da)  
 virtual uint64\_t [numSubspaces](struct_training_plan_base.xhtml#a44682836a8190246e4db84f997a003cc) (uint64\_t o)=0 numSubspaces returns the number of filtered subspaces available in the Training Plan to the i-th output in the output matrix [More...](#a44682836a8190246e4db84f997a003cc)  
 virtual uint64\_t [numTestSamplesInSet](struct_training_plan_base.xhtml#a88109fe981a2b192eb8e09a87ae563ed) (uint64\_t i)=0 numTestSamplesInSet returns the number of elements (samples) in the training set that are labeled SampleUsage::Test [More...](#a88109fe981a2b192eb8e09a87ae563ed)  
 virtual uint64\_t [numTrainingSamplesInSet](struct_training_plan_base.xhtml#a13261fec66c7bbac8c07123619300275) (uint64\_t i)=0 numTrainingSamplesInSet returns the number of elements (samples) in the training set that are labeled SampleUsage::Training [More...](#a13261fec66c7bbac8c07123619300275)  
 virtual uint64\_t [output](struct_training_plan_base.xhtml#a3e0dff9e7373d9800e8abe6a61af4c16) (uint64\_t i)=0 parameter returns the index of the i-th output in the output matrix [More...](#a3e0dff9e7373d9800e8abe6a61af4c16)  
 <a id="details" name="details"></a>## Detailed Description

TrainingPlan assigns a in a set of sample each sample a status on how the sample is to be treated during the training of a model.



## Member Function Documentation

<a id="a15234ce024e1b13e596ff9c38df3be71"></a>## [◆ ](#a15234ce024e1b13e596ff9c38df3be71)getInputNames()

 virtual std::vector&lt;string&gt; getInputNames  ( ::data\_handler::DataHandlerBase  *datahandler*)   pure virtual 

Returns the input names from the datahandler.

Parameters datahandlerThe datahandler to get the data from ReturnsThe input data names Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a4f95e721a51d6482217b85546b69b3f9).





<a id="a6e262334d7e27b9f05121454531fa5b6"></a>## [◆ ](#a6e262334d7e27b9f05121454531fa5b6)getInputs()

 virtual [Matrix](class_matrix.xhtml) getInputs  ( ::data\_handler::DataHandlerBase  *datahandler*)   pure virtual 

Returns the inputs fitting the training plan from the datahandler.

Parameters datahandlerThe datahandler to get the data from ReturnsThe (scalar) input data Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#afc52921c8d133bb463c1dfa5a8b7ef22).





<a id="a5df8016765ccb017b2ff5778e3e81558"></a>## [◆ ](#a5df8016765ccb017b2ff5778e3e81558)getMOPIdent()

 virtual string getMOPIdent  ( )   pure virtual 

Returns the [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...") ident the TrainingPlan is created for.

ReturnsThe ident for the [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...")Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a255c5ecec66209c6f30d3d5f15177859).





<a id="a32c9c6dc56f9b1b5ad2aa3e686d172c7"></a>## [◆ ](#a32c9c6dc56f9b1b5ad2aa3e686d172c7)getOutputNames()

 virtual std::vector&lt;string&gt; getOutputNames  ( ::data\_handler::DataHandlerBase  *datahandler*)   pure virtual 

Returns the output names from the datahandler.

Parameters datahandlerThe datahandler to get the data from ReturnsThe output data names Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a9f69089e282ffa01fd21080139b05f8f).





<a id="a8de106670ace9e349ee9c149741b8e44"></a>## [◆ ](#a8de106670ace9e349ee9c149741b8e44)getOutputs()

 virtual [Matrix](class_matrix.xhtml) getOutputs  ( ::data\_handler::DataHandlerBase  *datahandler*)   pure virtual 

Returns the outputs fitting the training plan from the datahandler.

Parameters datahandlerThe datahandler to get the data from ReturnsThe (scalar) output data Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a11f9260c1f6f8527fb75fa5950f52dfa).





<a id="a1c4be324fc1e91c3039a49631f6e2cc9"></a>## [◆ ](#a1c4be324fc1e91c3039a49631f6e2cc9)getSampleUsageInSet()

 virtual [SampleUsage](group__training__plan.xhtml#gafce529ac7282fd94c419e8bea8492268) getSampleUsageInSet  ( uint64\_t  *i*,    uint64\_t  *j*   )   pure virtual 

getSampleUsageInSet accessor of the j-th sample in the i-th training set

Parameters iIndex of the training set jIndex of the sample in training set i ReturnsThe sample at the given indices Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a2b8e899313418568acbb9ed5b2ce6ade).





<a id="af67b70402c8a7610ce4a99c252f53681"></a>## [◆ ](#af67b70402c8a7610ce4a99c252f53681)getSampleUsageInSetRef()

 virtual [SampleUsage](group__training__plan.xhtml#gafce529ac7282fd94c419e8bea8492268) getSampleUsageInSetRef  ( uint64\_t  *i*,    uint64\_t  *j*   )   pure virtual 

getSampleUsageInSetRef non- accessor of the j-th sample in the i-th training set

Parameters iIndex of the training set jIndex of the sample in training set i ReturnsThe sample at the given indices Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a6c419ba361cd6d96b71e12bf657d940b).





<a id="ab9acd4287a8208fa9a32867cafaf8e46"></a>## [◆ ](#ab9acd4287a8208fa9a32867cafaf8e46)inputImportance()

 virtual [ParameterImportance](group__common.xhtml#gad5ca470fd07552bf1da82219827c4ec0) inputImportance  ( uint64\_t  *i*)   pure virtual 

parameter returns the ParameterImportance for the i-th parameter

Parameters iThe index of the parameter ReturnsThe ParameterUsage of parameter i Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a7afbd5f5b1743bc2423ca855fe2603ab).





<a id="a60399ab71c2fcf3a21c9a613997c4822"></a>## [◆ ](#a60399ab71c2fcf3a21c9a613997c4822)inputImportanceInSubspace()

 virtual [ParameterImportance](group__common.xhtml#gad5ca470fd07552bf1da82219827c4ec0) inputImportanceInSubspace  ( uint64\_t  *i*,    uint64\_t  *j*,    uint64\_t  *o*   )   pure virtual 

inputImportanceInSubspace returns true if the input j is in the subspace i.

Parameters iIndex of the subspace jIndex of the input parameter oThe o-th output the input is important to ReturnsParameterImportance of input j is in subspace i for the given output Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#aa2ae62e6cab293f7c236e9bf273768f1).





<a id="aed20b1ee85452a87a9e10f39077b94a3"></a>## [◆ ](#aed20b1ee85452a87a9e10f39077b94a3)isValid()

 virtual bool isValid  ( ::data\_handler::DataHandlerBase  )   pure virtual 

Checks if the training plan is valid for the give datahandler.

Returnstrue iff the training plan is valid Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#ad4450a95cde865da632771935f1c57b3).





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

 virtual uint64\_t numInputs  ( )   pure virtual 

numInputs returns the number of inputs used and defined in this training plan

ReturnsThe number of parameters the training plan is defined on Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#aae989fb2bbddfd907494bed60516e03d).





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

 virtual uint64\_t numOutputs  ( )   pure virtual 

numOutputs returns the number of outputs used in this training plan

ReturnsThe number of outputs the training plan is defined on Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a762eb06ef18a50d3041ce79215855763).





<a id="a0ef7e16a9a52c22ecb59f6148accae62"></a>## [◆ ](#a0ef7e16a9a52c22ecb59f6148accae62)numSamplesInSet()

 virtual uint64\_t numSamplesInSet  ( uint64\_t  *i*)   pure virtual 

numSamplesInSet returns the number of elements (samples) in the training set

Parameters iThe index of the training set ReturnsThe number of elements in set i Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#ad3ec25fce42515bda59cd6e7154a8258).





<a id="ad536b0ba37fa27e95a51c0aa3afc96da"></a>## [◆ ](#ad536b0ba37fa27e95a51c0aa3afc96da)numSets()

 virtual uint64\_t numSets  ( )   pure virtual 

numSets returns the number of training sets in the training plan

ReturnsThe number of training sets Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a76d26675967b395d8924915b06fd44f9).





<a id="a44682836a8190246e4db84f997a003cc"></a>## [◆ ](#a44682836a8190246e4db84f997a003cc)numSubspaces()

 virtual uint64\_t numSubspaces  ( uint64\_t  *o*)   pure virtual 

numSubspaces returns the number of filtered subspaces available in the Training Plan to the i-th output in the output matrix

Parameters oThe index of the output ReturnsThe number of Subspaces for the given output Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a52bd33805e42f83fcad54b402b9d4ced).





<a id="a88109fe981a2b192eb8e09a87ae563ed"></a>## [◆ ](#a88109fe981a2b192eb8e09a87ae563ed)numTestSamplesInSet()

 virtual uint64\_t numTestSamplesInSet  ( uint64\_t  *i*)   pure virtual 

numTestSamplesInSet returns the number of elements (samples) in the training set that are labeled SampleUsage::Test

Parameters iThe index of the training set ReturnsThe number of elements in set i Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#aacc683995d55549d854c2d2420aef90c).





<a id="a13261fec66c7bbac8c07123619300275"></a>## [◆ ](#a13261fec66c7bbac8c07123619300275)numTrainingSamplesInSet()

 virtual uint64\_t numTrainingSamplesInSet  ( uint64\_t  *i*)   pure virtual 

numTrainingSamplesInSet returns the number of elements (samples) in the training set that are labeled SampleUsage::Training

Parameters iThe index of the training set ReturnsThe number of elements in set i Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#ad37730c1466388aa53eaeccc3be698d8).





<a id="a3e0dff9e7373d9800e8abe6a61af4c16"></a>## [◆ ](#a3e0dff9e7373d9800e8abe6a61af4c16)output()

 virtual uint64\_t output  ( uint64\_t  *i*)   pure virtual 

parameter returns the index of the i-th output in the output matrix

Parameters iThe index of the parameter ReturnsThe index of output i in the output matrix Implemented in [SimpleTrainingPlan](struct_simple_training_plan.xhtml#a233e0c56c9d1e12b9bc6503a37bc3d8c).