pineforge::hpo::Candidate Struct Reference

Complete parameter assignment proposed by a sampler. More...

#include <pineforge/hpo/types.hpp>

Public Member Functions
const ParameterValue *	find (const std::string &name) const noexcept
	Returns the named value, or nullptr when the candidate does not contain it.

Public Attributes
std::uint64_t	id = 0
	Sampler-assigned identifier used to correlate an ask with its result.
std::map< std::string, ParameterValue >	values
	Parameter values keyed by search-space dimension name.

Detailed Description

Complete parameter assignment proposed by a sampler.

Definition at line 36 of file types.hpp.

Member Function Documentation

find()

const ParameterValue * pineforge::hpo::Candidate::find ( const std::string &  name ) const

noexcept

Returns the named value, or nullptr when the candidate does not contain it.

The returned pointer remains valid until this candidate's map is mutated or destroyed.

Member Data Documentation

id

std::uint64_t pineforge::hpo::Candidate::id = 0

Sampler-assigned identifier used to correlate an ask with its result.

Definition at line 38 of file types.hpp.

values

std::map<std::string, ParameterValue> pineforge::hpo::Candidate::values

Parameter values keyed by search-space dimension name.

Definition at line 41 of file types.hpp.

---

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

• types.hpp