ranges.h

Go to the documentation of this file.

#ifndef ranges_h
#define ranges_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Bril
 Date:          23-10-1996
 Contents:      Ranges
 RCS:           $Id$
________________________________________________________________________

-*/

#include "gendefs.h"
#include "math2.h"
#include "ptrman.h"
#include "varlenarray.h"



template <class T>
mClass(Basic) BasicInterval
{
public:
    inline                      BasicInterval();
    inline                      BasicInterval(const T& start,const T& stop);
    inline BasicInterval<T>&    operator=(const BasicInterval<T>&);

    inline void                 set(const T& start,const T& stop);
    inline bool                 isEqual(const BasicInterval<T>& i,
                                        const T& eps) const;
    inline bool                 operator==(const BasicInterval<T>&) const;
    inline bool                 operator!=(const BasicInterval<T>&) const;
    inline BasicInterval<T>     operator+(const BasicInterval<T>&) const;
    inline BasicInterval<T>&    operator+=(const BasicInterval<T>&);
    template <class X>
    const BasicInterval<T>&     setFrom(const BasicInterval<X>&);

    inline T                    width(bool allowrev=true) const;
    inline T                    center() const;
    inline float                getfCenter() const;
    inline void                 shift(const T& len);
    inline void                 widen(const T& len,bool allowrev=true);

    inline T                    atIndex(int,const T& step) const;
    template <class X>
    inline int                  getIndex(const X&,const T& step) const;
    template <class X>
    inline float                getfIndex(const X&,const T& step) const;
    template <class X>
    inline int                  nearestIndex(const X& x,const T& step) const;
    template <class X>
    inline int                  indexOnOrAfter(X x,const T& step,
                                               float eps=1e-5) const;
    template <class X>
    inline void                 limitTo( const BasicInterval<X>& i )
                                { start = i.limitValue(start);
                                  stop  = i.limitValue(stop); }
    template <class X>
    inline X                    limitValue(const X&) const;

    template <class X>
    inline bool                 overlaps(const BasicInterval<X>&,
                                         bool allrev=true) const;
    template <class X>
    inline bool                 includes(const X&, bool allowrev ) const;
    template <class X>
    inline bool                 includes(const BasicInterval<X>&,
                                         bool allowrev=true) const;
    template <class X>
    inline bool                 includes(const Interval<X>&,
                                         bool allowrev=true) const;

    template <class X>
    inline float                pos(X val,bool limit=true,
                                    bool allowrev=true) const;
    inline void                 include(const T&, bool allowrev=true);
    inline void                 include(const BasicInterval<T>&,
                                        bool allowrev=true);

    T                           start;
    T                           stop;

    static BasicInterval<T>     udf(){return BasicInterval<T>(mUdf(T),mUdf(T));}

    inline bool                 isRev() const           { return start > stop; }
};


template <class T>
mClass(Basic) Interval : public BasicInterval<T>
{
public:
    inline              Interval() : BasicInterval<T>()         {}
    inline virtual      ~Interval()                                     {}
    inline              Interval(const T& start,const T& stop);
    inline              Interval(const BasicInterval<T>& b );
    inline
    virtual Interval<T>* clone() const;

    virtual bool inline isUdf() const;
    virtual void        setUdf();

    inline virtual void scale(const T&);

    virtual void        sort( bool asc=true );

    virtual bool        hasStep() const                 { return false; }
    static Interval<T>  udf()      {return Interval<T>(mUdf(T),mUdf(T));}
};


typedef Interval<int>   SampleGate;
typedef Interval<float> ZGate;


