SG++
sgpp::datadriven::FitterConfiguration Class Referenceabstract

General configuration object for fitters. More...

#include <FitterConfiguration.hpp>

Inheritance diagram for sgpp::datadriven::FitterConfiguration:
sgpp::datadriven::FitterConfigurationDensityEstimation sgpp::datadriven::FitterConfigurationLeastSquares

Public Member Functions

virtual FitterConfigurationclone () const =0
 Polymorphic clone pattern. More...
 
 FitterConfiguration ()=default
 Sets up a Fitter configuration with its default values. More...
 
 FitterConfiguration (const FitterConfiguration &rhs)=default
 Copy constructor. More...
 
 FitterConfiguration (FitterConfiguration &&rhs)=default
 Move constructor. More...
 
const datadriven::CrossvalidationConfigurationgetCrossvalidationConfig () const
 Get how the crossvalidation should behave. More...
 
datadriven::CrossvalidationConfigurationgetCrossvalidationConfig ()
 Get or set how the crossvalidation should behave. More...
 
const datadriven::DensityEstimationConfigurationgetDensityEstimationConfig () const
 Get how the density estimation should behave. More...
 
datadriven::DensityEstimationConfigurationgetDensityEstimationConfig ()
 Get or set how the density estimation should behave. More...
 
const base::RegularGridConfigurationgetGridConfig () const
 Get initial conditions for the grid before adaptive refinement. More...
 
base::RegularGridConfigurationgetGridConfig ()
 Get or set initial conditions for the grid before adaptive refinement. More...
 
const datadriven::OperationMultipleEvalConfigurationgetMultipleEvalConfig () const
 Get implementation (openMP, MPI, GPU) that should be used for sgpp::base::OperationMultipleEval. More...
 
datadriven::OperationMultipleEvalConfigurationgetMultipleEvalConfig ()
 Get or set implementation (openMP, MPI, GPU) that should be used for sgpp::base::OperationMultipleEval. More...
 
const base::AdpativityConfigurationgetRefinementConfig () const
 Get how the adaptivity algorithms for the grid should behave. More...
 
base::AdpativityConfigurationgetRefinementConfig ()
 Get or set how the adaptivity algorithms for the grid should behave. More...
 
const datadriven::RegularizationConfigurationgetRegularizationConfig () const
 Get the type of regularization operation to use. More...
 
datadriven::RegularizationConfigurationgetRegularizationConfig ()
 Get or set the type of regularization operation to use. More...
 
const solver::SLESolverConfigurationgetSolverFinalConfig () const
 Get configuration for the linear system solver when solving the final, refined system. More...
 
solver::SLESolverConfigurationgetSolverFinalConfig ()
 Get or set configuration for the linear system solver when solving the final, refined system. More...
 
const solver::SLESolverConfigurationgetSolverRefineConfig () const
 Get configuration for the linear system solver which should be used while building adaptive grids. More...
 
solver::SLESolverConfigurationgetSolverRefineConfig ()
 Get or set configuration for the linear system solver which should be used while building adaptive grids. More...
 
FitterConfigurationoperator= (const FitterConfiguration &rhs)=default
 Copy assign operator. More...
 
FitterConfigurationoperator= (FitterConfiguration &&rhs)=default
 Move assign operator. More...
 
virtual void readParams (const DataMiningConfigParser &parser)=0
 obtain parameters from a parser More...
 
virtual void setupDefaults ()=0
 set default values for all members based on the desired scenario. More...
 
virtual ~FitterConfiguration ()=default
 virtual destructor. More...
 

Protected Attributes

base::AdpativityConfiguration adaptivityConfig
 Configure how the adaptivity algorithms for the grid should behave. More...
 
datadriven::CrossvalidationConfiguration crossvalidationConfig
 Configure how the crossvalidation should behave. More...
 
datadriven::DensityEstimationConfiguration densityEstimationConfig
 Configure how the density estimation should behave. More...
 
base::RegularGridConfiguration gridConfig
 Initial conditions for the grid before adaptive refinement. More...
 
datadriven::OperationMultipleEvalConfiguration multipleEvalConfig
 Determine implementation (openMP, MPI, GPU) that should be used for sgpp::base::OperationMultipleEval. More...
 
