Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
numeric::histograms::TwoDHistogram< key1, key2 > Class Template Reference

#include <TwoDHistogram.hh>

Public Member Functions

 TwoDHistogram ()=default
 
void increase_count (std::pair< key1, key2 > paired_keys)
 increase the counts of a histogram using paired keys More...
 
void increase_count (key1 key_1, key2 key_2)
 overflow function to increase count taking 2 keys to increment counts of histogram More...
 
void insert_data (key1 key_1, key2 key_2, platform::Size counts)
 insert data to the histogram More...
 
void insert_data (std::pair< key1, key2 > paired_keys, platform::Size counts)
 overload function to insert data to the histogram More...
 
platform::Size lookup_counts (key1 key_1, key2 key_2)
 look up data based upon your keys More...
 
platform::Size lookup_counts (std::pair< key1, key2 > paired_keys)
 overload function to lookup counts More...
 

Private Attributes

std::map< std::pair< key1,
key2 >, platform::Size
histogram_
 

Constructor & Destructor Documentation

template<typename key1 , typename key2 >
numeric::histograms::TwoDHistogram< key1, key2 >::TwoDHistogram ( )
default

Member Function Documentation

template<typename key1 , typename key2 >
void numeric::histograms::TwoDHistogram< key1, key2 >::increase_count ( std::pair< key1, key2 >  paired_keys)
inline

increase the counts of a histogram using paired keys

References numeric::histograms::TwoDHistogram< key1, key2 >::histogram_.

template<typename key1 , typename key2 >
void numeric::histograms::TwoDHistogram< key1, key2 >::increase_count ( key1  key_1,
key2  key_2 
)
inline

overflow function to increase count taking 2 keys to increment counts of histogram

References numeric::histograms::TwoDHistogram< key1, key2 >::histogram_.

template<typename key1 , typename key2 >
void numeric::histograms::TwoDHistogram< key1, key2 >::insert_data ( key1  key_1,
key2  key_2,
platform::Size  counts 
)
inline

insert data to the histogram

References numeric::histograms::TwoDHistogram< key1, key2 >::histogram_.

template<typename key1 , typename key2 >
void numeric::histograms::TwoDHistogram< key1, key2 >::insert_data ( std::pair< key1, key2 >  paired_keys,
platform::Size  counts 
)
inline

overload function to insert data to the histogram

References numeric::histograms::TwoDHistogram< key1, key2 >::histogram_.

template<typename key1 , typename key2 >
platform::Size numeric::histograms::TwoDHistogram< key1, key2 >::lookup_counts ( key1  key_1,
key2  key_2 
)
inline

look up data based upon your keys

References numeric::histograms::TwoDHistogram< key1, key2 >::histogram_.

template<typename key1 , typename key2 >
platform::Size numeric::histograms::TwoDHistogram< key1, key2 >::lookup_counts ( std::pair< key1, key2 >  paired_keys)
inline

overload function to lookup counts

References numeric::histograms::TwoDHistogram< key1, key2 >::histogram_.

Member Data Documentation

template<typename key1 , typename key2 >
std::map< std::pair< key1, key2>, platform::Size > numeric::histograms::TwoDHistogram< key1, key2 >::histogram_
private

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