CbmRoot
Loading...
Searching...
No Matches
cbm::qa::checker::Result Class Reference

A storable result of the QA-checker comparison routine. More...

#include <CbmQaCheckerResult.h>

Inheritance diagram for cbm::qa::checker::Result:
[legend]
Collaboration diagram for cbm::qa::checker::Result:
[legend]

Public Member Functions

 Result ()=default
 Default constructor.
 
 Result (const Result &)=default
 Copy constructor.
 
 Result (Result &&)=default
 Move construction.
 
 Result (ECmpInference inference, bool exactEqual, double ratioMin, double ratioMax, double pVal)
 Constructor from parameters.
 
 ~Result ()=default
 Destructor.
 
Resultoperator= (const Result &)=default
 Copy assignment operator.
 
Resultoperator= (Result &&)=default
 Move assignment operator.
 
double GetRatioMin () const
 
double GetRatioMax () const
 
double GetPVal () const
 
bool GetExactEqual () const
 
ECmpInference GetCmpInference () const
 
void SetRatioMin (double ratioMin)
 
void SetRatioMax (double ratioMax)
 
void SetPVal (double pVal)
 
void SetExactEqual (bool exactEqual)
 
void SetCmpInference (ECmpInference inference)
 
 ClassDef (Result, 1)
 

Private Attributes

double fRatioMin {std::numeric_limits<double>::quiet_NaN()}
 Minimal value of ratio.
 
double fRatioMax {std::numeric_limits<double>::quiet_NaN()}
 Maximal value of ratio.
 
double fPval {std::numeric_limits<double>::quiet_NaN()}
 Comparison p-value.
 
bool fbExactEqual {true}
 Result of exact comparison.
 
ECmpInference fCmpInference {ECmpInference::Different}
 Comparison inference.
 

Detailed Description

A storable result of the QA-checker comparison routine.

Definition at line 25 of file CbmQaCheckerResult.h.

Constructor & Destructor Documentation

◆ Result() [1/4]

cbm::qa::checker::Result::Result ( )
default

Default constructor.

Referenced by ClassDef(), operator=(), operator=(), Result(), and Result().

◆ Result() [2/4]

cbm::qa::checker::Result::Result ( const Result & )
default

Copy constructor.

References Result().

◆ Result() [3/4]

cbm::qa::checker::Result::Result ( Result && )
default

Move construction.

References Result().

◆ Result() [4/4]

cbm::qa::checker::Result::Result ( ECmpInference inference,
bool exactEqual,
double ratioMin,
double ratioMax,
double pVal )
inline

Constructor from parameters.

Parameters
inferenceComparison inference
exactEqualIf the histogram exactly equal
ratioMinMinimal ratio to default
ratioMaxMaximal ratio to default
pValP-value

Definition at line 50 of file CbmQaCheckerResult.h.

References fbExactEqual, fCmpInference, fPval, fRatioMax, and fRatioMin.

◆ ~Result()

cbm::qa::checker::Result::~Result ( )
default

Destructor.

Member Function Documentation

◆ ClassDef()

cbm::qa::checker::Result::ClassDef ( Result ,
1  )

References Result().

◆ GetCmpInference()

ECmpInference cbm::qa::checker::Result::GetCmpInference ( ) const
inline

Definition at line 89 of file CbmQaCheckerResult.h.

References fCmpInference.

◆ GetExactEqual()

bool cbm::qa::checker::Result::GetExactEqual ( ) const
inline

Definition at line 87 of file CbmQaCheckerResult.h.

References fbExactEqual.

◆ GetPVal()

double cbm::qa::checker::Result::GetPVal ( ) const
inline

Definition at line 85 of file CbmQaCheckerResult.h.

References fPval.

◆ GetRatioMax()

double cbm::qa::checker::Result::GetRatioMax ( ) const
inline

Definition at line 83 of file CbmQaCheckerResult.h.

References fRatioMax.

◆ GetRatioMin()

double cbm::qa::checker::Result::GetRatioMin ( ) const
inline

Definition at line 81 of file CbmQaCheckerResult.h.

References fRatioMin.

◆ operator=() [1/2]

Result & cbm::qa::checker::Result::operator= ( const Result & )
default

Copy assignment operator.

References Result().

◆ operator=() [2/2]

Result & cbm::qa::checker::Result::operator= ( Result && )
default

Move assignment operator.

References Result().

◆ SetCmpInference()

void cbm::qa::checker::Result::SetCmpInference ( ECmpInference inference)
inline

Definition at line 100 of file CbmQaCheckerResult.h.

References fCmpInference.

◆ SetExactEqual()

void cbm::qa::checker::Result::SetExactEqual ( bool exactEqual)
inline

Definition at line 98 of file CbmQaCheckerResult.h.

References fbExactEqual.

◆ SetPVal()

void cbm::qa::checker::Result::SetPVal ( double pVal)
inline

Definition at line 96 of file CbmQaCheckerResult.h.

References fPval.

◆ SetRatioMax()

void cbm::qa::checker::Result::SetRatioMax ( double ratioMax)
inline

Definition at line 94 of file CbmQaCheckerResult.h.

References fRatioMax.

◆ SetRatioMin()

void cbm::qa::checker::Result::SetRatioMin ( double ratioMin)
inline

Definition at line 92 of file CbmQaCheckerResult.h.

References fRatioMin.

Member Data Documentation

◆ fbExactEqual

bool cbm::qa::checker::Result::fbExactEqual {true}
private

Result of exact comparison.

Definition at line 113 of file CbmQaCheckerResult.h.

Referenced by GetExactEqual(), Result(), and SetExactEqual().

◆ fCmpInference

ECmpInference cbm::qa::checker::Result::fCmpInference {ECmpInference::Different}
private

Comparison inference.

Definition at line 115 of file CbmQaCheckerResult.h.

Referenced by GetCmpInference(), Result(), and SetCmpInference().

◆ fPval

double cbm::qa::checker::Result::fPval {std::numeric_limits<double>::quiet_NaN()}
private

Comparison p-value.

Definition at line 111 of file CbmQaCheckerResult.h.

Referenced by GetPVal(), Result(), and SetPVal().

◆ fRatioMax

double cbm::qa::checker::Result::fRatioMax {std::numeric_limits<double>::quiet_NaN()}
private

Maximal value of ratio.

Definition at line 109 of file CbmQaCheckerResult.h.

Referenced by GetRatioMax(), Result(), and SetRatioMax().

◆ fRatioMin

double cbm::qa::checker::Result::fRatioMin {std::numeric_limits<double>::quiet_NaN()}
private

Minimal value of ratio.

Definition at line 107 of file CbmQaCheckerResult.h.

Referenced by GetRatioMin(), Result(), and SetRatioMin().


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