Consistency Class Reference

#include <Consistency.h>

Inheritance diagram for Consistency:

Public Types
enum	ConsistentStatus { OK =0 , noMeasure , underFlow , unPhysical }
enum	ConsistentSign { left =-1 , unknown =0 , right =1 }

Public Member Functions
	Consistency ()
	Consistency (double consistency, double likelihood=0.)
	Consistency (const Consistency &rhs)
virtual	~Consistency ()
Consistency &	operator= (const Consistency &rhs)
bool	operator== (const Consistency &rhs) const
bool	operator< (const Consistency &rhs) const
bool	operator> (const Consistency &rhs) const
double	significanceLevel () const
double	likelihood () const
double	consistency () const
ConsistentStatus	status () const
void	setStatus (ConsistentStatus s)
ConsistentSign	sign () const
void	setSign (ConsistentSign s)
virtual const ConsistencySet *	genealogy () const
virtual void	print (std::ostream &) const

Static Public Member Functions
static const Consistency &	badMeasurement ()

Protected Attributes
ConsistentStatus	_stat
ConsistentSign	_sign
double	_value
double	_likelihood

Detailed Description

Definition at line 53 of file Consistency.h.

Member Enumeration Documentation

ConsistentSign

enum Consistency::ConsistentSign

Enumerator
left
unknown
right

Definition at line 114 of file Consistency.h.

{ left=-1, unknown=0, right=1 };

ConsistentStatus

enum Consistency::ConsistentStatus

Enumerator
OK
noMeasure
underFlow
unPhysical

Definition at line 94 of file Consistency.h.

{ OK=0, noMeasure, underFlow, unPhysical };

Constructor & Destructor Documentation

Consistency() [1/3]

Consistency::Consistency

(

)

Definition at line 54 of file Consistency.cxx.

  : _stat(noMeasure), _value(0), _likelihood(1.), _sign(unknown)
{
}

Consistency() [2/3]

Consistency::Consistency	(	double	consistency,
		double	likelihood = 0.
	)

Definition at line 59 of file Consistency.cxx.

  : _stat(OK), _value(v), _likelihood(l), _sign(unknown)
{
}

Consistency() [3/3]

Consistency::Consistency

(

const Consistency &

rhs

)

Definition at line 64 of file Consistency.cxx.

  : _stat(rhs._stat), _value(rhs._value)
  , _likelihood(rhs._likelihood), _sign(rhs._sign)
{
}

~Consistency()

virtual Consistency::~Consistency ( )

inlinevirtual

Definition at line 66 of file Consistency.h.

{}

Member Function Documentation

badMeasurement()

const Consistency & Consistency::badMeasurement ( )

static

Definition at line 172 of file Consistency.cxx.

{
  static Consistency bad(1.,1.);
  bad.setStatus(noMeasure);
 
  return bad;
}

consistency()

double Consistency::consistency ( ) const

inline

Definition at line 91 of file Consistency.h.

{ return _value; }

genealogy()

const ConsistencySet * Consistency::genealogy ( ) const

virtual

Definition at line 132 of file Consistency.cxx.

{
  return 0;
}

likelihood()

double Consistency::likelihood ( ) const

inline

Definition at line 86 of file Consistency.h.

{ return  _likelihood;}

operator<()

bool Consistency::operator<

(

const Consistency &

rhs

)

const

Definition at line 97 of file Consistency.cxx.

{
  //
  // this is not unique...
  //
 
  bool answer = false;
  if (_stat == OK && rhs._stat == OK ) {
    //
    // Dare to use consistency for comparison. 
    // Likelihood may give a different answer
    //
    if (_value < rhs._value) {
      answer = true;
    }
  } else {
    if (rhs._stat == OK) {
      answer = true;
    }
  }
 
  return answer;
}

operator=()

Consistency & Consistency::operator=

(

const Consistency &

rhs

)

Definition at line 72 of file Consistency.cxx.

{
  if(this != &rhs){
    _stat=rhs._stat;
    _value=rhs._value;
    _likelihood=rhs._likelihood;
    _sign=rhs._sign;
  }
  return *this;
}

Referenced by ChisqConsistency::operator=().

operator==()

bool Consistency::operator==

(

const Consistency &

rhs

)

const

Definition at line 84 of file Consistency.cxx.

{
  bool answer = false;
  if (_stat       == rhs._stat &&
      _value      == rhs._value &&
      _likelihood == rhs._likelihood &&
      _sign       == rhs._sign) {
    answer = true;
  }
 
  return answer;
}

operator>()

bool Consistency::operator>

(

const Consistency &

rhs

)

const

Definition at line 123 of file Consistency.cxx.

{
  // ghm
  if( *this==rhs ) return false;
  return( ! (*this<rhs) );
}

print()

void Consistency::print ( std::ostream &  ) const

virtual

Definition at line 139 of file Consistency.cxx.

{
  os << "Likelihood = ";
  os << setiosflags(ios::fixed) << setw(7) << setprecision(4);
  os << _likelihood;
  os << "\t SignificanceLevel = ";
  os << setiosflags(ios::fixed) << setw(7) << setprecision(4);
  os << _value;
  os << "\t Status ";
  switch( status() ) {
  case Consistency::OK  :
    os << "OK"; 
    break;
  case  Consistency::noMeasure  :
    os << "noMeasure"; 
    break;
  case  Consistency::underFlow  :
    os << "underFlow"; 
    break;
  case  Consistency::unPhysical  :
    os << "unPhysical"; 
    break;
  default:
    os << "unknown";
  }
  os << endl;
}

setSign()

void Consistency::setSign ( ConsistentSign  s )

inline

Definition at line 118 of file Consistency.h.

{ _sign = s; }

setStatus()

void Consistency::setStatus ( ConsistentStatus  s )

inline

Definition at line 107 of file Consistency.h.

{ _stat = s; }

Referenced by badMeasurement(), and ChisqConsistency::ChisqConsistency().

sign()

ConsistentSign Consistency::sign ( ) const

inline

Definition at line 117 of file Consistency.h.

{return _sign; }

significanceLevel()

double Consistency::significanceLevel ( ) const

inline

Definition at line 85 of file Consistency.h.

{ return _value; }

status()

ConsistentStatus Consistency::status ( ) const

inline

Definition at line 106 of file Consistency.h.

{return _stat;}

Referenced by print().

Member Data Documentation

_likelihood

double Consistency::_likelihood

protected

Definition at line 135 of file Consistency.h.

Referenced by ChisqConsistency::ChisqConsistency(), likelihood(), operator=(), operator==(), and print().

_sign

ConsistentSign Consistency::_sign

protected

Definition at line 133 of file Consistency.h.

Referenced by operator=(), operator==(), setSign(), and sign().

_stat

ConsistentStatus Consistency::_stat

protected

Definition at line 132 of file Consistency.h.

Referenced by operator<(), operator=(), operator==(), setStatus(), and status().

_value

double Consistency::_value

protected

Definition at line 134 of file Consistency.h.

Referenced by ChisqConsistency::ChisqConsistency(), consistency(), operator<(), operator=(), operator==(), print(), and significanceLevel().

---

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

• Consistency.h
• Consistency.cxx