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

#include <BootstrapCalculators.h>

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

Public Member Functions
virtual std::vector< OutType >	compute (const InType &, const bool) override
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

Detailed Description

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

Definition at line 87 of file BootstrapCalculators.h.

Member Function Documentation

compute()

template<typename InType , typename OutType >

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

overridevirtual

Implements StochasticTools::BootstrapCalculator< InType, OutType >.

Definition at line 25 of file BootstrapCalculators.C.

{
  // Bootstrap estimates
  const std::vector<OutType> values = this->computeBootstrapEstimates(data, is_distributed);

  // Extract percentiles
  std::vector<OutType> output;
  if (this->processor_id() == 0)
    for (const Real & level : this->_levels)
    {
      long unsigned int index = std::lrint(level * (this->_replicates - 1));
      output.push_back(values[index]);
    }

  return output;
}

computeBootstrapEstimates()

template<typename InType, typename OutType >

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

protectedinherited

Definition at line 157 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

inlineinherited

Definition at line 61 of file BootstrapCalculators.h.

{ return _name; }

Member Data Documentation

_calc

template<typename InType, typename OutType>

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

protectedinherited

Definition at line 77 of file BootstrapCalculators.h.

_levels

template<typename InType, typename OutType>

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

protectedinherited

Definition at line 68 of file BootstrapCalculators.h.

_replicates

template<typename InType, typename OutType>

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

protectedinherited

Definition at line 71 of file BootstrapCalculators.h.

_seed

template<typename InType, typename OutType>

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

protectedinherited

Definition at line 74 of file BootstrapCalculators.h.

---

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

• stochastic_tools/include/utils/BootstrapCalculators.h
• stochastic_tools/src/utils/BootstrapCalculators.C