egs_interpolator.h

Go to the documentation of this file.

/*
###############################################################################
#
#  EGSnrc egs++ interpolator headers
#  Copyright (C) 2015 National Research Council Canada
#
#  This file is part of EGSnrc.
#
#  EGSnrc is free software: you can redistribute it and/or modify it under
#  the terms of the GNU Affero General Public License as published by the
#  Free Software Foundation, either version 3 of the License, or (at your
#  option) any later version.
#
#  EGSnrc is distributed in the hope that it will be useful, but WITHOUT ANY
#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
#  FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for
#  more details.
#
#  You should have received a copy of the GNU Affero General Public License
#  along with EGSnrc. If not, see <http://www.gnu.org/licenses/>.
#
###############################################################################
#
#  Author:          Iwan Kawrakow, 2005
#
#  Contributors:
#
###############################################################################
*/


#ifndef EGS_INTERPOLATOR_
#define EGS_INTERPOLATOR_

#include "egs_libconfig.h"

typedef EGS_Float(*EGS_InterpolatorFuncion)(EGS_Float,void *);

class EGS_EXPORT EGS_Interpolator {

public:

    EGS_Interpolator();

    EGS_Interpolator(int nbin, EGS_Float Xmin, EGS_Float Xmax,
                     const EGS_Float *values);

    EGS_Interpolator(int nbin, EGS_Float Xmin, EGS_Float Xmax,
                     EGS_InterpolatorFuncion func,
                     void *data);

    EGS_Interpolator(EGS_Float Xmin, EGS_Float Xmax,
                     EGS_InterpolatorFuncion func, void *data,
                     int nmax = 1024, EGS_Float accu = 1e-4);

    EGS_Interpolator(int nbin, EGS_Float Xmin, EGS_Float Xmax,
                     EGS_Float *a, EGS_Float *b);

    ~EGS_Interpolator();

    void initialize(int nbin, EGS_Float Xmin, EGS_Float Xmax,
                    const EGS_Float *values);

    void initialize(int nbin, EGS_Float Xmin, EGS_Float Xmax,
                    EGS_InterpolatorFuncion func,
                    void *data);

    /* \brief Initialize the interpolator

    See the \link
    EGS_Interpolator::EGS_Interpolator(int,EGS_Float,EGS_Float,EGS_InterpolatorFuncion,void*,int,EGS_Float)
    constructor with the same argument list \endlink for more details
    */
    void initialize(EGS_Float Xmin, EGS_Float Xmax,
                    EGS_InterpolatorFuncion func, void *data,
                    int nmax = 1024, EGS_Float accu = 1e-4);

    void initialize(int nbin, EGS_Float Xmin, EGS_Float Xmax,
                    EGS_Float *a, EGS_Float *b);

    inline EGS_Float interpolate(EGS_Float x) const {
        if (x > xmin && x < xmax) {
            int i = (int)(ax + bx*x);
            if (i < 0) {
                i=0;
            }
            return a[i] + b[i]*x;
        }
        else if (x <= xmin) {
            return fmin;
        }
        else {
            return fmax;
        }
    };

    inline EGS_Float interpolateFast(EGS_Float x) const {
        int i = (int)(ax + bx*x);
        return a[i] + b[i]*x;
    };

    inline int getIndex(EGS_Float x) const {
        if (x > xmin && x < xmax) {
            return (int)(ax + bx*x);
        }
        else if (x <= xmin) {
            return 0;
        }
        else {
            return n-1;
        }
    };

    inline int getIndexFast(EGS_Float x) const {
        return (int)(ax + bx*x);
    };

    inline EGS_Float interpolateFast(int i, EGS_Float x) const {
        return a[i] + b[i]*x;
    };

    EGS_Float getXmin() const {
        return xmin;
    };
    EGS_Float getXmax() const {
        return xmax;
    };
    inline EGS_Float get_a(int i) const {
        return a[i];
    };
    inline EGS_Float get_b(int i) const {
        return b[i];
    };


private:

    int            n;     
    EGS_Float ax, bx;     
    EGS_Float *a, *b;     
    EGS_Float xmin,xmax;  
    EGS_Float fmin,fmax;  
    bool    own_data;
    void clear();
    void check(int nbin, EGS_Float Xmin, EGS_Float Xmax);
};

#endif