template <class T>
mClass(Basic) StepInterval : public Interval<T>
{
public:

    inline              StepInterval();
    inline              StepInterval(const T& start,const T& stop,
                                     const T& step);
    inline              StepInterval(const Interval<T>&);
    inline              StepInterval( const StepInterval<T>& si )
                        : Interval<T>(si), step(si.step)        {}
    inline StepInterval<T>& operator=(const Interval<T>&);

    virtual bool inline isUdf() const;
    virtual void        setUdf();
    static StepInterval<T> udf()
                        {return StepInterval<T>(mUdf(T),mUdf(T),mUdf(T));}

    virtual bool        hasStep() const         { return true; }

    inline
    virtual StepInterval<T>*    clone() const;
    inline void         set(const T& start,const T& stop,const T& step);

    template <class X>
    const StepInterval<T>& setFrom(const Interval<X>&);

    inline bool         isEqual(const StepInterval<T>& i,const T& eps) const;
    inline bool         operator==(const StepInterval<T>&) const;
    inline bool         operator!=(const StepInterval<T>&) const;
    inline T            atIndex(int) const;
    template <class X>
    inline int          getIndex(const X&) const;
    template <class X> inline
    int                 indexOnOrAfter( X x, float eps ) const;

    template <class X>
    inline float        getfIndex(const X&) const;
    template <class X>
    inline int          nearestIndex(const X&) const;
    template <class X>
    inline T            snap(const X&) const;
    template <class X>
    inline T            snap(const X&,int dir) const;

    inline int          nrSteps() const;
    inline float        nrfSteps() const;
    virtual inline void sort(bool asc=true);
    inline void         scale(const T&);
    inline T            snappedCenter() const;

    inline bool         isCompatible(const StepInterval<T>&,
                                     float eps=mDefEps) const;
    inline T            snapStep(const T& inpstep) const;
     T                  step;

};


template <class T>
mClass(Basic) IntervalND
{
public:
                                IntervalND( int ndim_ )
                                    : ranges (new Interval<T>[ndim_] )
                                    , ndim( ndim_ )
                                    , isset( false ) {}

    virtual                     ~IntervalND() { delete [] ranges; }

    int                         nDim() const { return ndim; }
    bool                        isSet() const { return isset; }

    const Interval<T>&          getRange(int dim) const { return ranges[dim]; }
    template <class X> inline
    void                        setRange(const X& val);
    template <class X> inline
    void                        setRange(const X& start,const X& stop);
    template <class X> inline
    void                        include(const X& val);

    template <class X> inline
    bool                        includes(const X& val,bool allowrev) const;
    inline bool                 intersects(const IntervalND<T>&,
                                           bool allowrev) const;

protected:

    int                 ndim;
    Interval<T>*        ranges;
    bool                isset;

};


#include "samplingdata.h"


template <class T> template <class X> inline
void IntervalND<T>::setRange( const X& val )
{
    for ( int dim=0; dim<ndim; dim++ )
        ranges[dim].start = ranges[dim].stop = (T) val[dim];

    isset = true;
}



template <class T> template <class X> inline
void IntervalND<T>::setRange( const X& start, const X& stop)
{
    for ( int dim=0; dim<ndim; dim++ )
    {
        ranges[dim].start = start[dim];
        ranges[dim].stop = stop[dim];
    }

    isset = true;
}


template <class T> template <class X> inline
void IntervalND<T>::include( const X& val )
{
#ifdef __debug__
    if ( !isset )
        pErrMsg("Doing include on undefined IntervalND");
#endif

    for ( int dim=0; dim<ndim; dim++ )
        ranges[dim].include((T) val[dim]);

    isset = true;
}


template <class T> template <class X> inline
bool IntervalND<T>::includes( const X& val, bool allowrev ) const
{
#ifdef __debug__
    if ( !isset )
    {
        pErrMsg("Doing includes on undefined IntervalND");
        return false;
    }
#endif

    for ( int dim=0; dim<ndim; dim++ )
    {
        if ( !ranges[dim].includes(val[dim], allowrev ) )
            return false;
    }

    return true;
}


template <class T> inline
bool IntervalND<T>::intersects( const IntervalND<T>& b, bool allowrev ) const
{
    if ( !isset || !b.isset || ndim!=b.ndim)
    {
        pErrMsg("Invalid intersection");
        return false;
    }

    mAllocLargeVarLenArr( T, vector, ndim );
    mAllocLargeVarLenArr( bool, isstart, ndim );
    for ( int dim=0; dim<ndim; dim++ )
    {
        vector[dim] = ranges[dim].start;
        isstart[dim] = true;
    }

    do
    {
        if ( b.includes((T*)vector, allowrev ) )
            return true;

        int dim = 0;
        while ( dim<ndim )
        {
            if ( isstart[dim] )
            {
                isstart[dim] = false;
                vector[dim] = ranges[dim].stop;
                break;
            }
            else
            {
                isstart[dim] = true;
                vector[dim] = ranges[dim].start;
                dim++;
            }
        }

        if ( dim==ndim )
            break;

    } while ( true );


    return false;
}


