StochasticTools::BootstrapCalculator< InType, OutType > Class Template Reference

Base class for computing bootstrap confidence level intervals. More...

#include <BootstrapCalculators.h>

Inheritance diagram for StochasticTools::BootstrapCalculator< InType, OutType >:

Public Member Functions
	BootstrapCalculator (const libMesh::ParallelObject &other, const std::string &name, const std::vector< Real > &levels, unsigned int replicates, unsigned int seed, StochasticTools::Calculator< InType, OutType > &calc)
virtual std::vector< OutType >	compute (const InType &, const bool)=0
const std::string &	name () const
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () const

Protected Member Functions
std::vector< OutType >	computeBootstrapEstimates (const InType &, const bool)

Protected Attributes
const std::vector< Real >	_levels
const unsigned int	_replicates
const unsigned int	_seed
StochasticTools::Calculator< InType, OutType > &	_calc
const Parallel::Communicator &	_communicator

Private Attributes
const std::string	_name

Detailed Description

template<typename InType, typename OutType>
class StochasticTools::BootstrapCalculator< InType, OutType >

Base class for computing bootstrap confidence level intervals.

These classes follow the same design pattern as those Statistics.h.

Parameters

other	ParallelObject that is providing the Communicator
levels	The bootstrap confidence level intervals to compute in range (0, 1)
replicates	Number of bootstrap replicates to perform
seed	Seed for random number generator

Definition at line 52 of file BootstrapCalculators.h.

Constructor & Destructor Documentation

BootstrapCalculator()

template<typename InType, typename OutType>

StochasticTools::BootstrapCalculator< InType, OutType >::BootstrapCalculator	(	const libMesh::ParallelObject &	other,
		const std::string &	name,
		const std::vector< Real > &	levels,
		unsigned int	replicates,
		unsigned int	seed,
		StochasticTools::Calculator< InType, OutType > &	calc
	)

Definition at line 136 of file BootstrapCalculators.h.

  : libMesh::ParallelObject(other),
    _levels(levels),
    _replicates(replicates),
    _seed(seed),
    _calc(calc),
    _name(name)
{
  mooseAssert(*std::min_element(levels.begin(), levels.end()) > 0,
              "The supplied levels must be greater than zero.");
  mooseAssert(*std::max_element(levels.begin(), levels.end()) < 1,
              "The supplied levels must be less than one");
}

Member Function Documentation

compute()

template<typename InType, typename OutType>

virtual std::vector<OutType> StochasticTools::BootstrapCalculator< InType, OutType >::compute ( const InType &  , const bool    )

pure virtual

Implemented in StochasticTools::BiasCorrectedAccelerated< InType, OutType >, StochasticTools::BiasCorrectedAccelerated< std::vector< InType >, std::vector< OutType > >, StochasticTools::Percentile< InType, OutType >, and StochasticTools::Percentile< std::vector< InType >, std::vector< OutType > >.

computeBootstrapEstimates()

template<typename InType, typename OutType >

std::vector< OutType > StochasticTools::BootstrapCalculator< InType, OutType >::computeBootstrapEstimates ( const InType &  data, const bool  is_distributed  )

protected

Definition at line 158 of file BootstrapCalculators.h.

{
  MooseRandom generator;
  generator.seed(0, _seed);

  // Compute replicate statistics
  std::vector<OutType> values(_replicates);
  auto calc_update = [this](const typename InType::value_type & val)
  { _calc.updateCalculator(val); };
  for (std::size_t i = 0; i < _replicates; ++i)
  {
    _calc.initializeCalculator();
    MooseUtils::resampleWithFunctor(
        data, calc_update, generator, 0, is_distributed ? &this->_communicator : nullptr);
    _calc.finalizeCalculator(is_distributed);
    values[i] = _calc.getValue();
  }
  inplaceSort(values);
  return values;
}

name()

template<typename InType, typename OutType>

const std::string& StochasticTools::BootstrapCalculator< InType, OutType >::name ( ) const

inline

Definition at line 62 of file BootstrapCalculators.h.

{ return _name; }

Member Data Documentation

_calc

template<typename InType, typename OutType>

StochasticTools::Calculator<InType, OutType>& StochasticTools::BootstrapCalculator< InType, OutType >::_calc

protected

Definition at line 78 of file BootstrapCalculators.h.

_levels

template<typename InType, typename OutType>

const std::vector<Real> StochasticTools::BootstrapCalculator< InType, OutType >::_levels

protected

Definition at line 69 of file BootstrapCalculators.h.

_name

template<typename InType, typename OutType>

const std::string StochasticTools::BootstrapCalculator< InType, OutType >::_name

private

Definition at line 81 of file BootstrapCalculators.h.

Referenced by StochasticTools::BootstrapCalculator< std::vector< std::vector< InType > >, std::vector< std::vector< OutType > > >::name().

_replicates

template<typename InType, typename OutType>

const unsigned int StochasticTools::BootstrapCalculator< InType, OutType >::_replicates

protected

Definition at line 72 of file BootstrapCalculators.h.

_seed

template<typename InType, typename OutType>

const unsigned int StochasticTools::BootstrapCalculator< InType, OutType >::_seed

protected

Definition at line 75 of file BootstrapCalculators.h.

---

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

• stochastic_tools/include/utils/BootstrapCalculators.h