SampleStack Class Reference

Collaboration diagram for SampleStack:

Public Types
using	PropertySetType = QMCTraits::PropertySetType

Public Member Functions
size_t	getMaxSamples () const
bool	empty () const
const MCSample &	getSample (size_t i) const
void	resetSampleCount ()
	Set the sample count to zero but preserve the storage. More...
size_t	getNumSamples () const
void	setMaxSamples (size_t n, size_t number_of_ranks=1)
	set the number of max samples per rank. More...
size_t	getGlobalNumSamples () const
	Global number of samples is number of samples per rank * number of ranks. More...
void	loadSample (ParticleSet &pset, size_t iw) const
	load a single sample from SampleStack More...
void	appendSample (MCSample &&sample)
void	clearEnsemble ()
	clear the ensemble More...

Private Attributes
size_t	max_samples_ {10}
size_t	current_sample_count_ {0}
size_t	global_num_samples_ {max_samples_}
std::vector< MCSample >	sample_vector_

Detailed Description

Definition at line 29 of file SampleStack.h.

Member Typedef Documentation

PropertySetType

using PropertySetType = QMCTraits::PropertySetType

Definition at line 32 of file SampleStack.h.

Member Function Documentation

appendSample()

void appendSample

(

MCSample &&

sample

)

Definition at line 33 of file SampleStack.cpp.

References SampleStack::current_sample_count_, SampleStack::max_samples_, and SampleStack::sample_vector_.

Referenced by VMCBatched::run(), MCWalkerConfiguration::saveEnsemble(), and qmcplusplus::TEST_CASE().

{
  // Ignore samples in excess of the expected number of samples
  if (current_sample_count_ < max_samples_)
  {
    sample_vector_[current_sample_count_] = std::move(sample);
    current_sample_count_++;
  }
}

clearEnsemble()

void clearEnsemble

(

)

clear the ensemble

Definition at line 51 of file SampleStack.cpp.

References SampleStack::current_sample_count_, and SampleStack::sample_vector_.

Referenced by MCWalkerConfiguration::clearEnsemble(), MCWalkerConfiguration::loadEnsemble(), MCWalkerConfiguration::MCWalkerConfiguration(), MCWalkerConfiguration::setNumSamples(), and qmcplusplus::TEST_CASE().

{
  sample_vector_.clear();
  current_sample_count_ = 0;
}

empty()

bool empty ( ) const

inline

Definition at line 36 of file SampleStack.h.

References SampleStack::sample_vector_.

Referenced by MCWalkerConfiguration::loadEnsemble().

{ return sample_vector_.empty(); }

getGlobalNumSamples()

size_t getGlobalNumSamples ( ) const

inline

Global number of samples is number of samples per rank * number of ranks.

Definition at line 45 of file SampleStack.h.

References SampleStack::global_num_samples_.

Referenced by QMCCostFunctionBatched::correlatedSampling(), and qmcplusplus::TEST_CASE().

{ return global_num_samples_; }

getMaxSamples()

size_t getMaxSamples ( ) const

inline

Definition at line 34 of file SampleStack.h.

References SampleStack::max_samples_.

Referenced by MCWalkerConfiguration::getMaxSamples(), MCWalkerConfiguration::loadEnsemble(), and qmcplusplus::TEST_CASE().

{ return max_samples_; }

getNumSamples()

size_t getNumSamples ( ) const

inline

Definition at line 41 of file SampleStack.h.

References SampleStack::current_sample_count_.

Referenced by QMCCostFunctionBatched::checkConfigurations(), QMCCostFunctionBatched::correlatedSampling(), QMCCostFunctionBatched::getConfigurations(), MCWalkerConfiguration::loadEnsemble(), MCWalkerConfiguration::numSamples(), and qmcplusplus::TEST_CASE().

{ return current_sample_count_; }

getSample()

const MCSample & getSample

(

size_t

i

)

const

Definition at line 31 of file SampleStack.cpp.

References SampleStack::sample_vector_.

Referenced by MCWalkerConfiguration::loadEnsemble(), and qmcplusplus::TEST_CASE().

{ return sample_vector_[i]; }

loadSample()

void loadSample	(	ParticleSet &	pset,
		size_t	iw
	)		const

load a single sample from SampleStack

Definition at line 45 of file SampleStack.cpp.

References qmcplusplus::pset, and SampleStack::sample_vector_.

Referenced by MCWalkerConfiguration::loadSample().

{
  pset.R     = sample_vector_[iw].R;
  pset.spins = sample_vector_[iw].spins;
}

resetSampleCount()

void resetSampleCount

(

)

Set the sample count to zero but preserve the storage.

Definition at line 57 of file SampleStack.cpp.

References SampleStack::current_sample_count_.

Referenced by QMCFixedSampleLinearOptimizeBatched::generateSamples(), and qmcplusplus::TEST_CASE().

{ current_sample_count_ = 0; }

setMaxSamples()

void setMaxSamples	(	size_t	n,
		size_t	num_ranks = 1
	)

set the number of max samples per rank.

allocate the SampleStack

Parameters

n	number of samples per rank
num_ranks	number of ranks. Used to set global number of samples.

Definition at line 23 of file SampleStack.cpp.

References SampleStack::current_sample_count_, SampleStack::global_num_samples_, SampleStack::max_samples_, omptarget::min(), qmcplusplus::n, qmcplusplus::num_ranks, and SampleStack::sample_vector_.

Referenced by VMCBatched::enable_sample_collection(), MCWalkerConfiguration::MCWalkerConfiguration(), MCWalkerConfiguration::setNumSamples(), and qmcplusplus::TEST_CASE().

{
  max_samples_        = n;
  global_num_samples_ = n * num_ranks;
  current_sample_count_ = std::min(current_sample_count_, max_samples_);
  sample_vector_.resize(n, MCSample(0));
}

Member Data Documentation

current_sample_count_

size_t current_sample_count_ {0}

private

Definition at line 59 of file SampleStack.h.

Referenced by SampleStack::appendSample(), SampleStack::clearEnsemble(), SampleStack::getNumSamples(), SampleStack::resetSampleCount(), and SampleStack::setMaxSamples().

global_num_samples_

size_t global_num_samples_ {max_samples_}

private

Definition at line 60 of file SampleStack.h.

Referenced by SampleStack::getGlobalNumSamples(), and SampleStack::setMaxSamples().

max_samples_

size_t max_samples_ {10}

private

Definition at line 58 of file SampleStack.h.

Referenced by SampleStack::appendSample(), SampleStack::getMaxSamples(), and SampleStack::setMaxSamples().

sample_vector_

std::vector<MCSample> sample_vector_

private

Definition at line 62 of file SampleStack.h.

Referenced by SampleStack::appendSample(), SampleStack::clearEnsemble(), SampleStack::empty(), SampleStack::getSample(), SampleStack::loadSample(), and SampleStack::setMaxSamples().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Particle/SampleStack.h
• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Particle/SampleStack.cpp