template <class T1,class T2>
inline void assign( Interval<T1>& i1, const Interval<T2>& i2 )
{
    i1.start = (T1)i2.start;
    i1.stop = (T1)i2.stop;
    mDynamicCastGet(StepInterval<T1>*,si1,&i1)
    mDynamicCastGet(const StepInterval<T2>*,si2,&i2)
    if ( si1 && si2 )
        si1->step = (T1)si2->step;
}


template <class T1,class T2>
inline void assign( StepInterval<T1>& i1, const StepInterval<T2>& i2 )
{ i1.start = (T1)i2.start; i1.stop = (T1)i2.stop; i1.step = (T1)i2.step; }



// ---------------- BasicInterval ---------------------

template <class T>
inline BasicInterval<T>&
BasicInterval<T>::operator=( const BasicInterval<T>& intv )
{ start = intv.start; stop = intv.stop; return *this; }


template <class T> template <class X> inline
int BasicInterval<T>::nearestIndex( const X& x, const T& step ) const
{
    return SamplingData<T>( start, step ).nearestIndex( x );
}


template <class T>
template <class X> inline
int BasicInterval<T>::indexOnOrAfter( X x, const T& step, float eps ) const
{
    return SamplingData<T>( start, step ).indexOnOrAfter( x, eps );
}


template <class T> inline BasicInterval<T>::BasicInterval()
    : start(0), stop(0)         {}


template <class T> inline
BasicInterval<T>::BasicInterval( const T& t1, const T& t2 )
    : start(t1), stop(t2)       {}


template <class T> inline
Interval<T>* Interval<T>::clone() const
{ return new Interval<T>( *this ); }


template <class T> inline
void BasicInterval<T>::set( const T& t1, const T& t2 )
{ start = t1; stop = t2; }


template <class T> inline
bool BasicInterval<T>::isEqual( const BasicInterval<T>& i, const T& eps ) const
{ return mIsEqual(start,i.start,eps) && mIsEqual(stop,i.stop,eps); }


template <class T> inline
bool BasicInterval<T>::operator==( const BasicInterval<T>& i ) const
{ return start == i.start && stop == i.stop; }


template <class T> inline
bool BasicInterval<T>::operator!=( const BasicInterval<T>& i ) const
{ return ! (i == *this); }


template <class T> inline
BasicInterval<T> BasicInterval<T>::operator+( const BasicInterval<T>& i ) const
{ return Interval<T>(start+i.start, stop+i.stop); }


template <class T> inline
BasicInterval<T>& BasicInterval<T>::operator+=( const BasicInterval<T>& i )
{ start += i.start; stop += i.stop; return *this; }


template <class T> template <class X> inline
const BasicInterval<T>& BasicInterval<T>::setFrom( const BasicInterval<X>& i )
{
    start = (T)i.start;
    stop = (T)i.stop;
    return *this;
}


template <class T> inline
T BasicInterval<T>::width( bool allowrev ) const
{ return allowrev && isRev() ? start - stop : stop - start; }


#define mCenterImpl(func,typ) \
template <class T> inline  \
typ BasicInterval<T>::func() const \
{ return ((typ)(start+stop))/2; }

mCenterImpl(center, T )
mCenterImpl(getfCenter, float )

#undef mCenterImpl


template <class T> inline
void BasicInterval<T>::shift( const T& len )
{ start += len; stop += len; }


template <class T> inline
void BasicInterval<T>::widen( const T& len, bool allowrev )
{
    if ( allowrev && isRev() )
        { start += len; stop -= len; }
    else
        { start -= len; stop += len; }
}


template <class T> template <class X> inline
bool BasicInterval<T>::includes( const X& t, bool allowrev ) const
{
    return allowrev && isRev()
        ? t>=stop && start>=t
        : t>=start && stop>=t;
}


template <class T> template <class X> inline
bool BasicInterval<T>::includes( const BasicInterval<X>& t, bool allowrev )const
{
    return includes( t.start, allowrev ) && includes( t.stop, allowrev );
}


template <class T> template <class X> inline
bool BasicInterval<T>::includes( const Interval<X>& t, bool allowrev ) const
{
    return BasicInterval<T>::includes( static_cast<BasicInterval>( t ));
}


template <class T> template <class X> inline
float BasicInterval<T>::pos( X val, bool limit, bool allowrev ) const
{
    float res = allowrev && isRev()
        ? (val-stop)/(start-stop)
        : (val-start)/(stop-start);

    if ( limit )
    {
        if ( res<0 ) res = 0;
        else if ( res>1 ) res = 1;
    }

    return res;
}


