SG++-Doxygen-Documentation
sgpp::datadriven::HyperParameter Class Referenceabstract

Class to represent a hyperparameter. More...

#include <HyperParameter.hpp>

Inheritance diagram for sgpp::datadriven::HyperParameter:
sgpp::datadriven::ContinuousParameter sgpp::datadriven::DiscreteParameter

Public Member Functions

 HyperParameter ()
 Default constructor for implicit use by data structures. More...
 
 HyperParameter (size_t nBits, std::string &name)
 Normal constructor. More...
 
void makeConfigBits (std::vector< ConfigurationBit * > &configBits)
 Connects parameter to bit representation in harmonica. More...
 
virtual void setHarmonica ()=0
 sets value according to the associated bits More...
 
virtual ~HyperParameter ()=default
 Default Destructor. More...
 

Protected Attributes

std::vector< ConfigurationBitbits
 associated configuration bits for harmonica More...
 
std::string name
 name of the hyperparameter More...
 
size_t nBits
 number of bits for harmonica More...
 

Detailed Description

Class to represent a hyperparameter.

Constructor & Destructor Documentation

sgpp::datadriven::HyperParameter::HyperParameter ( )
inline

Default constructor for implicit use by data structures.

sgpp::datadriven::HyperParameter::HyperParameter ( size_t  nBits,
std::string &  name 
)
inline

Normal constructor.

Parameters
nBitsnumber of bits for representation in harmonica
namename of the hyperparameter

References makeConfigBits(), setHarmonica(), and ~HyperParameter().

virtual sgpp::datadriven::HyperParameter::~HyperParameter ( )
virtualdefault

Default Destructor.

Referenced by HyperParameter().

Member Function Documentation

void sgpp::datadriven::HyperParameter::makeConfigBits ( std::vector< ConfigurationBit * > &  configBits)

Connects parameter to bit representation in harmonica.

Parameters
configBits

References bits, python.statsfileInfo::i, name, and nBits.

Referenced by HyperParameter().

virtual void sgpp::datadriven::HyperParameter::setHarmonica ( )
pure virtual

sets value according to the associated bits

Implemented in sgpp::datadriven::DiscreteParameter, and sgpp::datadriven::ContinuousParameter.

Referenced by HyperParameter().

Member Data Documentation

std::vector<ConfigurationBit> sgpp::datadriven::HyperParameter::bits
protected
std::string sgpp::datadriven::HyperParameter::name
protected

name of the hyperparameter

Referenced by makeConfigBits().

size_t sgpp::datadriven::HyperParameter::nBits
protected

number of bits for harmonica

Referenced by sgpp::datadriven::DiscreteParameter::DiscreteParameter(), and makeConfigBits().


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