simgear/math/interpolater.hxx

   1 /**
   2  * \file interpolater.hxx
   3  * Routines to handle linear interpolation from a table of x,y The
   4  * table must be sorted by "x" in ascending order
   5  */
   6
   7 // Written by Curtis Olson, started April 1998.
   8 //
   9 // Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
  10 //
  11 // This library is free software; you can redistribute it and/or
  12 // modify it under the terms of the GNU Library General Public
  13 // License as published by the Free Software Foundation; either
  14 // version 2 of the License, or (at your option) any later version.
  15 //
  16 // This library is distributed in the hope that it will be useful,
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19 // Library General Public License for more details.
  20 //
  21 // You should have received a copy of the GNU General Public License
  22 // along with this program; if not, write to the Free Software
  23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  24 //
  25 // $Id$
  26
  27
  28 #ifndef _INTERPOLATER_H
  29 #define _INTERPOLATER_H
  30
  31
  32 #ifndef __cplusplus
  33 # error This library requires C++
  34 #endif
  35
  36 #include <simgear/compiler.h>
  37
  38 #include <vector>
  39 SG_USING_STD(vector);
  40
  41 #include STL_STRING
  42 SG_USING_STD(string);
  43
  44
  45 /**
  46  * A class that provids a simple linear 2d interpolation lookup table.
  47  * The actual table is expected to be loaded from a file.  The
  48  * independant variable must be strictly ascending.  The dependent
  49  * variable can be anything.
  50  */
  51 class SGInterpTable {
  52
  53     struct Entry
  54     {
  55       Entry ()
  56         : ind(0.0L), dep(0.0L) {}
  57       Entry (double independent, double dependent)
  58         : ind(independent), dep(dependent) {}
  59       double ind;
  60       double dep;
  61     };
  62
  63     int size;
  64     vector<Entry> table;
  65
  66 public:
  67
  68     /**
  69      * Constructor. Creates a new, empty table.
  70      */
  71     SGInterpTable();
  72
  73     /**
  74      * Constructor. Loads the interpolation table from the specified file.
  75      * @param file name of interpolation file
  76      */
  77     SGInterpTable( const string& file );
  78
  79
  80     /**
  81      * Add an entry to the table, extending the table's length.
  82      *
  83      * @param ind The independent variable.
  84      * @param dep The dependent variable.
  85      */
  86     void addEntry (double ind, double dep);
  87
  88
  89     /**
  90      * Given an x value, linearly interpolate the y value from the table.
  91      * @param x independent variable
  92      * @return interpolated dependent variable
  93      */
  94     double interpolate(double x) const;
  95
  96     /** Destructor */
  97     ~SGInterpTable();
  98 };
  99
 100
 101 #endif // _INTERPOLATER_H
 102
 103