Named dimension backed by an ordered, non-empty set of scalar choices. More...

#include <pineforge/hpo/search_space.hpp>

Public Member Functions
	CategoricalDimension (std::string name, std::vector< ParameterValue > choices)
	Constructs a categorical dimension.

const std::string &	name () const noexcept
	Returns the unique dimension name.

const std::vector< ParameterValue > &	choices () const noexcept
	Returns choices in their declared finite-grid order.

bool	contains (const ParameterValue &value) const noexcept
	Tests exact type-and-value membership in the declared choices.

Detailed Description

Named dimension backed by an ordered, non-empty set of scalar choices.

Definition at line 114 of file search_space.hpp.

Constructor & Destructor Documentation

◆ CategoricalDimension()

pineforge::hpo::CategoricalDimension::CategoricalDimension	(	std::string	name,
		std::vector< ParameterValue >	choices
	)

Constructs a categorical dimension.

Exceptions

std::invalid_argument for an empty name, no choices, duplicate choices, non-finite real choices, or choices that serialize to the same strategy-ABI text.

Member Function Documentation

◆ choices()

const std::vector< ParameterValue > & pineforge::hpo::CategoricalDimension::choices ( ) const

inlinenoexcept

Returns choices in their declared finite-grid order.

Definition at line 125 of file search_space.hpp.

◆ contains()

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

noexcept

Tests exact type-and-value membership in the declared choices.

◆ name()

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

inlinenoexcept

Returns the unique dimension name.

Definition at line 123 of file search_space.hpp.

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

search_space.hpp