ComPackFlatFloat Class Reference

#include <ComPackFlatFloat.h>

Inheritance diagram for ComPackFlatFloat:

List of all members.

Public Types
	TAG_OK
	TAG_BAD
	TAG_RANGE_ERROR
	TAG_VAL_ROUND_DOWN
	TAG_VAL_ROUND_UP
enum	StatusCode {   TAG_OK, TAG_BAD, TAG_RANGE_ERROR, TAG_VAL_ROUND_DOWN,   TAG_VAL_ROUND_UP }
Public Member Functions
	ComPackFlatFloat (const double, const double, size_t)
virtual	~ComPackFlatFloat ()
StatusCode	pack (const double, d_ULong &) const
StatusCode	unpack (const d_ULong, double &) const
void	testMe (size_t, double &)
virtual StatusCode	pack (const double, d_ULong &) const =0
virtual const double &	getMinVal () const
virtual const double &	getMaxVal () const
virtual const double &	getRange () const
d_ULong	bitRange () const
d_ULong	bitMask () const
Protected Attributes
double	_minVal
double	_maxVal
double	_valRange
d_ULong	_bitRange
d_ULong	_bitMask
Private Attributes
double	_pacfac
double	_upacfac

---

Detailed Description

Definition at line 36 of file ComPackFlatFloat.h.

---

Member Enumeration Documentation

enum ComPackBaseBase::StatusCode [inherited]

Enumerator:

TAG_OK
TAG_BAD
TAG_RANGE_ERROR
TAG_VAL_ROUND_DOWN
TAG_VAL_ROUND_UP

Definition at line 35 of file ComPackBaseBase.h.

                  {
    TAG_OK, TAG_BAD, TAG_RANGE_ERROR, TAG_VAL_ROUND_DOWN, TAG_VAL_ROUND_UP 
  };

---

Constructor & Destructor Documentation

ComPackFlatFloat::ComPackFlatFloat	(	const	double,
		const	double,
		size_t
	)

Definition at line 59 of file ComPackFlatFloat.cxx.

References ComPackBase< double >::_bitMask, ComPackBase< double >::_bitRange, ComPackBase< double >::_maxlongbits, ComPackBase< double >::_maxVal, ComPackBase< double >::_minVal, _pacfac, _upacfac, ComPackBase< double >::_valRange, and epsilon.

{
  if (val_one>val_two) {
    _minVal=val_two; 
    _maxVal=val_one;
  } else {
    _minVal=val_one; 
    _maxVal=val_two;
  }

// this is a stupid test.  I wanted to packa a number in nano-seconds,
// and it refused.  I've removed the test dnb 11/17/00
//  const double epsilon = 0.0001;
  const double epsilon = 0.0;
  if (( _maxVal - _minVal )<=epsilon) {
    cout <<" ErrMsg(fatal) "  << "Error : Range is zero!" << endl;
    abort();
  }
  _valRange = _maxVal - _minVal;

  if (bits > _maxlongbits ) {
    bits = _maxlongbits;
    cout << " ErrMsg(fatal) "<< "Warning : Number of bits truncated! "
    << "Reason  : Number of bits too large for " << _maxlongbits << " bit packing operations! "
    << "This is probably caused by a serious typo somewhere!" << endl;
    abort();
  }
  _bitRange = bits;
  _bitMask = (1<<_bitRange) - 1;
  if ( 0 == _bitMask) { // check for wrap around
    _bitMask--;
  }
// preset packing.
  _pacfac = (1<<_bitRange)/_valRange;
  _upacfac = 1.0/_pacfac;
}

ComPackFlatFloat::~ComPackFlatFloat

(

)

[virtual]

Definition at line 96 of file ComPackFlatFloat.cxx.

{}

---

Member Function Documentation

d_ULong ComPackBase< double >::bitMask

(

)

const [inline, inherited]

Definition at line 75 of file ComPackBase.h.

References ComPackBase< T >::_bitMask.

{ return _bitMask; }

d_ULong ComPackBase< double >::bitRange

(

)

const [inline, inherited]

Definition at line 74 of file ComPackBase.h.

References ComPackBase< T >::_bitRange.

{ return _bitRange; }

virtual const double & ComPackBase< double >::getMaxVal

(

)

const [inline, virtual, inherited]

Definition at line 71 of file ComPackBase.h.

References ComPackBase< T >::_maxVal.