template <class T> template <class X> inline
bool BasicInterval<T>::overlaps( const BasicInterval<X>& t,
                                 bool allowrev ) const
{
    return includes( t.start, allowrev ) || includes( t.stop, allowrev ) ||
           t.includes( start, allowrev ) || t.includes( stop, allowrev );
}


template <class T> inline
void BasicInterval<T>::include( const T& i, bool allowrev )
{
    if ( allowrev && isRev() )
        { if ( stop>i ) stop=i; if ( start<i ) start=i; }
    else
        { if ( start>i ) start=i; if ( stop<i ) stop=i; }
}


template <class T> inline
void BasicInterval<T>::include( const BasicInterval<T>& i, bool allowrev )
{ include( i.start, allowrev ); include( i.stop, allowrev ); }


template <class T> inline
T BasicInterval<T>::atIndex( int idx, const T& step ) const
{ return start + step * idx; }


template <class T> template <class X> inline
int BasicInterval<T>::getIndex( const X& t, const T& step ) const
{ return (int)(( t  - start ) / step); }


template <class T> template <class X> inline
float BasicInterval<T>::getfIndex( const X& t, const T& step ) const
{ return SamplingData<T>( start, step ).getfIndex( t ); }


template <class T> template <class X> inline
X BasicInterval<T>::limitValue( const X& t ) const
{
    const bool isrev = isRev();
    if ( (!isrev&&t>stop) || (isrev&&t<stop) ) return stop;
    if ( (!isrev&&t<start) || (isrev&&t>start) ) return start;
    return t;
}


// ---------------- Interval ------------------------

template <class T> inline
Interval<T>::Interval( const T& startval, const T& stopval )
    : BasicInterval<T>( startval, stopval )
{}


template <class T> inline
Interval<T>::Interval( const BasicInterval<T>& b )
    : BasicInterval<T>( b )
{}


template <class T> inline
void Interval<T>::sort( bool asc )
{
    if ( (asc && BasicInterval<T>::stop<BasicInterval<T>::start) ||
         (!asc && BasicInterval<T>::start<BasicInterval<T>::stop) )
        Swap(BasicInterval<T>::start,BasicInterval<T>::stop);
}


template <class T> inline
void Interval<T>::scale( const T& factor )
{ BasicInterval<T>::start *= factor; BasicInterval<T>::stop *= factor; }


template <class T> inline
bool Interval<T>::isUdf() const
{
    return mIsUdf(BasicInterval<T>::start) || mIsUdf(BasicInterval<T>::stop);
}


template <class T> inline
void Interval<T>::setUdf()
{ BasicInterval<T>::set( mUdf(T), mUdf(T) ); }


// ---------------- StepInterval --------------------

template <class T>
StepInterval<T>::StepInterval()
    : step(1)           {}


template <class T>
StepInterval<T>::StepInterval( const T& t1, const T& t2, const T& t3 )
    : Interval<T>(t1,t2), step(t3)              {}


template <class T>
StepInterval<T>::StepInterval( const Interval<T>& intv )
    : Interval<T>(intv)
{
    step = 1;
    if ( intv.hasStep() )
    {
        mDynamicCastGet(const StepInterval<T>*,sintv,&intv);
        step = sintv ? sintv->step : 1;
    }
}


template <class T>
inline StepInterval<T>& StepInterval<T>::operator=( const Interval<T>& intv )
{ assign( *this, intv ); return *this; }


template <class T> inline
bool StepInterval<T>::isUdf() const
{ return Interval<T>::isUdf() || mIsUdf(step); }


template <class T> inline
void StepInterval<T>::setUdf()
{ Interval<T>::set( mUdf(T), mUdf(T) ); step = mUdf(T); }


template <class T> inline
StepInterval<T>* StepInterval<T>::clone() const
{ return new StepInterval<T>( *this ); }


template <class T> inline
void StepInterval<T>::set( const T& t1, const T& t2, const T& t3 )
{ Interval<T>::set( t1, t2 ); step = t3; }


template <class T> inline
bool StepInterval<T>::isEqual( const StepInterval<T>& i, const T& eps ) const
{ return Interval<T>::isEqual(i,eps) && mIsEqual(step,i.step,eps); }


template <class T> inline
bool StepInterval<T>::operator==( const StepInterval<T>& i ) const
{ return Interval<T>::operator==(i) && i.step==step; }


