pineforge::hpo::IntegerDimension Class Reference

Named signed-integer dimension with inclusive bounds and a positive step. More...

#include <pineforge/hpo/search_space.hpp>

Public Member Functions
	IntegerDimension (std::string name, std::int64_t low, std::int64_t high, std::int64_t step=1, bool log=false)
	Constructs an integer dimension.
const std::string &	name () const noexcept
	Returns the unique dimension name.
std::int64_t	low () const noexcept
	Returns the inclusive lower bound.
std::int64_t	high () const noexcept
	Returns the inclusive upper bound.
std::int64_t	step () const noexcept
	Returns the positive lattice step.
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 membership in this dimension's integer lattice.

Detailed Description

Named signed-integer dimension with inclusive bounds and a positive step.

Definition at line 24 of file search_space.hpp.

Constructor & Destructor Documentation

IntegerDimension()

pineforge::hpo::IntegerDimension::IntegerDimension	(	std::string	name,
		std::int64_t	low,
		std::int64_t	high,
		std::int64_t	step = 1,
		bool	log = false
	)

Constructs an integer dimension.

Log dimensions require positive bounds and step == 1. Adaptive and random samplers use the expanded latent interval [ln(low - 0.5), ln(high + 0.5)]; finite grid enumeration remains literal.

Exceptions

std::invalid_argument

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

Member Function Documentation

contains()

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

noexcept

Tests both the scalar type and membership in this dimension's integer lattice.

high()

std::int64_t pineforge::hpo::IntegerDimension::high ( ) const

inlinenoexcept

Returns the inclusive upper bound.

Definition at line 45 of file search_space.hpp.

log()

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

inlinenoexcept

Returns whether adaptive samplers operate in logarithmic latent coordinates.

Definition at line 49 of file search_space.hpp.

low()

std::int64_t pineforge::hpo::IntegerDimension::low ( ) const

inlinenoexcept

Returns the inclusive lower bound.

Definition at line 43 of file search_space.hpp.

name()

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

inlinenoexcept

Returns the unique dimension name.

Definition at line 41 of file search_space.hpp.

step()

std::int64_t pineforge::hpo::IntegerDimension::step ( ) const

inlinenoexcept

Returns the positive lattice step.

Definition at line 47 of file search_space.hpp.

---

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

• search_space.hpp