MCKL
Monte Carlo Kernel Library
Public Member Functions | List of all members
mckl::PermutationTest< T > Class Template Reference

Permutation test. More...

#include <mckl/random/permutation_test.hpp>

Inherits mckl::ChiSquaredTest< PermutationTest< T > >.

Public Member Functions

 PermutationTest (std::size_t n)
 Construct a Permutation test. More...
 
double degree_of_freedom () const
 
template<typename DistributionType >
double operator() (DistributionType &&distribution)
 
template<typename RNGType , typename DistributionType >
double operator() (RNGType &rng, DistributionType &distribution)
 
- Public Member Functions inherited from mckl::ChiSquaredTest< PermutationTest< T > >
double cdf (result_type s) const
 
bool pass (double alpha, result_type s) const
 
double pdf (result_type s) const
 

Additional Inherited Members

- Public Types inherited from mckl::ChiSquaredTest< PermutationTest< T > >
using result_type = double
 
- Protected Member Functions inherited from mckl::ChiSquaredTest< PermutationTest< T > >
double stat (std::size_t m, const double *count, const double *np) const
 
double stat (std::size_t m, const double *count, double np) const
 

Detailed Description

template<std::size_t T>
class mckl::PermutationTest< T >

Permutation test.

Template Parameters
TLength of the tuple

Definition at line 45 of file permutation_test.hpp.

Constructor & Destructor Documentation

◆ PermutationTest()

template<std::size_t T>
mckl::PermutationTest< T >::PermutationTest ( std::size_t  n)
inline

Construct a Permutation test.

Parameters
nThe number of tuples

Definition at line 55 of file permutation_test.hpp.

Member Function Documentation

◆ degree_of_freedom()

template<std::size_t T>
double mckl::PermutationTest< T >::degree_of_freedom ( ) const
inline

Definition at line 73 of file permutation_test.hpp.

◆ operator()() [1/2]

template<std::size_t T>
template<typename DistributionType >
double mckl::PermutationTest< T >::operator() ( DistributionType &&  distribution)
inline

Definition at line 57 of file permutation_test.hpp.

◆ operator()() [2/2]

template<std::size_t T>
template<typename RNGType , typename DistributionType >
double mckl::PermutationTest< T >::operator() ( RNGType &  rng,
DistributionType &  distribution 
)
inline

Definition at line 60 of file permutation_test.hpp.