SG++-Doxygen-Documentation

A database class to store and retrieve online matrix decompositions for the sparse grid density estimation. More...

#include <DBMatDatabase.hpp>

## Public Member Functions

DBMatDatabase (const std::string &filepath)
Initializes the database from a json filepath. More...

Scans the entire database and finds the first entry that matches the configurations. More...

Scans the entire database and checks weather any entry matches the configuration. More...

Puts a filepath for a given configuration in the database. More...

virtual ~DBMatDatabase ()=default

## Detailed Description

A database class to store and retrieve online matrix decompositions for the sparse grid density estimation.

The class works on a json file.

## ◆ DBMatDatabase()

 sgpp::datadriven::DBMatDatabase::DBMatDatabase ( const std::string & filepath )
explicit

Initializes the database from a json filepath.

Parameters
 filepath the path to the json database

virtualdefault

## ◆ getDataMatrix()

Scans the entire database and finds the first entry that matches the configurations.

Parameters
 gridConfig the grid configuration the matrix must match adaptivityConfig the adaptivity configuration the matrix must match regularizationConfig the regularization configuration the matrix must match densityEstimationConfig the density estimation configuration the matrix must match
Returns
Returns the string of the datamatrix if any match was obtained and throws an exception otherwise

## ◆ hasDataMatrix()

Scans the entire database and checks weather any entry matches the configuration.

Parameters
 gridConfig the grid configuration the matrix must match adaptivityConfig the adaptivity configuration the matrix must match regularizationConfig the regularization configuration the matrix must match densityEstimationConfig the density estimation configuration the matrix must match
Returns
weather the configuration is held in the database

## ◆ putDataMatrix()

 void sgpp::datadriven::DBMatDatabase::putDataMatrix ( sgpp::base::GeneralGridConfiguration & gridConfig, sgpp::base::AdaptivityConfiguration & adaptivityConfig, sgpp::datadriven::RegularizationConfiguration & regularizationConfig, sgpp::datadriven::DensityEstimationConfiguration & densityEstimationConfig, std::string filepath, bool overwriteEntry = false )

Puts a filepath for a given configuration in the database.

The filepath refers to the matrix file. If for this configuration a filepath is already present in the database the filepath is updated if and only if the overwriteEntry parameter is set (default = false).

Parameters
 gridConfig the grid configuration the matrix matches adaptivityConfig the adaptivity configuration the matrix matches regularizationConfig the regularization configuration the matrix matches densityEstimationConfig the density estimation configuration the matrix matches filepath the path where the matrix decomposition is located at overwriteEntry replaces existing entries with the same configuration if and only if this parameter is set

Referenced by main().

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