{ return _maxVal;};

virtual const double & ComPackBase< double >::getMinVal

(

)

const [inline, virtual, inherited]

Definition at line 70 of file ComPackBase.h.

References ComPackBase< T >::_minVal.

{ return _minVal;};

virtual const double & ComPackBase< double >::getRange

(

)

const [inline, virtual, inherited]

Definition at line 72 of file ComPackBase.h.

References ComPackBase< T >::_valRange.

{ return _valRange;};

virtual StatusCode ComPackBase< double >::pack	(	const	T,
		d_ULong &
	)			const [pure virtual, inherited]

ComPackBase< double >::StatusCode ComPackFlatFloat::pack	(	const	double,
		d_ULong &
	)			const

Definition at line 99 of file ComPackFlatFloat.cxx.

References ComPackBase< double >::_bitMask, ComPackBase< double >::_minVal, _pacfac, ComPackBaseBase::TAG_OK, ComPackBaseBase::TAG_VAL_ROUND_DOWN, and ComPackBaseBase::TAG_VAL_ROUND_UP.

Referenced by testMe().

{
  StatusCode retval(TAG_OK);
  double dpack = (theval-_minVal)*_pacfac;
  packedval = (d_ULong)dpack;
  if (dpack>_bitMask) { 
    packedval = _bitMask;
    retval = TAG_VAL_ROUND_DOWN;
  } else if (dpack<0) {
    packedval = 0; // clamp
    retval = TAG_VAL_ROUND_UP;
  }
  return retval;
}

void ComPackFlatFloat::testMe	(	size_t	,
		double &
	)

Definition at line 122 of file ComPackFlatFloat.cxx.

References ComPackBase< double >::_maxVal, ComPackBase< double >::_minVal, ComPackBase< double >::_valRange, genRecEmupikp::i, pack(), and unpack().

{
  if ( 0 == numsteps) return;
  toterror = 0.;
  const double incstep = double (_valRange) / double (numsteps);
  for ( double i = _minVal; i<= _maxVal; i+=incstep)
    {
      d_ULong tagVal;
      pack ( i, tagVal );
      double unTagVal;
      unpack ( tagVal, unTagVal );
      cout << i << " is converted to :" << tagVal << ". Upon unpacking :" << unTagVal << endl;
      toterror += fabs ( i-unTagVal );
    }
}

ComPackBase< double >::StatusCode ComPackFlatFloat::unpack	(	const	d_ULong,
		double &
	)			const [virtual]

Implements ComPackBase< double >.

Definition at line 115 of file ComPackFlatFloat.cxx.

References ComPackBase< double >::_bitMask, ComPackBase< double >::_minVal, _upacfac, and ComPackBaseBase::TAG_OK.

Referenced by testMe().

{
  unpackedval = ((val&_bitMask)+0.5)*_upacfac + _minVal;
  return TAG_OK;
}

---

Member Data Documentation

d_ULong ComPackBase< double >::_bitMask [protected, inherited]

Definition at line 88 of file ComPackBase.h.

Referenced by ComPackFlatFloat(), pack(), and unpack().

d_ULong ComPackBase< double >::_bitRange [protected, inherited]

Definition at line 87 of file ComPackBase.h.

Referenced by ComPackExpFloat::ComPackExpFloat(), and ComPackFlatFloat().

double ComPackBase< double >::_maxVal [protected, inherited]

Definition at line 85 of file ComPackBase.h.

Referenced by ComPackExpFloat::ComPackExpFloat(), ComPackFlatFloat(), and testMe().

double ComPackBase< double >::_minVal [protected, inherited]

Definition at line 84 of file ComPackBase.h.

Referenced by ComPackExpFloat::ComPackExpFloat(), ComPackFlatFloat(), pack(), ComPackExpFloat::pack(), testMe(), and unpack().

double ComPackFlatFloat::_pacfac [private]

Definition at line 69 of file ComPackFlatFloat.h.

Referenced by ComPackFlatFloat(), and pack().

double ComPackFlatFloat::_upacfac [private]

Definition at line 70 of file ComPackFlatFloat.h.

Referenced by ComPackFlatFloat(), and unpack().

double ComPackBase< double >::_valRange [protected, inherited]

Definition at line 86 of file ComPackBase.h.

Referenced by ComPackExpFloat::ComPackExpFloat(), ComPackFlatFloat(), and testMe().

---