sgpp::datadriven::DiscreteParameter Class Reference

concrete class for hyperparameter with discrete values More...

#include <DiscreteParameter.hpp>

Inheritance diagram for sgpp::datadriven::DiscreteParameter:

Public Member Functions
	DiscreteParameter ()=default
	Default Constructor. More...
	DiscreteParameter (std::string &&name, int minv, int maxv)
	Normal constructor, number of bits calculated automatically. More...
	DiscreteParameter (int nBits, std::string &&name, int minv, int maxv)
	Constructor with custom number of bits. More...
int	getNOptions ()
	Retrieve the number of options for this parameter. More...
int	getValue ()
	Retrieve the current value of the hyperparameter. More...
void	setBO (int option)
	adjust the current value of the hyperparameter according to the (normalized) input More...
void	setHarmonica () override
	adjust the current value of the hyperparameter according to the bit configuration by harmonica More...
Public Member Functions inherited from sgpp::datadriven::HyperParameter
	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	~HyperParameter ()=default
	Default Destructor. More...

Protected Attributes
int	maxv
	maximum value of the hyperparameter during optimization More...
int	minv
	minimum value of the hyperparameter during optimization More...
int	value = 0
	current value of the hyperparameter More...
Protected Attributes inherited from sgpp::datadriven::HyperParameter
std::vector< ConfigurationBit >	bits
	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

concrete class for hyperparameter with discrete values

Constructor & Destructor Documentation

DiscreteParameter() [1/3]

sgpp::datadriven::DiscreteParameter::DiscreteParameter ( )

default

Default Constructor.

DiscreteParameter() [2/3]

sgpp::datadriven::DiscreteParameter::DiscreteParameter	(	std::string &&	name,
		int	minv,
		int	maxv
	)

Normal constructor, number of bits calculated automatically.

Parameters

name	name of the hyperparameter
minv	minimum value of the hyperparameter during optimization
maxv	maximum value of the hyperparameter during optimization

References python.statsfileInfo::i, and sgpp::datadriven::HyperParameter::nBits.

DiscreteParameter() [3/3]

sgpp::datadriven::DiscreteParameter::DiscreteParameter ( int  nBits, std::string &&  name, int  minv, int  maxv  )

inline

Constructor with custom number of bits.

Parameters

nBits	number of bits for representation in harmonica
name	name of the hyperparameter
minv	minimum value of the hyperparameter during optimization
maxv	maximum value of the hyperparameter during optimization

References getNOptions(), getValue(), setBO(), and setHarmonica().

Member Function Documentation

getNOptions()

int sgpp::datadriven::DiscreteParameter::getNOptions

(

)

Retrieve the number of options for this parameter.

Returns

References maxv, and minv.

Referenced by DiscreteParameter().

getValue()

int sgpp::datadriven::DiscreteParameter::getValue

(

)

Retrieve the current value of the hyperparameter.

Returns

value of the hyperparameter

References value.

Referenced by DiscreteParameter().

setBO()

void sgpp::datadriven::DiscreteParameter::setBO

(

int

option

)

adjust the current value of the hyperparameter according to the (normalized) input

Parameters

option

value of the parameter from 0

References minv, and value.

Referenced by DiscreteParameter().

setHarmonica()

void sgpp::datadriven::DiscreteParameter::setHarmonica ( )

overridevirtual

adjust the current value of the hyperparameter according to the bit configuration by harmonica

Implements sgpp::datadriven::HyperParameter.

References sgpp::datadriven::HyperParameter::bits, m, maxv, minv, and value.

Referenced by DiscreteParameter().

Member Data Documentation

maxv

int sgpp::datadriven::DiscreteParameter::maxv

protected

maximum value of the hyperparameter during optimization

Referenced by getNOptions(), and setHarmonica().

minv

int sgpp::datadriven::DiscreteParameter::minv

protected

minimum value of the hyperparameter during optimization

Referenced by getNOptions(), setBO(), and setHarmonica().

value

int sgpp::datadriven::DiscreteParameter::value = 0

protected

current value of the hyperparameter

Referenced by getValue(), setBO(), and setHarmonica().

---

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

• datadriven/src/sgpp/datadriven/datamining/modules/hpo/parameters/DiscreteParameter.hpp
• datadriven/src/sgpp/datadriven/datamining/modules/hpo/parameters/DiscreteParameter.cpp