CCCC_Metric Class Reference

#include <cccc_met.h>

Collaboration diagram for CCCC_Metric:

Public Member Functions
	CCCC_Metric ()
	CCCC_Metric (int n, const char *treatment_tag="")
	CCCC_Metric (int n, int d, const char *treatment_tag="")
void	set_treatment (const char *code)
void	set_ratio (float _num, float _denom=1.0)
EmphasisLevel	emphasis_level () const
string	code () const
string	name () const
string	value_string () const

Private Attributes
Metric_Treatment *	treatment
float	numerator
float	denominator

Friends
CCCC_Metric &	operator+ (const CCCC_Metric &, const CCCC_Metric &)

Detailed Description

Definition at line 68 of file cccc_met.h.

Constructor & Destructor Documentation

CCCC_Metric::CCCC_Metric

(

)

Definition at line 59 of file cccc_met.cc.

{ 
  set_ratio(0,0); 
  set_treatment(""); 
}

Here is the call graph for this function:

CCCC_Metric::CCCC_Metric	(	int	n,
		const char *	treatment_tag = ""
	)

Definition at line 65 of file cccc_met.cc.

{ 
  set_ratio(n,1); set_treatment(treatment_tag); 
}

Here is the call graph for this function:

CCCC_Metric::CCCC_Metric	(	int	n,
		int	d,
		const char *	treatment_tag = ""
	)

Definition at line 70 of file cccc_met.cc.

{ 
  set_ratio(n,d); set_treatment(treatment_tag); 
}

Here is the call graph for this function:

Member Function Documentation

string CCCC_Metric::code

(

)

const

Definition at line 102 of file cccc_met.cc.

{ 
  string retval;
  if(treatment != NULL) { retval=treatment->code; }
  return retval; 
}

EmphasisLevel CCCC_Metric::emphasis_level

(

)

const

Definition at line 85 of file cccc_met.cc.

{ 
  EmphasisLevel retval=elLOW;
  if(treatment!=NULL && numerator>treatment->numerator_threshold)
    {
      if( numerator > (treatment->upper_threshold*denominator) )
    {
      retval=elHIGH;
    } 
      else if(numerator> (treatment->lower_threshold*denominator) )
    {
      retval=elMEDIUM;
    }
    }
  return retval;
}

Here is the caller graph for this function:

string CCCC_Metric::name

(

)

const

Definition at line 109 of file cccc_met.cc.

{ 
  string retval;
  if(treatment != NULL) { retval=treatment->name; }
  return retval; 
}

void CCCC_Metric::set_ratio	(	float	_num,
		float	_denom = 1.0
	)

Definition at line 80 of file cccc_met.cc.

{ 
  numerator=_num; denominator=_denom;
}

Here is the caller graph for this function:

void CCCC_Metric::set_treatment

(

const char *

code

)

Definition at line 75 of file cccc_met.cc.

{
  treatment=CCCC_Options::getMetricTreatment(code);
}

Here is the call graph for this function:

Here is the caller graph for this function:

string CCCC_Metric::value_string

(

)

const

Definition at line 116 of file cccc_met.cc.

{
  string retval;
  char numerator_too_low='-';
  char infinity='*';
  
  ostringstream valuestr;
  valuestr.setf(std::ios::fixed);
  int width=6, precision=0;
  float n_threshold=0, low_threshold=1e9, high_threshold=1e9;
  if(treatment!=NULL)
    {
      width=treatment->width;
      precision=treatment->precision;
      n_threshold=treatment->numerator_threshold;
      low_threshold=treatment->lower_threshold;
      high_threshold=treatment->upper_threshold;
    }
  valuestr.width(width);
  valuestr.precision(precision);
  if(numerator<n_threshold)
    {
      string too_low_string(width,numerator_too_low);
      valuestr << too_low_string;
    }
  else if(denominator==0)
    {
      string infinity_string(width,infinity);
      valuestr << infinity_string;
    }
  else
    {
      double result=numerator;
      result/=denominator;
      if(result!=0.0L)
      {
         // Visual C++ and GCC appear to give different behaviours
         // when rounding a value which is exactly half way between
         // two points representable in the desired format.
         // An example of this occurs results from prn14, where the
         // numerator 21 and denominator 16 are combined to give the
         // value 1.2125 exactly, which Visual Studio renders as 1.213,
         // GCC renders as 1.212.  For consistency with the existing
         // reference data, I choose to apply a very small downward 
         // rounding factor.  The rounding factor is only applied if
         // the value is not exactly equal to zero, as applying it
         // to zero causes the value to be displayed as -0.0 instead
         // of 0.0.
         const double ROUNDING_FACTOR = 1.0e-9;
         result-=ROUNDING_FACTOR;
      }
      valuestr << result;
    }
  retval=valuestr.str();
  return retval;
}

Here is the caller graph for this function:

Friends And Related Function Documentation

CCCC_Metric& operator+ ( const CCCC_Metric &  , const CCCC_Metric &    )

friend

Member Data Documentation

float CCCC_Metric::denominator

private

Definition at line 70 of file cccc_met.h.

float CCCC_Metric::numerator

private

Definition at line 70 of file cccc_met.h.

Metric_Treatment* CCCC_Metric::treatment

private

Definition at line 69 of file cccc_met.h.

---

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

• cccc_met.h
• cccc_met.cc