barry: Your go-to motif accountant  0.0-1
Full enumeration of sample space and fast count of sufficient statistics for binary arrays
Rule< Array_Type, Data_Type > Class Template Reference

Rule for determining if a cell should be included in a sequence. More...

#include <rules-bones.hpp>

Public Member Functions

 ~Rule ()
 
Data_Type & D ()
 Read/Write access to the data. More...
 
bool operator() (const Array_Type &a, size_t i, size_t j)
 
std::string & get_name ()
 
std::string & get_description ()
 
std::string get_name () const
 
std::string get_description () const
 
Construct a new Rule object

Construct a new Rule object

Parameters
fun_A function of type Rule_fun_type.
dat_Data pointer to be passed to fun_
delete_dat_When true, the Rule destructor will delete the pointer, if defined.
 Rule ()
 
 Rule (Rule_fun_type< Array_Type, Data_Type > fun_, Data_Type dat_, std::string name_="", std::string desc_="")
 

Detailed Description

template<typename Array_Type = BArray<>, typename Data_Type = bool>
class Rule< Array_Type, Data_Type >

Rule for determining if a cell should be included in a sequence.

Rules can be used together with Support and PowerSet to determine which cells should be included when enumerating all possible realizations of a binary array.

Template Parameters
Array_TypeAn object of class BArray.
Data_TypeAny type.

Definition at line 20 of file rules-bones.hpp.

Constructor & Destructor Documentation

◆ Rule() [1/2]

template<typename Array_Type = BArray<>, typename Data_Type = bool>
Rule< Array_Type, Data_Type >::Rule ( )
inline

Definition at line 41 of file rules-bones.hpp.

◆ Rule() [2/2]

template<typename Array_Type = BArray<>, typename Data_Type = bool>
Rule< Array_Type, Data_Type >::Rule ( Rule_fun_type< Array_Type, Data_Type >  fun_,
Data_Type  dat_,
std::string  name_ = "",
std::string  desc_ = "" 
)
inline

Definition at line 42 of file rules-bones.hpp.

◆ ~Rule()

template<typename Array_Type = BArray<>, typename Data_Type = bool>
Rule< Array_Type, Data_Type >::~Rule ( )
inline

Definition at line 50 of file rules-bones.hpp.

Member Function Documentation

◆ D()

template<typename Array_Type , typename Data_Type >
Data_Type & Rule< Array_Type, Data_Type >::D
inline

Read/Write access to the data.

Definition at line 37 of file rules-meat.hpp.

◆ get_description() [1/2]

template<typename Array_Type , typename Data_Type >
std::string & Rule< Array_Type, Data_Type >::get_description
inline

Definition at line 54 of file rules-meat.hpp.

◆ get_description() [2/2]

template<typename Array_Type , typename Data_Type >
std::string Rule< Array_Type, Data_Type >::get_description
inline

Definition at line 66 of file rules-meat.hpp.

◆ get_name() [1/2]

template<typename Array_Type , typename Data_Type >
std::string & Rule< Array_Type, Data_Type >::get_name
inline

Definition at line 48 of file rules-meat.hpp.

◆ get_name() [2/2]

template<typename Array_Type , typename Data_Type >
std::string Rule< Array_Type, Data_Type >::get_name
inline

Definition at line 60 of file rules-meat.hpp.

◆ operator()()

template<typename Array_Type , typename Data_Type >
bool Rule< Array_Type, Data_Type >::operator() ( const Array_Type &  a,
size_t  i,
size_t  j 
)
inline

Definition at line 43 of file rules-meat.hpp.


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