mathfunc.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H.Bril
 Date:          17-11-1999
 Contents:      Mathematical Functions
________________________________________________________________________

-*/


#include "algomod.h"
#include "interpol1d.h"
#include "ptrman.h"
#include "samplingdata.h"
#include "varlenarray.h"
#include "typeset.h"
#include "math2.h"

#include <math.h>

template <class T> class LineParameters;
template <class T> class ValueSeries;


template <class RT,class PT>
mClass(Algo) MathFunctionND
{
public:
    virtual             ~MathFunctionND() {}

    virtual RT          getNDValue(const PT*) const             = 0;
    virtual int         getNrDim() const                        = 0;
};

typedef MathFunctionND<float,float> FloatMathFunctionND;


template <class RT,class PT>
mClass(Algo) MathFunction : public MathFunctionND<RT,PT>
{
public:

    virtual RT          getNDValue( const PT* pos ) const
                                                { return getValue(*pos); }
    virtual int         getNrDim() const        { return 1; }

    virtual RT          getValue( PT ) const    = 0;

};

typedef MathFunction<float,float> FloatMathFunction;
typedef MathFunction<double,double> DoubleMathFunction;


template <class RT,class PT>
mClass(Algo) MathFunctionSampler
{
public:
                        MathFunctionSampler( const MathFunction<RT,PT>& f )
                            : func_( f )
                        {}
    RT                  operator[](int idx) const
                        { return func_.getValue( sd.atIndex(idx) ); }

    SamplingData<PT>    sd;

protected:

    const MathFunction<RT,PT>&  func_;

};


template <class RT,class PT>
mClass(Algo) MathXYFunction : public MathFunctionND<RT,PT>
{
public:

    virtual RT  getValue(PT,PT) const           = 0;

    RT          getNDValue( const PT* pos ) const
                        { return getValue(pos[0],pos[1]);}
    int         getNrDim() const { return 2; }

};


template <class RT,class PT>
mClass(Algo) MathXYZFunction : public MathFunctionND<RT,PT>
{
public:

    virtual RT  getValue(PT,PT,PT) const        = 0;

    RT          getNDValue( const PT* pos ) const
                        { return getValue(pos[0],pos[1],pos[2]);}
    int         getNrDim() const { return 3; }

};



template <class xT,class yT>
mClass(Algo) BendPointBasedMathFunction : public MathFunction<yT,xT>
{
public:

    enum InterpolType   { Linear, Poly, Snap };
    enum ExtrapolType   { None, EndVal, ExtraPolGradient };

                        BendPointBasedMathFunction( InterpolType t=Linear,
                                                    ExtrapolType extr=EndVal )
                            : itype_(t)
                            , extrapol_(extr)   {}

    void                setEmpty()              { x_.setSize(0); y_.setSize(0);}
    int                 size() const            { return x_.size(); }
    bool                isEmpty() const         { return x_.isEmpty(); }
    void                add(xT x,yT y);
    void                remove(int idx);
    yT                  getValue( xT x ) const
                        { return itype_ == Snap ? snapVal(x) : interpVal(x); }

    const TypeSet<xT>& xVals() const            { return x_; }
    const TypeSet<yT>& yVals() const            { return y_; }

    InterpolType        interpolType() const    { return itype_; }
    ExtrapolType        extrapolateType() const { return extrapol_; }
    bool                extrapolate() const     { return extrapol_ != None; }
    void                setInterpolType( InterpolType t ) { itype_ = t; }
    void                setExtrapolateType( ExtrapolType t ) { extrapol_ = t; }
    virtual yT          getNDValue( const xT* p ) const { return getValue(*p); }

protected:

    InterpolType        itype_;
    ExtrapolType        extrapol_;
    TypeSet<xT>         x_;
    TypeSet<yT>         y_;

    int                 baseIdx(xT) const;
    yT                  snapVal(xT) const;
    yT                  interpVal(xT) const;
    yT                  outsideVal(xT) const;

public:

    void                setXValue(int idx,xT x);
};

typedef BendPointBasedMathFunction<float,float> PointBasedMathFunction;


