Developer documentation
Version 3.0.3-105-gd3941f44
MR::Math::Stats::Shuffler Class Reference

#include "math/stats/shuffle.h"

Public Types

enum class  error_t { EE , ISE , BOTH }
 
typedef vector< size_t > PermuteLabels
 

Public Member Functions

 Shuffler (const size_t num_rows, const bool is_nonstationarity, const std::string msg="")
 
 Shuffler (const size_t num_rows, const size_t num_shuffles, const error_t error_types, const bool is_nonstationarity, const std::string msg="")
 
 Shuffler (const size_t num_rows, const size_t num_shuffles, const error_t error_types, const bool is_nonstationarity, const index_array_type &eb_within, const index_array_type &eb_whole, const std::string msg="")
 
bool operator() (Shuffle &output)
 
size_t size () const
 
void reset ()
 

Detailed Description

Definition at line 63 of file shuffle.h.

Member Typedef Documentation

◆ PermuteLabels

Definition at line 66 of file shuffle.h.

Member Enumeration Documentation

◆ error_t

Enumerator
EE 
ISE 
BOTH 

Definition at line 67 of file shuffle.h.

Constructor & Destructor Documentation

◆ Shuffler() [1/3]

MR::Math::Stats::Shuffler::Shuffler ( const size_t  num_rows,
const bool  is_nonstationarity,
const std::string  msg = "" 
)

◆ Shuffler() [2/3]

MR::Math::Stats::Shuffler::Shuffler ( const size_t  num_rows,
const size_t  num_shuffles,
const error_t  error_types,
const bool  is_nonstationarity,
const std::string  msg = "" 
)

◆ Shuffler() [3/3]

MR::Math::Stats::Shuffler::Shuffler ( const size_t  num_rows,
const size_t  num_shuffles,
const error_t  error_types,
const bool  is_nonstationarity,
const index_array_type eb_within,
const index_array_type eb_whole,
const std::string  msg = "" 
)

Member Function Documentation

◆ operator()()

bool MR::Math::Stats::Shuffler::operator() ( Shuffle output)

◆ reset()

void MR::Math::Stats::Shuffler::reset ( )

◆ size()

size_t MR::Math::Stats::Shuffler::size ( ) const
inline

Definition at line 93 of file shuffle.h.


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