An internal struct parametrising the direct weight iteration method. More...

Public Attributes
double	C
	Magnitude of the weight update.

double	C_init
	Initial magnitude of the weight update.

double	C_min
	Minimum magnitude of the weight update.

string	finish_condition
	Determines the iteration condition for the iteration method.

int	sample_size
	Number of samples before weight function update.

int	single_check_interval
	Determines how often the update condition is checked for the case direct_iteration::sample_size = 1.

Detailed Description

An internal struct parametrising the direct weight iteration method.

Definition at line 90 of file multicanonical.cpp.

Member Data Documentation

◆ C

double direct_iteration::C

Magnitude of the weight update.

This entry is decreased through the direct iteration method until \( C < C_\mathrm{min}\) at which point the iteration is considered complete. The magnitude of the update is such that the mean weight modification is \(C\). That is, the update satisfies

\begin{equation}\sum_i \delta W_i = N C,\end{equation}

where \(N\). is the number of bins. For sample_size = 1 we simply add \( C \) to the single relevant bin each iteration.

Definition at line 97 of file multicanonical.cpp.

◆ C_init

double direct_iteration::C_init

Initial magnitude of the weight update.

Definition at line 95 of file multicanonical.cpp.

◆ C_min

double direct_iteration::C_min

Minimum magnitude of the weight update.

Definition at line 96 of file multicanonical.cpp.

◆ finish_condition

string direct_iteration::finish_condition

Determines the iteration condition for the iteration method.

Current options: "all_visited", "ends_visited". The weight modification factor \(C\) is decreased after set bins are visited. These can include e.g. all bins, or just the ends (the two preset options). Finishing conditions can also be determined by the user and passed to the methods through muca::direct_iteration_finish_condition(&func_pointer)

Definition at line 92 of file multicanonical.cpp.

◆ sample_size

int direct_iteration::sample_size

Number of samples before weight function update.

Definition at line 93 of file multicanonical.cpp.

◆ single_check_interval

int direct_iteration::single_check_interval

Determines how often the update condition is checked for the case direct_iteration::sample_size = 1.

Definition at line 94 of file multicanonical.cpp.

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

multicanonical.cpp

Public Attributes