Class for executing simulated annealing. More...

#include <sa_sampler.hpp>

Public Member Functions
	SASampler (const ModelType &model)
	Constructor for SASampler class.

void	SetNumSweeps (const std::int32_t num_sweeps)
	Set the number of sweeps.

void	SetNumReads (const std::int32_t num_reads)
	Set the number of samples.

void	SetNumThreads (const std::int32_t num_threads)
	Set the number of threads in the calculation.

void	SetBetaMin (const ValueType beta_min)
	Set the minimum inverse temperature.

void	SetBetaMax (const ValueType beta_max)
	Set the minimum inverse temperature.

void	SetBetaMinAuto ()
	Set the minimum inverse temperature automatically.

void	SetBetaMaxAuto ()
	Set the maximum inverse temperature automatically.

void	SetUpdateMethod (const algorithm::UpdateMethod update_method)
	Set update method used in the state update.

void	SetRandomNumberEngine (const algorithm::RandomNumberEngine random_number_engine)
	Set random number engine for updating initializing state.

void	SetTemperatureSchedule (const utility::TemperatureSchedule schedule)
	Set the cooling schedule.

const ModelType &	GetModel () const
	Get the model.

std::int32_t	GetNumSweeps () const
	Get the number of sweeps.

std::int32_t	GetNumReads () const
	Get the number of reads.

std::int32_t	GetNumThreads () const
	Get the number of threads.

ValueType	GetBetaMin () const
	Get the minimum inverse temperature.

ValueType	GetBetaMax () const
	Get the maximum inverse temperature.

algorithm::UpdateMethod	GetUpdateMethod () const
	Get the update method used in the state update.

algorithm::RandomNumberEngine	GetRandomNumberEngine () const
	Get the random number engine for updating and initializing state.

utility::TemperatureSchedule	GetTemperatureSchedule () const
	Get the temperature schedule.

std::uint64_t	GetSeed () const
	Get the seed to be used in the calculation.

const std::vector< typename ModelType::IndexType > &	GetIndexList () const

const std::vector< std::vector< VariableType > > &	GetSamples () const
	Get the samples.

std::vector< ValueType >	CalculateEnergies () const

void	Sample ()
	Execute sampling.

void	Sample (const std::uint64_t seed)
	Execute sampling.

Private Types
using	ValueType = typename ModelType::ValueType
	The value type.

using	VariableType = typename ModelType::VariableType
	The variable type.

Private Member Functions
template<typename RandType >
std::vector< std::pair< typename RandType::result_type, typename RandType::result_type > >	GenerateSeedPairList (const typename RandType::result_type seed, const std::int32_t num_reads) const

template<class SystemType , class RandType >
void	TemplateSampler ()

Private Attributes
const ModelType	model_
	The model.

std::int32_t	num_sweeps_ = 1000
	The number of sweeps.

std::int32_t	num_reads_ = 1
	The number of reads (samples).

std::int32_t	num_threads_ = 1
	The number of threads in the calculation.

ValueType	beta_min_ = 1
	The start inverse temperature.

ValueType	beta_max_ = 1
	The end inverse temperature.

algorithm::UpdateMethod	update_method_ = algorithm::UpdateMethod::METROPOLIS
	The update method used in the state update.

algorithm::RandomNumberEngine	random_number_engine_ = algorithm::RandomNumberEngine::XORSHIFT
	Random number engine for updating and initializing state.

utility::TemperatureSchedule	schedule_ = utility::TemperatureSchedule::GEOMETRIC
	Cooling schedule.

std::uint64_t	seed_ = std::random_device()()
	The seed to be used in the calculation.

std::vector< std::vector< VariableType > >	samples_
	The samples.

Detailed Description

template<class ModelType>
class openjij::sampler::SASampler< ModelType >

Class for executing simulated annealing.

Template Parameters

ModelType The type of models.

Member Typedef Documentation

◆ ValueType

template<class ModelType >

using openjij::sampler::SASampler< ModelType >::ValueType = typename ModelType::ValueType

private

The value type.

◆ VariableType

template<class ModelType >

using openjij::sampler::SASampler< ModelType >::VariableType = typename ModelType::VariableType

private

The variable type.

Constructor & Destructor Documentation

◆ SASampler()

template<class ModelType >

openjij::sampler::SASampler< ModelType >::SASampler ( const ModelType & model )

inline

Constructor for SASampler class.

Parameters

model The model.

Member Function Documentation

◆ CalculateEnergies()

template<class ModelType >

std::vector< ValueType > openjij::sampler::SASampler< ModelType >::CalculateEnergies ( ) const

inline