template <class RT,class PT>
mClass(Algo) AlongVectorFunction : public MathFunction<RT,PT>
{
public:
                        AlongVectorFunction( const MathFunctionND<RT,PT>& func_,
                                             const PT* P_, const PT* N_)
                            : P( P_ )
                            , N( N_ )
                            , func( func_ )
                        {}

    RT                  getValue( PT lambda ) const
                        {
                            const int nrdim = func.getNrDim();
                            mAllocVarLenArr( PT, pos, nrdim );
                            for ( int idx=0; idx<nrdim; idx++ )
                                pos[idx] = P[idx] + N[idx]*lambda;

                            return func.getNDValue( pos );
                        }

protected:

    const PT*                           P;
    const PT*                           N;
    const MathFunctionND<RT,PT>&        func;
};


mExpClass(Algo) SecondOrderPoly : public FloatMathFunction
{
public:
                        SecondOrderPoly( float a_=0, float b_=0, float c_=0 )
                            : a( a_ ), b( b_ ), c( c_ )
                        {}

    void                setFromSamples(float y0,float y1,float y2)
                        {
                            c = y1;
                            a = ( (y0+y2) / 2 ) - y1;
                            b = ( y2-y0 ) / 2;
                        }

    float               getValue( float pos ) const
                        {
                            if ( Values::isUdf(pos) ) return mUdf(float);
                            return pos*pos * a + pos * b + c;
                        }

    float               getExtremePos() const
                        {
                            if ( mIsZero(a,mDefEps) ) return mUdf(float);
                            return -b / (2*a);
                        }

    int                 getRoots( float& pos0, float& pos1 ) const
                        {
                            pos0 = pos1 = mUdf(float);

                            if ( mIsZero(a,mDefEps) )
                            {
                                if ( mIsZero(b,mDefEps) )
                                    return 0;

                                pos0 = -c/b;
                                return 1;
                            }

                            const double halfp = b/a/2;
                            const double q = c/a;

                            const double squareterm = halfp*halfp-q;
                            if ( squareterm<0 )
                                return 0;

                            const double sq = Math::Sqrt(squareterm);


                            pos0 = (float)(-halfp+sq);
                            pos1 = (float)(-halfp-sq);
                            return 2;
                        }

    LineParameters<float>* createDerivative() const;

    float               a, b, c;
};


mExpClass(Algo) ThirdOrderPoly : public FloatMathFunction
{
public:
                        ThirdOrderPoly( float a_=0, float b_=0,
                                        float c_=0, float d_=0 )
                            : a( a_ ), b( b_ ), c( c_ ), d( d_ )
                        {}

    void                setFromSamples(float y0,float y1,float y2,float y3)
                        {
                            b = ( (y2+y0) / 2 ) - y1;
                            c = y2 - ( ( 2*y0 + 3*y1 + y3 ) / 6 );
                            a = ( (y2-y0) / 2 ) - c;
                            d = y1;
                        }

    float               getValue( float pos ) const
                        {
                            if ( Values::isUdf(pos) ) return mUdf(float);
                            const float possq = pos * pos;
                            return possq * pos * a + possq * b + pos * c + d;
                        }

    SecondOrderPoly*    createDerivative() const
                        { return new SecondOrderPoly( a*3, b*2, c ); }

    int                 getExtremePos( float& pos0, float& pos1 ) const
                        {
                            pos0 = pos1 = mUdf(float);
                            if ( mIsZero(a,mDefEps) && mIsZero(b,mDefEps) )
                                return 0;
                            else if ( mIsZero(a,mDefEps) )
                            {
                                pos0 = -c / ( 2*b );
                                return 1;
                            }

                            SecondOrderPoly derivate( a*3, b*2, c );
                            return derivate.getRoots(pos0, pos1);
                        }

    float               a, b, c, d;
};



mExpClass(Algo) ValSeriesMathFunc : public FloatMathFunction
{
public:
                        ValSeriesMathFunc(const ValueSeries<float>&,int sz);

    float               getValue(float) const;

protected:
    const ValueSeries<float>&   vs_;
    int                         sz_;
};



template <class mXT, class mYT> inline
int BendPointBasedMathFunction<mXT,mYT>::baseIdx( mXT x ) const
{
    const int sz = x_.size();
    if ( sz < 1 )               return -1;
    const mXT x0 = x_[0];
    if ( x < x0 )               return -1;
    if ( sz == 1 )              return x >= x0 ? 0 : -1;
    const mXT xlast = x_[sz-1];
    if ( x >= xlast )           return sz-1;
    if ( sz == 2 )              return 0;

    int ilo = 0; int ihi = sz - 1;
    while ( ihi - ilo > 1 )
    {
        int imid = (ihi+ilo) / 2;
        if ( x < x_[imid] )
            ihi = imid;
        else
            ilo = imid;
    }

    return ilo;
}


