pineforge::hpo::Sampler Class Reference

Minimal pull-based interface shared by candidate samplers. More...

#include <pineforge/hpo/sampler.hpp>

Inheritance diagram for pineforge::hpo::Sampler:

Public Member Functions
virtual	~Sampler ()=default
virtual std::optional< Candidate >	next ()=0
	Returns the next candidate, or std::nullopt when the configured budget is exhausted.
virtual void	reset ()=0
	Restores the sampler's seeded initial state.
virtual std::uint64_t	generated () const noexcept=0
	Returns the number of candidates issued since construction or the last reset.

Detailed Description

Minimal pull-based interface shared by candidate samplers.

Definition at line 14 of file sampler.hpp.

Constructor & Destructor Documentation

~Sampler()

virtual pineforge::hpo::Sampler::~Sampler ( )

virtualdefault

Member Function Documentation

generated()

virtual std::uint64_t pineforge::hpo::Sampler::generated ( ) const

pure virtualnoexcept

Returns the number of candidates issued since construction or the last reset.

Implemented in pineforge::hpo::GridSampler, pineforge::hpo::RandomSampler, pineforge::hpo::TpeSampler, and pineforge::hpo::DlibGlobalSampler.

next()

virtual std::optional< Candidate > pineforge::hpo::Sampler::next ( )

pure virtual

Returns the next candidate, or std::nullopt when the configured budget is exhausted.

Implemented in pineforge::hpo::GridSampler, pineforge::hpo::RandomSampler, pineforge::hpo::TpeSampler, and pineforge::hpo::DlibGlobalSampler.

reset()

virtual void pineforge::hpo::Sampler::reset ( )

pure virtual

Restores the sampler's seeded initial state.

Implemented in pineforge::hpo::GridSampler, pineforge::hpo::RandomSampler, pineforge::hpo::TpeSampler, and pineforge::hpo::DlibGlobalSampler.

---

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

• sampler.hpp