template <class T> inline
bool StepInterval<T>::operator!=( const StepInterval<T>& i ) const
{ return ! (i == *this); }


template <class T> template <class X> inline
const StepInterval<T>& StepInterval<T>::setFrom( const Interval<X>& i )
{
    Interval<T>::setFrom( i );
    if ( i.hasStep() )
        step = (T)(((const StepInterval<X>&)i).step);

    return *this;
}


template <class T> inline
T StepInterval<T>::atIndex( int idx ) const
{ return Interval<T>::atIndex(idx,step); }


template <class T> template <class X> inline
int StepInterval<T>::getIndex( const X& t ) const
{ return Interval<T>::getIndex( t, step ); }


template <class T> template <class X> inline
float StepInterval<T>::getfIndex( const X& t ) const
{ return Interval<T>::getfIndex( t, step ); }


template <class T> template <class X> inline
int StepInterval<T>::indexOnOrAfter( X x, float eps ) const
{
    return Interval<T>::indexOnOrAfter( x, step, eps );
}


template <class T> template <class X> inline
int StepInterval<T>::nearestIndex( const X& x ) const
{ return Interval<T>::nearestIndex( x, step ); }


template <class T> template <class X> inline
T StepInterval<T>::snap( const X& t ) const
{ return atIndex( nearestIndex(t) ); }


template <class T> template <class X> inline
T StepInterval<T>::snap( const X& t, int dir ) const
{
    if ( dir==0 )
        return atIndex( nearestIndex(t) );

    const float fidx = getfIndex( t );
    const int idx = mNINT32( dir==-1 ? Math::Floor(fidx) : Math::Ceil(fidx) );
    return atIndex( idx );
}


template <class T> inline
void StepInterval<T>::sort( bool asc )
{
    Interval<T>::sort(asc);
    if ( (asc && step < 0) || (!asc && step > 0) )
        step = -step;
}


template <class T> inline
void StepInterval<T>::scale( const T& factor )
{
    Interval<T>::scale( factor );
    step *= factor;
}


template <class T> inline
T StepInterval<T>::snappedCenter() const
{ return snap( Interval<T>::center() ); }


template <class T> inline
T StepInterval<T>::snapStep( const T& inputstep ) const
{
    const float relstep = (float) inputstep/step;
    int nrsteps = mNINT32(relstep);
    if ( nrsteps<1 ) nrsteps = 1;
    return step*nrsteps;
}


template <class T> inline
float StepInterval<T>::nrfSteps() const
{
    const float w = Interval<T>::width( true );
    return w/step;
}


template <class T>
inline int StepInterval<T>::nrSteps() const
{
    if ( !step ) return 0;
    int ret = (((int)this->start) - ((int) this->stop)) / ((int) step);
    return ret < 0 ? -ret : ret;
}


#define mDefFNrSteps(typ) \
template <> \
inline int StepInterval<typ>::nrSteps() const \
{ \
    if ( !step ) return 0; \
    typ ns = ( (start > stop ? start : stop) \
            - (start > stop ? stop : start) ) \
              / (step > 0 ? step : -step); \
    return mNINT32(ns); \
}

mDefFNrSteps(float)
mDefFNrSteps(double)

template <class T>
inline bool StepInterval<T>::isCompatible( const StepInterval<T>& b,
                                           float ) const
{
    if ( step>b.step || b.step%step )
        return false;

    // const T diff = static_cast<const Interval<T>*>(this)->start - b.start;
    const T diff = this->start - b.start;
    return !(diff%step);
}


#define mDefFltisCompat(typ,releps) \
template <> \
inline bool StepInterval<typ>::isCompatible( const StepInterval<typ>& b, \
                        float eps ) const \
{ \
    const typ castedeps = (typ) eps; \
    if ( !mIsEqual(step,b.step, castedeps) ) return false; \
 \
    typ nrsteps = (start - b.start) / step; \
    const int nrstepsi = mNINT32( nrsteps ); \
    if ( !nrstepsi ) \
        return mIsEqual( start, b.start, \
                     mIsZero(start,releps) ? releps \
                                           : start < 0. ? -start * releps \
                                                        :  start * releps );\
\
    typ reldiff = (nrsteps - nrstepsi) / nrsteps; \
    return ( (reldiff) < (releps) && (reldiff) > (-releps) ); \
}

mDefFltisCompat(float,1e-5f)
mDefFltisCompat(double,1e-10)
// Do not change the above releps values as they originate from the types.

#endif