pineforge::hpo::RealDimension Class Reference

Named binary64 dimension with inclusive bounds and an optional finite-grid step. More...

#include <pineforge/hpo/search_space.hpp>

Public Member Functions
	RealDimension (std::string name, double low, double high, std::optional< double > step=std::nullopt, bool log=false)
	Constructs a real dimension.
const std::string &	name () const noexcept
	Returns the unique dimension name.
double	low () const noexcept
	Returns the inclusive lower bound.
double	high () const noexcept
	Returns the inclusive upper bound.
const std::optional< double > &	step () const noexcept
	Returns the finite-grid step, or std::nullopt for a continuous dimension.
bool	log () const noexcept
	Returns whether adaptive samplers operate in logarithmic latent coordinates.
bool	contains (const ParameterValue &value) const noexcept
	Tests both the scalar type and interval/lattice membership.

Detailed Description

Named binary64 dimension with inclusive bounds and an optional finite-grid step.

Definition at line 62 of file search_space.hpp.

Constructor & Destructor Documentation

RealDimension()

pineforge::hpo::RealDimension::RealDimension	(	std::string	name,
		double	low,
		double	high,
		std::optional< double >	step = std::nullopt,
		bool	log = false
	)

Constructs a real dimension.

Log dimensions require positive bounds and no step. Values remain in original units at the public Candidate and strategy-ABI boundaries.

Exceptions

std::invalid_argument

for an empty name, non-finite or reversed bounds, a non-positive/non-finite step, or an invalid log configuration.

Member Function Documentation

contains()

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

noexcept

Tests both the scalar type and interval/lattice membership.

high()

double pineforge::hpo::RealDimension::high ( ) const

inlinenoexcept

Returns the inclusive upper bound.

Definition at line 82 of file search_space.hpp.

log()

bool pineforge::hpo::RealDimension::log ( ) const

inlinenoexcept

Returns whether adaptive samplers operate in logarithmic latent coordinates.

Definition at line 86 of file search_space.hpp.

low()

double pineforge::hpo::RealDimension::low ( ) const

inlinenoexcept

Returns the inclusive lower bound.

Definition at line 80 of file search_space.hpp.

name()

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

inlinenoexcept

Returns the unique dimension name.

Definition at line 78 of file search_space.hpp.

step()

const std::optional< double > & pineforge::hpo::RealDimension::step ( ) const

inlinenoexcept

Returns the finite-grid step, or std::nullopt for a continuous dimension.

Definition at line 84 of file search_space.hpp.

---

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

• search_space.hpp