datadriven::RegularizationConfiguration regularizationConfig
 Set the type of regularization operation to use and specify the influence of the regularization term vs data term from 0 (no regularization) to 1 (no data term). More...
 
solver::SLESolverConfiguration solverFinalConfig
 Configuration for the linear system solver when solving the final, refined system. More...
 
solver::SLESolverConfiguration solverRefineConfig
 Configuration for the linear system solver which should be used while building adaptive grids. More...
 

Detailed Description

General configuration object for fitters.

Bundles all structures needed to build a sparse grid, fit a sparse grid based model, and perform adaptive refinement.

Constructor & Destructor Documentation

sgpp::datadriven::FitterConfiguration::FitterConfiguration ( )
default

Sets up a Fitter configuration with its default values.

sgpp::datadriven::FitterConfiguration::FitterConfiguration ( const FitterConfiguration rhs)
default

Copy constructor.

Parameters
rhsconst reference to the scorer object to copy from.
sgpp::datadriven::FitterConfiguration::FitterConfiguration ( FitterConfiguration &&  rhs)
default

Move constructor.

Parameters
rhsR-value reference to a scorer object to moved from.
virtual sgpp::datadriven::FitterConfiguration::~FitterConfiguration ( )
virtualdefault

virtual destructor.

Member Function Documentation

virtual FitterConfiguration* sgpp::datadriven::FitterConfiguration::clone ( ) const
pure virtual

Polymorphic clone pattern.

Returns
deep copy of this object. New object is owned by caller.

Implemented in sgpp::datadriven::FitterConfigurationDensityEstimation, and sgpp::datadriven::FitterConfigurationLeastSquares.

const datadriven::CrossvalidationConfiguration & sgpp::datadriven::FitterConfiguration::getCrossvalidationConfig ( ) const

Get how the crossvalidation should behave.

Returns
immutable CrossvalidationConfiguration

References crossvalidationConfig.

Referenced by getCrossvalidationConfig().

datadriven::CrossvalidationConfiguration & sgpp::datadriven::FitterConfiguration::getCrossvalidationConfig ( )

Get or set how the crossvalidation should behave.

Returns
CrossvalidationConfiguration

References getCrossvalidationConfig().

const datadriven::DensityEstimationConfiguration & sgpp::datadriven::FitterConfiguration::getDensityEstimationConfig ( ) const

Get how the density estimation should behave.

Returns
immutable DensityEstimationConfiguration

References densityEstimationConfig.

Referenced by getDensityEstimationConfig().

datadriven::DensityEstimationConfiguration & sgpp::datadriven::FitterConfiguration::getDensityEstimationConfig ( )

Get or set how the density estimation should behave.

Returns
DensityEstimationConfiguration

References getDensityEstimationConfig().

const base::RegularGridConfiguration & sgpp::datadriven::FitterConfiguration::getGridConfig ( ) const

Get initial conditions for the grid before adaptive refinement.

Returns
immutable RegularGridConfiguration

References gridConfig.

Referenced by getGridConfig().

base::RegularGridConfiguration & sgpp::datadriven::FitterConfiguration::getGridConfig ( )

Get or set initial conditions for the grid before adaptive refinement.

Returns
RegularGridConfiguration

References getGridConfig().

const datadriven::OperationMultipleEvalConfiguration & sgpp::datadriven::FitterConfiguration::getMultipleEvalConfig ( ) const

Get implementation (openMP, MPI, GPU) that should be used for sgpp::base::OperationMultipleEval.

Returns
immutable OperationMultipleEvalConfiguration

References multipleEvalConfig.

Referenced by getMultipleEvalConfig().

datadriven::OperationMultipleEvalConfiguration & sgpp::datadriven::FitterConfiguration::getMultipleEvalConfig ( )

Get or set implementation (openMP, MPI, GPU) that should be used for sgpp::base::OperationMultipleEval.

Returns
current OperationMultipleEvalConfiguration

References getMultipleEvalConfig().

const base::AdpativityConfiguration & sgpp::datadriven::FitterConfiguration::getRefinementConfig ( ) const

Get how the adaptivity algorithms for the grid should behave.

Returns
immutable AdpativityConfiguration

References adaptivityConfig.

Referenced by getRefinementConfig().

