Range Class Reference

to specify 1-dim region or range by two floats More...

#include <Range.h>

Public Member Functions
	Range ()
	Constructor.
	Range (const Range &)
	Copy constructor.
	Range (float low, float high)
	Constructor.
virtual float	low (void) const
	returns lower limit.
virtual float	high (void) const
	returns higher limit.
virtual float	center (void) const
	returns center.
virtual float	width (void) const
	returns width.
virtual float	low (float lowIn)
	sets lower limit.
virtual float	high (float highIn)
	sets higher limit.
virtual Range &	set (float low, float high)
	sets range.
virtual Range &	setByCenter (float center, float width)
	sets range by center and width.
Range &	operator= (const Range &)
	Copy operator.
bool	operator== (const Range &) const
	returns true if range is the same.
bool	operator!= (const Range &) const
	returns true if range is different.
bool	operator& (const Range &) const
	returns true if two are overlaped each other.
bool	within (const float value) const
	returns true if given value is within a range.
bool	within2 (const float value) const
	returns true if given value is within a range.
bool	within (const Range &) const
	returns true if given Range is within(included in) a range.
virtual int	dump (void) const
	displays debug information.

Detailed Description

to specify 1-dim region or range by two floats

Definition at line 19 of file Range.h.

Constructor & Destructor Documentation

Range() [1/3]

Range::Range

(

)

Constructor.

Definition at line 16 of file Range.cxx.

             {
    _low = -999.;
    _high = -999.;
}

Range() [2/3]

Range::Range

(

const Range &

ib

)

Copy constructor.

Definition at line 21 of file Range.cxx.

                             {
    _low = ib.low();
    _high = ib.high();
}

Range() [3/3]

Range::Range	(	float	low,
		float	high )

Constructor.

Definition at line 26 of file Range.cxx.

                                                {
    if (iHigh > iLow) {
    _low = iLow;
    _high = iHigh;
    }
    else {
    _low = iHigh;
    _high = iLow;
    }
}

Member Function Documentation

center()

float Range::center ( void ) const

inlinevirtual

returns center.

Definition at line 129 of file Range.h.

                        {
    return (_low + _high) / 2.;
}

Referenced by setByCenter().

dump()

int Range::dump ( void ) const

virtual

displays debug information.

Definition at line 45 of file Range.cxx.

                      {
    std::cout << _low << "~" << _high;
    return 0;
}

high() [1/2]

float Range::high ( float highIn )

inlinevirtual

sets higher limit.

Definition at line 122 of file Range.h.

                   {
    if (i < _low) i = _low;
    return _high = i;
}

high() [2/2]

float Range::high ( void ) const

inlinevirtual

returns higher limit.

Definition at line 116 of file Range.h.

                      {
    return _high;
}

Referenced by operator&(), operator=(), operator==(), Range(), and within().

low() [1/2]

float Range::low ( float lowIn )

inlinevirtual

sets lower limit.

Definition at line 109 of file Range.h.

                  {
    if (i > _high) i = _high;
    return _low = i;
}

low() [2/2]

float Range::low ( void ) const

inlinevirtual

returns lower limit.

Definition at line 103 of file Range.h.

                     {
    return _low;
}

Referenced by operator&(), operator=(), operator==(), Range(), and within().

operator!=()

bool Range::operator!= ( const Range & a ) const

inline

returns true if range is different.

Definition at line 205 of file Range.h.

                                         {
    if ((* this) == a) return false;
    return true;
}

operator&()

bool Range::operator& ( const Range & a ) const

inline

returns true if two are overlaped each other.

Definition at line 212 of file Range.h.

                                        {
    if (within(a.low())) return true;
    if (within(a.high())) return true;
    if (a.within(low())) return true;
    if (a.within(high())) return true;
    return false;
}

operator=()

Range & Range::operator= ( const Range & ib )

inline

Copy operator.

Definition at line 163 of file Range.h.

                                   {
    _low = ib.low();
    _high = ib.high();
    return * this;
}

operator==()

bool Range::operator==

(

const Range &

a

)

const

returns true if range is the same.

Definition at line 38 of file Range.cxx.

                                         {
    if (_low != a.low()) return false;
    if (_high != a.high()) return false;
    return true;
}

set()

Range & Range::set ( float low, float high )

inlinevirtual

sets range.

Definition at line 141 of file Range.h.

                                  {
    if (iHigh > iLow) {
    _low = iLow;
    _high = iHigh;
    }
    else {
    _low = iHigh;
    _high = iLow;
    }
    return * this;
}

setByCenter()

Range & Range::setByCenter ( float center, float width )

inlinevirtual

sets range by center and width.

Definition at line 155 of file Range.h.

                                            {
    _low = center - width;
    _high = center + width;
    return * this;
}

width()

float Range::width ( void ) const

inlinevirtual

returns width.

Definition at line 135 of file Range.h.

                       {
    return (_high - _low);
}

Referenced by setByCenter().

within() [1/2]

bool Range::within ( const float value ) const

inline

returns true if given value is within a range.

Definition at line 171 of file Range.h.

                                {
    if (_low == -999. && _high == -999.) {
    return false;
    }
    if (_low == -999.) {
    if (f <= _high) return true;
    return false;
    }
    if (_high == -999.) {
    if (f >= _low) return true;
    }
    if (f >= _low && f <= _high) return true;
    return false;
}

Referenced by operator&(), and within().

within() [2/2]

bool Range::within ( const Range & a ) const

inline

returns true if given Range is within(included in) a range.

Definition at line 222 of file Range.h.

                                   {
    if (within(a.low()) && within(a.high())) return true;
    return false;
}

within2()

bool Range::within2 ( const float value ) const

inline

returns true if given value is within a range.

Definition at line 188 of file Range.h.

                                 {
    if (_low == -999. && _high == -999.) {
    return true;
    }
    if (_low == -999.) {
    if (f <= _high) return true;
    return false;
    }
    if (_high == -999.) {
    if (f >= _low) return true;
    }
    if (f >= _low && f <= _high) return true;
    return false;
}

---

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

• Range.h
• Range.cxx