References openjij::sampler::SASampler< ModelType >::model_, openjij::sampler::SASampler< ModelType >::num_reads_, and openjij::sampler::SASampler< ModelType >::samples_.

◆ GenerateSeedPairList()

template<class ModelType >

template<typename RandType >

std::vector< std::pair< typename RandType::result_type, typename RandType::result_type > > openjij::sampler::SASampler< ModelType >::GenerateSeedPairList	(	const typename RandType::result_type	seed,
		const std::int32_t	num_reads
	)		const

inlineprivate

◆ GetBetaMax()

template<class ModelType >

ValueType openjij::sampler::SASampler< ModelType >::GetBetaMax ( ) const

inline

Get the maximum inverse temperature.

Returns: The maximum inverse temperature.

References openjij::sampler::SASampler< ModelType >::beta_max_.

◆ GetBetaMin()

template<class ModelType >

ValueType openjij::sampler::SASampler< ModelType >::GetBetaMin ( ) const

inline

Get the minimum inverse temperature.

Returns: The minimum inverse temperature.

References openjij::sampler::SASampler< ModelType >::beta_min_.

◆ GetIndexList()

template<class ModelType >

const std::vector< typename ModelType::IndexType > & openjij::sampler::SASampler< ModelType >::GetIndexList ( ) const

inline

References openjij::sampler::SASampler< ModelType >::model_.

◆ GetModel()

template<class ModelType >

const ModelType & openjij::sampler::SASampler< ModelType >::GetModel ( ) const

inline

Get the model.

Returns: The model.

References openjij::sampler::SASampler< ModelType >::model_.

◆ GetNumReads()

template<class ModelType >

std::int32_t openjij::sampler::SASampler< ModelType >::GetNumReads ( ) const

inline

Get the number of reads.

Returns: The number of reads.

References openjij::sampler::SASampler< ModelType >::num_reads_.

◆ GetNumSweeps()

template<class ModelType >

std::int32_t openjij::sampler::SASampler< ModelType >::GetNumSweeps ( ) const

inline

Get the number of sweeps.

Returns: The number of sweeps.

References openjij::sampler::SASampler< ModelType >::num_sweeps_.

◆ GetNumThreads()

template<class ModelType >

std::int32_t openjij::sampler::SASampler< ModelType >::GetNumThreads ( ) const

inline

Get the number of threads.

Returns: The number of threads.

References openjij::sampler::SASampler< ModelType >::num_threads_.

◆ GetRandomNumberEngine()

template<class ModelType >

algorithm::RandomNumberEngine openjij::sampler::SASampler< ModelType >::GetRandomNumberEngine ( ) const

inline

Get the random number engine for updating and initializing state.

Returns: The random number engine for updating and initializing state.

References openjij::sampler::SASampler< ModelType >::random_number_engine_.

◆ GetSamples()

template<class ModelType >

const std::vector< std::vector< VariableType > > & openjij::sampler::SASampler< ModelType >::GetSamples ( ) const

inline

Get the samples.

Returns: The samples.

References openjij::sampler::SASampler< ModelType >::samples_.

◆ GetSeed()

template<class ModelType >

std::uint64_t openjij::sampler::SASampler< ModelType >::GetSeed ( ) const

inline

Get the seed to be used in the calculation.

Returns: The seed.

References openjij::sampler::SASampler< ModelType >::seed_.

◆ GetTemperatureSchedule()

template<class ModelType >

utility::TemperatureSchedule openjij::sampler::SASampler< ModelType >::GetTemperatureSchedule ( ) const

inline

Get the temperature schedule.

Returns: The temperature schedule.

References openjij::sampler::SASampler< ModelType >::schedule_.

◆ GetUpdateMethod()

template<class ModelType >

algorithm::UpdateMethod openjij::sampler::SASampler< ModelType >::GetUpdateMethod ( ) const

inline

Get the update method used in the state update.

Returns: The update method used in the state update.

References openjij::sampler::SASampler< ModelType >::update_method_.

◆ Sample() [1/2]

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::Sample ( )

inline

Execute sampling.

Seed to be used in the calculation will be set automatically.

References openjij::sampler::SASampler< ModelType >::Sample().

Referenced by openjij::sampler::SASampler< ModelType >::Sample().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Sample() [2/2]

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::Sample ( const std::uint64_t seed )

inline

Execute sampling.

Parameters

seed	The seed to be used in the calculation.

References openjij::algorithm::MT, openjij::algorithm::MT_64, openjij::sampler::SASampler< ModelType >::num_reads_, openjij::sampler::SASampler< ModelType >::random_number_engine_, openjij::sampler::SASampler< ModelType >::samples_, openjij::sampler::SASampler< ModelType >::seed_, and openjij::algorithm::XORSHIFT.

