SG++-Doxygen-Documentation
sgpp::datadriven::ConfigurationBit Class Reference

This class implements a boolean representation of hyperparameters for harmonica. More...

#include <ConfigurationBit.hpp>

Public Member Functions

void addConstraint (ConfigurationRestriction *constraint)
 Adds a reference to a new constraint limiting this bit. More...
 
 ConfigurationBit (std::string name)
 Constructor. More...
 
void findComplexinner (std::string id, int bias)
 
std::string getName ()
 Get the name used to identify which hyperparameter is represented by this bit. More...
 
int getValue ()
 Get the value of this bit. More...
 
void removeLastConstraint ()
 removes last constraint (in case it was not valid) More...
 
void reset ()
 reset the value of this bit More...
 
void setValue (int input)
 Set the value of this bit. More...
 

Detailed Description

This class implements a boolean representation of hyperparameters for harmonica.

Constructor & Destructor Documentation

◆ ConfigurationBit()

sgpp::datadriven::ConfigurationBit::ConfigurationBit ( std::string  name)
inlineexplicit

Constructor.

Parameters
nameto indentify the hyperparameter represented by this bit

References addConstraint(), findComplexinner(), getName(), getValue(), removeLastConstraint(), reset(), and setValue().

Member Function Documentation

◆ addConstraint()

void sgpp::datadriven::ConfigurationBit::addConstraint ( ConfigurationRestriction constraint)

Adds a reference to a new constraint limiting this bit.

Parameters
constraint

Referenced by ConfigurationBit().

◆ findComplexinner()

void sgpp::datadriven::ConfigurationBit::findComplexinner ( std::string  id,
int  bias 
)

Referenced by ConfigurationBit().

◆ getName()

std::string sgpp::datadriven::ConfigurationBit::getName ( )

Get the name used to identify which hyperparameter is represented by this bit.

Returns
name of the bit

Referenced by ConfigurationBit().

◆ getValue()

int sgpp::datadriven::ConfigurationBit::getValue ( )

Get the value of this bit.

Returns

Referenced by ConfigurationBit().

◆ removeLastConstraint()

void sgpp::datadriven::ConfigurationBit::removeLastConstraint ( )

removes last constraint (in case it was not valid)

Referenced by ConfigurationBit().

◆ reset()

void sgpp::datadriven::ConfigurationBit::reset ( )

reset the value of this bit

Referenced by ConfigurationBit().

◆ setValue()

void sgpp::datadriven::ConfigurationBit::setValue ( int  input)

Set the value of this bit.

Parameters
inputnew value

Referenced by ConfigurationBit().


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