General configuration object for fitters. More...

#include <FitterConfiguration.hpp>

Inheritance diagram for sgpp::datadriven::FitterConfiguration:

Public Member Functions
virtual FitterConfiguration *	clone () 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::CrossvalidationConfiguration &	getCrossvalidationConfig () const
	Get how the crossvalidation should behave. More...

datadriven::CrossvalidationConfiguration &	getCrossvalidationConfig ()
	Get or set how the crossvalidation should behave. More...

const datadriven::DatabaseConfiguration &	getDatabaseConfig () const
	Returns the database configuration, i.e. More...

const datadriven::DensityEstimationConfiguration &	getDensityEstimationConfig () const
	Get how the density estimation should behave. More...

datadriven::DensityEstimationConfiguration &	getDensityEstimationConfig ()
	Get or set how the density estimation should behave. More...

const base::RegularGridConfiguration &	getGridConfig () const
	Get initial conditions for the grid before adaptive refinement. More...

base::RegularGridConfiguration &	getGridConfig ()
	Get or set initial conditions for the grid before adaptive refinement. More...

const datadriven::LearnerConfiguration &	getLearnerConfig () const
	Returns the configuration for the learner's behaviour. More...

const datadriven::OperationMultipleEvalConfiguration &	getMultipleEvalConfig () const
	Get implementation (openMP, MPI, GPU) that should be used for sgpp::base::OperationMultipleEval. More...

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

const base::AdaptivityConfiguration &	getRefinementConfig () const
	Get how the adaptivity algorithms for the grid should behave. More...

base::AdaptivityConfiguration &	getRefinementConfig ()
	Get or set how the adaptivity algorithms for the grid should behave. More...

const datadriven::RegularizationConfiguration &	getRegularizationConfig () const
	Get the type of regularization operation to use. More...

datadriven::RegularizationConfiguration &	getRegularizationConfig ()
	Get or set the type of regularization operation to use. More...

const solver::SLESolverConfiguration &	getSolverFinalConfig () const
	Get configuration for the linear system solver when solving the final, refined system. More...

solver::SLESolverConfiguration &	getSolverFinalConfig ()
	Get or set configuration for the linear system solver when solving the final, refined system. More...

const solver::SLESolverConfiguration &	getSolverRefineConfig () const
	Get configuration for the linear system solver which should be used while building adaptive grids. More...

solver::SLESolverConfiguration &	getSolverRefineConfig ()
	Get or set configuration for the linear system solver which should be used while building adaptive grids. More...

FitterConfiguration &	operator= (const FitterConfiguration &rhs)=default
	Copy assign operator. More...