◆ SetBetaMax()

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::SetBetaMax ( const ValueType beta_max )

inline

Set the minimum inverse temperature.

Parameters

beta_max The minimum inverse temperature, which must be larger than zero.

References openjij::sampler::SASampler< ModelType >::beta_max_.

◆ SetBetaMaxAuto()

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::SetBetaMaxAuto ( )

inline

Set the maximum inverse temperature automatically.

References openjij::sampler::SASampler< ModelType >::beta_max_, and openjij::sampler::SASampler< ModelType >::model_.

◆ SetBetaMin()

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::SetBetaMin ( const ValueType beta_min )

inline

Set the minimum inverse temperature.

Parameters

beta_min The minimum inverse temperature, which must be larger than zero.

References openjij::sampler::SASampler< ModelType >::beta_min_.

◆ SetBetaMinAuto()

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::SetBetaMinAuto ( )

inline

Set the minimum inverse temperature automatically.

References openjij::sampler::SASampler< ModelType >::beta_min_, and openjij::sampler::SASampler< ModelType >::model_.

◆ SetNumReads()

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::SetNumReads ( const std::int32_t num_reads )

inline

Set the number of samples.

Parameters

num_reads The number of samples, which must be larger than zero.

References openjij::sampler::SASampler< ModelType >::num_reads_.

◆ SetNumSweeps()

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::SetNumSweeps ( const std::int32_t num_sweeps )

inline

Set the number of sweeps.

Parameters

num_sweeps The number of sweeps, which must be larger than zero.

References openjij::sampler::SASampler< ModelType >::num_sweeps_.

◆ SetNumThreads()

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::SetNumThreads ( const std::int32_t num_threads )

inline

Set the number of threads in the calculation.

Parameters

num_threads The number of threads in the calculation, which must be larger than zero.

References openjij::sampler::SASampler< ModelType >::num_threads_.

◆ SetRandomNumberEngine()

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::SetRandomNumberEngine ( const algorithm::RandomNumberEngine random_number_engine )

inline

Set random number engine for updating initializing state.

Parameters

random_number_engine The random number engine.

References openjij::sampler::SASampler< ModelType >::random_number_engine_.

◆ SetTemperatureSchedule()

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::SetTemperatureSchedule ( const utility::TemperatureSchedule schedule )

inline

Set the cooling schedule.

Parameters

schedule The cooling schedule.

References openjij::sampler::SASampler< ModelType >::schedule_.

◆ SetUpdateMethod()

template<class ModelType >

void openjij::sampler::SASampler< ModelType >::SetUpdateMethod ( const algorithm::UpdateMethod update_method )

inline

Set update method used in the state update.

Parameters

update_method The update method.

References openjij::sampler::SASampler< ModelType >::update_method_.

◆ TemplateSampler()

template<class ModelType >

template<class SystemType , class RandType >

void openjij::sampler::SASampler< ModelType >::TemplateSampler ( )

inlineprivate

Here is the call graph for this function:

Member Data Documentation

◆ beta_max_

template<class ModelType >

ValueType openjij::sampler::SASampler< ModelType >::beta_max_ = 1

private

The end inverse temperature.

Referenced by openjij::sampler::SASampler< ModelType >::GetBetaMax(), openjij::sampler::SASampler< ModelType >::SetBetaMax(), openjij::sampler::SASampler< ModelType >::SetBetaMaxAuto(), and openjij::sampler::SASampler< ModelType >::TemplateSampler().

◆ beta_min_

template<class ModelType >

ValueType openjij::sampler::SASampler< ModelType >::beta_min_ = 1

private

The start inverse temperature.

Referenced by openjij::sampler::SASampler< ModelType >::GetBetaMin(), openjij::sampler::SASampler< ModelType >::SetBetaMin(), openjij::sampler::SASampler< ModelType >::SetBetaMinAuto(), and openjij::sampler::SASampler< ModelType >::TemplateSampler().

◆ model_

template<class ModelType >

const ModelType openjij::sampler::SASampler< ModelType >::model_

private

The model.

Referenced by openjij::sampler::SASampler< ModelType >::CalculateEnergies(), openjij::sampler::SASampler< ModelType >::GetIndexList(), openjij::sampler::SASampler< ModelType >::GetModel(), openjij::sampler::SASampler< ModelType >::SetBetaMaxAuto(), openjij::sampler::SASampler< ModelType >::SetBetaMinAuto(), and openjij::sampler::SASampler< ModelType >::TemplateSampler().

◆ num_reads_

template<class ModelType >

std::int32_t openjij::sampler::SASampler< ModelType >::num_reads_ = 1

