pineforge::hpo::BooleanDimension Class Reference

Named dimension whose legal values are exactly false and true. More...

#include <pineforge/hpo/search_space.hpp>

Public Member Functions
	BooleanDimension (std::string name)
const std::string &	name () const noexcept
	Returns the unique dimension name.
bool	contains (const ParameterValue &value) const noexcept
	Returns true only when value contains a Boolean alternative.

Detailed Description

Named dimension whose legal values are exactly false and true.

Definition at line 99 of file search_space.hpp.

Constructor & Destructor Documentation

BooleanDimension()

pineforge::hpo::BooleanDimension::BooleanDimension ( std::string  name )

explicit

Exceptions

std::invalid_argument

if name is empty.

Member Function Documentation

contains()

bool pineforge::hpo::BooleanDimension::contains ( const ParameterValue &  value ) const

noexcept

Returns true only when value contains a Boolean alternative.

name()

const std::string & pineforge::hpo::BooleanDimension::name ( ) const

inlinenoexcept

Returns the unique dimension name.

Definition at line 105 of file search_space.hpp.

---

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

• search_space.hpp