FitterConfiguration &	operator= (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::AdaptivityConfiguration	adaptivityConfig
	Configure how the adaptivity algorithms for the grid should behave. More...

datadriven::CrossvalidationConfiguration	crossvalidationConfig
	Configure how the crossvalidation should behave. More...

datadriven::DatabaseConfiguration	databaseConfig
	Configure where the lhs datamatrix decomposition database is stored. 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::LearnerConfiguration	learnerConfig
	Configuration for the learner's behaviour. 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

◆ FitterConfiguration() [1/3]

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

default

Sets up a Fitter configuration with its default values.

◆ FitterConfiguration() [2/3]

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

default

Copy constructor.

Parameters

rhs	const reference to the scorer object to copy from.

◆ FitterConfiguration() [3/3]

sgpp::datadriven::FitterConfiguration::FitterConfiguration ( FitterConfiguration && rhs )

default

Move constructor.

Parameters

rhs	R-value reference to a scorer object to moved from.

◆ ~FitterConfiguration()

virtual sgpp::datadriven::FitterConfiguration::~FitterConfiguration ( )

virtualdefault

virtual destructor.

Member Function Documentation

◆ clone()

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::FitterConfigurationClassification, sgpp::datadriven::FitterConfigurationDensityEstimation, and sgpp::datadriven::FitterConfigurationLeastSquares.

◆ getCrossvalidationConfig() [1/2]

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

Get how the crossvalidation should behave.

Returns: immutable CrossvalidationConfiguration

References crossvalidationConfig.

Referenced by getCrossvalidationConfig().

◆ getCrossvalidationConfig() [2/2]

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

Get or set how the crossvalidation should behave.

Returns: CrossvalidationConfiguration

References getCrossvalidationConfig().

◆ getDatabaseConfig()

const datadriven::DatabaseConfiguration & sgpp::datadriven::FitterConfiguration::getDatabaseConfig ( ) const

Returns the database configuration, i.e.

the filepath

Returns: immutable DatabaseConfiguration

References databaseConfig.

◆ getDensityEstimationConfig() [1/2]

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

Get how the density estimation should behave.

Returns: immutable DensityEstimationConfiguration

References densityEstimationConfig.

Referenced by sgpp::datadriven::ModelFittingClassification::fit(), and getDensityEstimationConfig().

◆ getDensityEstimationConfig() [2/2]

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

Get or set how the density estimation should behave.

Returns: DensityEstimationConfiguration

References getDensityEstimationConfig().

◆ getGridConfig() [1/2]

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().

◆ getGridConfig() [2/2]

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

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

Returns: RegularGridConfiguration

References getGridConfig().

◆ getLearnerConfig()

const datadriven::LearnerConfiguration & sgpp::datadriven::FitterConfiguration::getLearnerConfig ( ) const

Returns the configuration for the learner's behaviour.

Returns: immutable LearnerConfiguration

References learnerConfig.

◆ getMultipleEvalConfig() [1/2]

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().

◆ getMultipleEvalConfig() [2/2]

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().

◆ getRefinementConfig() [1/2]

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

Get how the adaptivity algorithms for the grid should behave.

Returns: immutable AdaptivityConfiguration

References adaptivityConfig.

Referenced by getRefinementConfig().

◆ getRefinementConfig() [2/2]

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

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

Returns: AdaptivityConfiguration

References getRefinementConfig().

◆ getRegularizationConfig() [1/2]

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

Get the type of regularization operation to use.

Returns: immutable RegularizationConfiguration

References regularizationConfig.

Referenced by getRegularizationConfig().

◆ getRegularizationConfig() [2/2]

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

Get or set the type of regularization operation to use.

Returns: RegularizationConfiguration

References getRegularizationConfig().

◆ getSolverFinalConfig() [1/2]

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().

◆ getSolverFinalConfig() [2/2]

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().

◆ getSolverRefineConfig() [1/2]

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().

◆ getSolverRefineConfig() [2/2]

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().

◆ operator=() [1/2]

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

default

Copy assign operator.

Parameters

rhs	const reference to the scorer object to copy from.

Returns: rerefernce to this with updated values.

◆ operator=() [2/2]

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

default

Move assign operator.

Parameters

rhs	R-value reference to an a scorer object to move from.

Returns: rerefernce to this with updated values.

◆ readParams()

virtual void sgpp::datadriven::FitterConfiguration::readParams ( const DataMiningConfigParser & parser )

pure virtual

obtain parameters from a parser

Parameters

parser the parser object to read from

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

◆ setupDefaults()

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

pure virtual

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

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

Member Data Documentation

◆ adaptivityConfig

base::AdaptivityConfiguration sgpp::datadriven::FitterConfiguration::adaptivityConfig

protected

Configure how the adaptivity algorithms for the grid should behave.

Referenced by getRefinementConfig(), sgpp::datadriven::FitterConfigurationLeastSquares::readParams(), sgpp::datadriven::FitterConfigurationDensityEstimation::readParams(), sgpp::datadriven::FitterConfigurationLeastSquares::setupDefaults(), and sgpp::datadriven::FitterConfigurationDensityEstimation::setupDefaults().

◆ crossvalidationConfig

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

protected

Configure how the crossvalidation should behave.

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

◆ databaseConfig

datadriven::DatabaseConfiguration sgpp::datadriven::FitterConfiguration::databaseConfig

protected

Configure where the lhs datamatrix decomposition database is stored.

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

◆ densityEstimationConfig

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

protected

Configure how the density estimation should behave.

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

◆ gridConfig

base::RegularGridConfiguration sgpp::datadriven::FitterConfiguration::gridConfig

protected

Initial conditions for the grid before adaptive refinement.

Referenced by getGridConfig(), sgpp::datadriven::FitterConfigurationLeastSquares::readParams(), sgpp::datadriven::FitterConfigurationDensityEstimation::readParams(), sgpp::datadriven::FitterConfigurationLeastSquares::setupDefaults(), and sgpp::datadriven::FitterConfigurationDensityEstimation::setupDefaults().

◆ learnerConfig

datadriven::LearnerConfiguration sgpp::datadriven::FitterConfiguration::learnerConfig

protected

Configuration for the learner's behaviour.

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

◆ multipleEvalConfig

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

protected

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

Referenced by getMultipleEvalConfig().

◆ regularizationConfig

datadriven::RegularizationConfiguration sgpp::datadriven::FitterConfiguration::regularizationConfig

protected

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).