base::AdpativityConfiguration & sgpp::datadriven::FitterConfiguration::getRefinementConfig ( )

Get or set how the adaptivity algorithms for the grid should behave.

Returns
AdpativityConfiguration

References getRefinementConfig().

const datadriven::RegularizationConfiguration & sgpp::datadriven::FitterConfiguration::getRegularizationConfig ( ) const

Get the type of regularization operation to use.

Returns
immutable RegularizationConfiguration

References regularizationConfig.

Referenced by getRegularizationConfig().

datadriven::RegularizationConfiguration & sgpp::datadriven::FitterConfiguration::getRegularizationConfig ( )

Get or set the type of regularization operation to use.

Returns
RegularizationConfiguration

References getRegularizationConfig().

const solver::SLESolverConfiguration & sgpp::datadriven::FitterConfiguration::getSolverFinalConfig ( ) const

Get configuration for the linear system solver when solving the final, refined system.

Returns
immutable SLESolverConfiguration

References solverFinalConfig.

Referenced by getSolverFinalConfig().

solver::SLESolverConfiguration & sgpp::datadriven::FitterConfiguration::getSolverFinalConfig ( )

Get or set configuration for the linear system solver when solving the final, refined system.

Returns
SLESolverConfiguration

References getSolverFinalConfig().

const solver::SLESolverConfiguration & sgpp::datadriven::FitterConfiguration::getSolverRefineConfig ( ) const

Get configuration for the linear system solver which should be used while building adaptive grids.

Returns
immutable SLESolverConfiguration

References solverRefineConfig.

Referenced by getSolverRefineConfig().

solver::SLESolverConfiguration & sgpp::datadriven::FitterConfiguration::getSolverRefineConfig ( )

Get or set configuration for the linear system solver which should be used while building adaptive grids.

Returns
SLESolverConfiguration

References getSolverRefineConfig().

FitterConfiguration& sgpp::datadriven::FitterConfiguration::operator= ( const FitterConfiguration rhs)
default

Copy assign operator.

Parameters
rhsconst reference to the scorer object to copy from.
Returns
rerefernce to this with updated values.
FitterConfiguration& sgpp::datadriven::FitterConfiguration::operator= ( FitterConfiguration &&  rhs)
default

Move assign operator.

Parameters
rhsR-value reference to an a scorer object to move from.
Returns
rerefernce to this with updated values.
virtual void sgpp::datadriven::FitterConfiguration::readParams ( const DataMiningConfigParser parser)
pure virtual

obtain parameters from a parser

Parameters
parserthe parser object to read from

Implemented in sgpp::datadriven::FitterConfigurationDensityEstimation, and sgpp::datadriven::FitterConfigurationLeastSquares.

virtual void sgpp::datadriven::FitterConfiguration::setupDefaults ( )
pure virtual

set default values for all members based on the desired scenario.

Implemented in sgpp::datadriven::FitterConfigurationDensityEstimation, and sgpp::datadriven::FitterConfigurationLeastSquares.

Member Data Documentation

datadriven::CrossvalidationConfiguration sgpp::datadriven::FitterConfiguration::crossvalidationConfig
protected

Configure how the crossvalidation should behave.

Referenced by getCrossvalidationConfig(), and sgpp::datadriven::FitterConfigurationDensityEstimation::setupDefaults().

datadriven::DensityEstimationConfiguration sgpp::datadriven::FitterConfiguration::densityEstimationConfig
protected

Configure how the density estimation should behave.

Referenced by getDensityEstimationConfig(), and sgpp::datadriven::FitterConfigurationDensityEstimation::setupDefaults().

datadriven::OperationMultipleEvalConfiguration sgpp::datadriven::FitterConfiguration::multipleEvalConfig
protected

Determine implementation (openMP, MPI, GPU) that should be used for sgpp::base::OperationMultipleEval.

Referenced by getMultipleEvalConfig().

datadriven::RegularizationConfiguration sgpp::datadriven::FitterConfiguration::regularizationConfig
protected
solver::SLESolverConfiguration sgpp::datadriven::FitterConfiguration::solverFinalConfig
protected
solver::SLESolverConfiguration sgpp::datadriven::FitterConfiguration::solverRefineConfig
protected

The documentation for this class was generated from the following files: