Project
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
o2::rans::Metrics< source_T > Class Template Reference

#include <Metrics.h>

Public Types

using source_type = source_T
 

Public Member Functions

 Metrics ()=default
 
 Metrics (const DenseHistogram< source_type > &histogram, float_t cutoffPrecision=defaultCutoffPrecision)
 
 Metrics (const AdaptiveHistogram< source_type > &histogram, float_t cutoffPrecision=defaultCutoffPrecision)
 
 Metrics (const SparseHistogram< source_type > &histogram, float_t cutoffPrecision=defaultCutoffPrecision)
 
 Metrics (const DenseHistogram< source_type > &histogram, source_type min, source_type max, float_t cutoffPrecision=defaultCutoffPrecision)
 
 Metrics (const AdaptiveHistogram< source_type > &histogram, source_type min, source_type max, float_t cutoffPrecision=defaultCutoffPrecision)
 
 Metrics (const SparseHistogram< source_type > &histogram, source_type min, source_type max, float_t cutoffPrecision=defaultCutoffPrecision)
 
const DatasetProperties< source_type > & getDatasetProperties () const noexcept
 
const CoderProperties< source_type > & getCoderProperties () const noexcept
 
DatasetProperties< source_type > & getDatasetProperties () noexcept
 
CoderProperties< source_type > & getCoderProperties () noexcept
 
SizeEstimate getSizeEstimate () const noexcept
 

Protected Member Functions

template<typename histogram_T >
void init (const histogram_T &histogram, std::optional< source_type > min, std::optional< source_type > max, float_t cutoffPrecision)
 
template<typename histogram_T >
void computeMetrics (const histogram_T &histogram, std::optional< source_type > min, std::optional< source_type > max)
 
size_t computeRenormingPrecision (float_t cutoffPrecision) noexcept
 
size_t computeIncompressibleCount (gsl::span< uint32_t > distribution, uint32_t renormingPrecision) noexcept
 

Protected Attributes

DatasetProperties< source_type > mDatasetProperties {}
 
CoderProperties< source_type > mCoderProperties {}
 

Detailed Description

template<typename source_T>
class o2::rans::Metrics< source_T >

Definition at line 36 of file Metrics.h.

Member Typedef Documentation

◆ source_type

template<typename source_T >
using o2::rans::Metrics< source_T >::source_type = source_T

Definition at line 41 of file Metrics.h.

Constructor & Destructor Documentation

◆ Metrics() [1/7]

template<typename source_T >
o2::rans::Metrics< source_T >::Metrics ( )
default

◆ Metrics() [2/7]

template<typename source_T >
o2::rans::Metrics< source_T >::Metrics ( const DenseHistogram< source_type > &  histogram,
float_t  cutoffPrecision = defaultCutoffPrecision 
)
inline

Definition at line 44 of file Metrics.h.

◆ Metrics() [3/7]

template<typename source_T >
o2::rans::Metrics< source_T >::Metrics ( const AdaptiveHistogram< source_type > &  histogram,
float_t  cutoffPrecision = defaultCutoffPrecision 
)
inline

Definition at line 45 of file Metrics.h.

◆ Metrics() [4/7]

template<typename source_T >
o2::rans::Metrics< source_T >::Metrics ( const SparseHistogram< source_type > &  histogram,
float_t  cutoffPrecision = defaultCutoffPrecision 
)
inline

Definition at line 46 of file Metrics.h.

◆ Metrics() [5/7]

template<typename source_T >
o2::rans::Metrics< source_T >::Metrics ( const DenseHistogram< source_type > &  histogram,
source_type  min,
source_type  max,
float_t  cutoffPrecision = defaultCutoffPrecision 
)
inline

Definition at line 48 of file Metrics.h.

◆ Metrics() [6/7]

template<typename source_T >
o2::rans::Metrics< source_T >::Metrics ( const AdaptiveHistogram< source_type > &  histogram,
source_type  min,
source_type  max,
float_t  cutoffPrecision = defaultCutoffPrecision 
)
inline

Definition at line 49 of file Metrics.h.

◆ Metrics() [7/7]

template<typename source_T >
o2::rans::Metrics< source_T >::Metrics ( const SparseHistogram< source_type > &  histogram,
source_type  min,
source_type  max,
float_t  cutoffPrecision = defaultCutoffPrecision 
)
inline

Definition at line 50 of file Metrics.h.

Member Function Documentation

◆ computeIncompressibleCount()

template<typename source_T >
size_t o2::rans::Metrics< source_T >::computeIncompressibleCount ( gsl::span< uint32_t >  distribution,
uint32_t  renormingPrecision 
)
inlineprotectednoexcept

Definition at line 133 of file Metrics.h.

◆ computeMetrics()

template<typename source_T >
template<typename histogram_T >
void o2::rans::Metrics< source_T >::computeMetrics ( const histogram_T &  histogram,
std::optional< source_type >  min,
std::optional< source_type >  max 
)
protected

Definition at line 84 of file Metrics.h.

◆ computeRenormingPrecision()

template<typename source_T >
size_t o2::rans::Metrics< source_T >::computeRenormingPrecision ( float_t  cutoffPrecision)
inlineprotectednoexcept

Definition at line 148 of file Metrics.h.

◆ getCoderProperties() [1/2]

template<typename source_T >
const CoderProperties< source_type > & o2::rans::Metrics< source_T >::getCoderProperties ( ) const
inlinenoexcept

Definition at line 53 of file Metrics.h.

◆ getCoderProperties() [2/2]

template<typename source_T >
CoderProperties< source_type > & o2::rans::Metrics< source_T >::getCoderProperties ( )
inlinenoexcept

Definition at line 56 of file Metrics.h.

◆ getDatasetProperties() [1/2]

template<typename source_T >
const DatasetProperties< source_type > & o2::rans::Metrics< source_T >::getDatasetProperties ( ) const
inlinenoexcept

Definition at line 52 of file Metrics.h.

◆ getDatasetProperties() [2/2]

template<typename source_T >
DatasetProperties< source_type > & o2::rans::Metrics< source_T >::getDatasetProperties ( )
inlinenoexcept

Definition at line 55 of file Metrics.h.

◆ getSizeEstimate()

template<typename source_T >
SizeEstimate o2::rans::Metrics< source_T >::getSizeEstimate ( ) const
inlinenoexcept

Definition at line 57 of file Metrics.h.

◆ init()

template<typename source_T >
template<typename histogram_T >
void o2::rans::Metrics< source_T >::init ( const histogram_T &  histogram,
std::optional< source_type >  min,
std::optional< source_type >  max,
float_t  cutoffPrecision 
)
inlineprotected

Definition at line 74 of file Metrics.h.

Member Data Documentation

◆ mCoderProperties

template<typename source_T >
CoderProperties<source_type> o2::rans::Metrics< source_T >::mCoderProperties {}
protected

Definition at line 69 of file Metrics.h.

◆ mDatasetProperties

template<typename source_T >
DatasetProperties<source_type> o2::rans::Metrics< source_T >::mDatasetProperties {}
protected

Definition at line 68 of file Metrics.h.

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