Referenced by getRegularizationConfig(), sgpp::datadriven::FitterConfigurationLeastSquares::readParams(), sgpp::datadriven::FitterConfigurationDensityEstimation::readParams(), sgpp::datadriven::FitterConfigurationLeastSquares::setupDefaults(), and sgpp::datadriven::FitterConfigurationDensityEstimation::setupDefaults().

◆ solverFinalConfig

solver::SLESolverConfiguration sgpp::datadriven::FitterConfiguration::solverFinalConfig

protected

Configuration for the linear system solver when solving the final, refined system.

Referenced by getSolverFinalConfig(), sgpp::datadriven::FitterConfigurationLeastSquares::readParams(), sgpp::datadriven::FitterConfigurationDensityEstimation::readParams(), sgpp::datadriven::FitterConfigurationLeastSquares::setupDefaults(), and sgpp::datadriven::FitterConfigurationDensityEstimation::setupDefaults().

◆ solverRefineConfig

solver::SLESolverConfiguration sgpp::datadriven::FitterConfiguration::solverRefineConfig

protected

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

Referenced by getSolverRefineConfig(), sgpp::datadriven::FitterConfigurationLeastSquares::readParams(), sgpp::datadriven::FitterConfigurationDensityEstimation::readParams(), sgpp::datadriven::FitterConfigurationLeastSquares::setupDefaults(), and sgpp::datadriven::FitterConfigurationDensityEstimation::setupDefaults().

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

datadriven/src/sgpp/datadriven/datamining/modules/fitting/FitterConfiguration.hpp
datadriven/src/sgpp/datadriven/datamining/modules/fitting/FitterConfiguration.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FitterConfiguration() [1/3]

◆ FitterConfiguration() [2/3]

◆ FitterConfiguration() [3/3]

◆ ~FitterConfiguration()

Member Function Documentation

◆ clone()

◆ getCrossvalidationConfig() [1/2]

◆ getCrossvalidationConfig() [2/2]

◆ getDatabaseConfig()

◆ getDensityEstimationConfig() [1/2]

◆ getDensityEstimationConfig() [2/2]

◆ getGridConfig() [1/2]

◆ getGridConfig() [2/2]

◆ getLearnerConfig()

◆ getMultipleEvalConfig() [1/2]

◆ getMultipleEvalConfig() [2/2]

◆ getRefinementConfig() [1/2]

◆ getRefinementConfig() [2/2]

◆ getRegularizationConfig() [1/2]

◆ getRegularizationConfig() [2/2]

◆ getSolverFinalConfig() [1/2]

◆ getSolverFinalConfig() [2/2]

◆ getSolverRefineConfig() [1/2]

◆ getSolverRefineConfig() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ readParams()

◆ setupDefaults()

Member Data Documentation

◆ adaptivityConfig

◆ crossvalidationConfig

◆ databaseConfig

◆ densityEstimationConfig

◆ gridConfig

◆ learnerConfig

◆ multipleEvalConfig

◆ regularizationConfig

◆ solverFinalConfig

◆ solverRefineConfig