template <class mXT, class mYT> inline
void BendPointBasedMathFunction<mXT,mYT>::add( mXT x, mYT y )
{
    if ( mIsUdf(x) ) return;
    if ( x_.isPresent(x) ) return;

    const int baseidx = baseIdx( x );
    x_ += x; y_ += y;

    const int sz = x_.size();
    if ( baseidx > sz - 3 )
        return;

    mXT prevx = x; mYT prevy = y;
    for ( int idx=baseidx+1; idx<sz; idx++ )
    {
        mXT tmpx = x_[idx]; mYT tmpy = y_[idx];
        x_[idx] = prevx; y_[idx] = prevy;
        prevx = tmpx; prevy = tmpy;
    }
}


template <class mXT, class mYT> inline
void BendPointBasedMathFunction<mXT,mYT>::setXValue( int idx, mXT x )
{
    if ( idx<0 || idx >= size() )
        return;

    x_[idx] = x;
}


template <class mXT, class mYT> inline
void BendPointBasedMathFunction<mXT,mYT>::remove( int idx )
{
    if ( idx<0 || idx>=size() )
        return;

    x_.removeSingle( idx );
    y_.removeSingle( idx );
}


template <class mXT, class mYT> inline
mYT BendPointBasedMathFunction<mXT,mYT>::outsideVal( mXT x ) const
{
    if ( extrapol_ == None )
        return mUdf(mYT);

    const int sz = x_.size();

    if ( extrapol_==EndVal || sz<2 )
        return x-x_[0] < x_[sz-1]-x ? y_[0] : y_[sz-1];

    if ( x < x_[0] )
    {
        const mYT gradient = (mYT)(y_[1]-y_[0]) / (mYT) (x_[1]-x_[0]);
        return (mYT)(y_[0] + (x-x_[0]) * gradient);
    }

    const mYT gradient = (mYT)(y_[sz-1]-y_[sz-2]) / (mYT) (x_[sz-1]-x_[sz-2]);
    return (mYT)(y_[sz-1] + (x-x_[sz-1]) * gradient);
}




template <class mXT, class mYT> inline
mYT BendPointBasedMathFunction<mXT,mYT>::snapVal( mXT x ) const
{
    const int sz = x_.size();
    if ( sz < 1 ) return mUdf(mYT);

    if ( x < x_[0] || x > x_[sz-1] )
        return outsideVal(x);

    const int baseidx = baseIdx( x );

    if ( baseidx < 0 )
        return y_[0];
    if ( baseidx > sz-2 )
        return y_[sz - 1];
    return x - x_[baseidx] < x_[baseidx+1] - x ? y_[baseidx] : y_[baseidx+1];
}


template <class mXT, class mYT> inline
mYT BendPointBasedMathFunction<mXT,mYT>::interpVal( mXT x ) const
{
    const int sz = x_.size();
    if ( sz < 1 ) return mUdf(mYT);

    if ( x < x_[0] || x > x_[sz-1] )
        return outsideVal(x);
    else if ( sz < 2 )
        return y_[0];

    const int i0 = baseIdx( x );
    const mYT v0 = y_[i0];
    if ( i0 == sz-1 )
        return v0;

    const mXT x0 = x_[i0];
    const int i1 = i0 + 1; const mXT x1 = x_[i1]; const mYT v1 = y_[i1];
    const mXT dx = x1 - x0;
    if ( dx == 0 ) return v0;

    const mXT relx = (x - x0) / dx;
    if ( mIsUdf(v0) || mIsUdf(v1) )
        return relx < 0.5 ? v0 : v1;

    // OK - we have 2 nearest points and they:
    // - are not undef
    // - don't coincide

    if ( itype_ == Linear )
        return (mYT)(v1 * relx + v0 * (1-relx));

    const int im1 = i0 > 0 ? i0 - 1 : i0;
    const mXT xm1 = im1 == i0 ? x0 - dx : x_[im1];
    const mYT vm1 = mIsUdf(y_[im1]) ? v0 : y_[im1];

    const int i2 = i1 < sz-1 ? i1 + 1 : i1;
    const mXT x2 = i2 == i1 ? x1 + dx : x_[i2];
    const mYT v2 = mIsUdf(y_[i2]) ? v1 : y_[i2];

    return (mYT)Interpolate::poly1D( (float) xm1, vm1, (float) x0, v0,
                                     (float) x1, v1,
                                     (float) x2, v2, (float) x );
}