private

The number of reads (samples).

Referenced by openjij::sampler::SASampler< ModelType >::CalculateEnergies(), openjij::sampler::SASampler< ModelType >::GetNumReads(), openjij::sampler::SASampler< ModelType >::Sample(), openjij::sampler::SASampler< ModelType >::SetNumReads(), and openjij::sampler::SASampler< ModelType >::TemplateSampler().

◆ num_sweeps_

template<class ModelType >

std::int32_t openjij::sampler::SASampler< ModelType >::num_sweeps_ = 1000

private

The number of sweeps.

Referenced by openjij::sampler::SASampler< ModelType >::GetNumSweeps(), openjij::sampler::SASampler< ModelType >::SetNumSweeps(), and openjij::sampler::SASampler< ModelType >::TemplateSampler().

◆ num_threads_

template<class ModelType >

std::int32_t openjij::sampler::SASampler< ModelType >::num_threads_ = 1

private

The number of threads in the calculation.

Referenced by openjij::sampler::SASampler< ModelType >::GetNumThreads(), and openjij::sampler::SASampler< ModelType >::SetNumThreads().

◆ random_number_engine_

template<class ModelType >

algorithm::RandomNumberEngine openjij::sampler::SASampler< ModelType >::random_number_engine_ = algorithm::RandomNumberEngine::XORSHIFT

private

Random number engine for updating and initializing state.

Referenced by openjij::sampler::SASampler< ModelType >::GetRandomNumberEngine(), openjij::sampler::SASampler< ModelType >::Sample(), and openjij::sampler::SASampler< ModelType >::SetRandomNumberEngine().

◆ samples_

template<class ModelType >

std::vector<std::vector<VariableType> > openjij::sampler::SASampler< ModelType >::samples_

private

The samples.

Referenced by openjij::sampler::SASampler< ModelType >::CalculateEnergies(), openjij::sampler::SASampler< ModelType >::GetSamples(), openjij::sampler::SASampler< ModelType >::Sample(), and openjij::sampler::SASampler< ModelType >::TemplateSampler().

◆ schedule_

template<class ModelType >

utility::TemperatureSchedule openjij::sampler::SASampler< ModelType >::schedule_ = utility::TemperatureSchedule::GEOMETRIC

private

Cooling schedule.

Referenced by openjij::sampler::SASampler< ModelType >::GetTemperatureSchedule(), openjij::sampler::SASampler< ModelType >::SetTemperatureSchedule(), and openjij::sampler::SASampler< ModelType >::TemplateSampler().

◆ seed_

template<class ModelType >

std::uint64_t openjij::sampler::SASampler< ModelType >::seed_ = std::random_device()()

private

The seed to be used in the calculation.

Referenced by openjij::sampler::SASampler< ModelType >::GetSeed(), openjij::sampler::SASampler< ModelType >::Sample(), and openjij::sampler::SASampler< ModelType >::TemplateSampler().

◆ update_method_

template<class ModelType >

algorithm::UpdateMethod openjij::sampler::SASampler< ModelType >::update_method_ = algorithm::UpdateMethod::METROPOLIS

private

The update method used in the state update.

Referenced by openjij::sampler::SASampler< ModelType >::GetUpdateMethod(), openjij::sampler::SASampler< ModelType >::SetUpdateMethod(), and openjij::sampler::SASampler< ModelType >::TemplateSampler().

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

sa_sampler.hpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ValueType

◆ VariableType

Constructor & Destructor Documentation

◆ SASampler()

Member Function Documentation

◆ CalculateEnergies()

◆ GenerateSeedPairList()

◆ GetBetaMax()

◆ GetBetaMin()

◆ GetIndexList()

◆ GetModel()

◆ GetNumReads()

◆ GetNumSweeps()

◆ GetNumThreads()

◆ GetRandomNumberEngine()

◆ GetSamples()

◆ GetSeed()

◆ GetTemperatureSchedule()

◆ GetUpdateMethod()

◆ Sample() [1/2]

◆ Sample() [2/2]

◆ SetBetaMax()

◆ SetBetaMaxAuto()

◆ SetBetaMin()

◆ SetBetaMinAuto()

◆ SetNumReads()

◆ SetNumSweeps()

◆ SetNumThreads()

◆ SetRandomNumberEngine()

◆ SetTemperatureSchedule()

◆ SetUpdateMethod()

◆ TemplateSampler()

Member Data Documentation

◆ beta_max_

◆ beta_min_

◆ model_

◆ num_reads_

◆ num_sweeps_

◆ num_threads_

◆ random_number_engine_

◆ samples_

◆ schedule_

◆ seed_

◆ update_method_