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  - curt@me.umn.edu
  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 Library General Public
  22 // License along with this library; if not, write to the
  23 // Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 // Boston, MA  02111-1307, USA.
  25 //
  26 // $Id$
  27
  28
  29 #ifndef _INTERPOLATER_H
  30 #define _INTERPOLATER_H
  31
  32
  33 #ifndef __cplusplus
  34 # error This library requires C++
  35 #endif
  36
  37 #include <simgear/compiler.h>
  38
  39 #include <vector>
  40 SG_USING_STD(vector);
  41
  42 #include STL_STRING
  43 SG_USING_STD(string);
  44
  45
  46 /**
  47  * A class that provids a simple linear 2d interpolation lookup table.
  48  * The actual table is expected to be loaded from a file.  The
  49  * independant variable must be strictly ascending.  The dependent
  50  * variable can be anything.
  51  */
  52 class SGInterpTable {
  53
  54     struct Entry
  55     {
  56       Entry ()
  57         : ind(0.0L), dep(0.0L) {}
  58       Entry (double independent, double dependent)
  59         : ind(independent), dep(dependent) {}
  60       double ind;
  61       double dep;
  62     };
  63
  64     int size;
  65     vector<Entry> table;
  66
  67 public:
  68
  69     /**
  70      * Constructor. Creates a new, empty table.
  71      */
  72     SGInterpTable();
  73
  74     /**
  75      * Constructor. Loads the interpolation table from the specified file.
  76      * @param file name of interpolation file
  77      */
  78     SGInterpTable( const string& file );
  79
  80
  81     /**
  82      * Add an entry to the table, extending the table's length.
  83      *
  84      * @param ind The independent variable.
  85      * @param dep The dependent variable.
  86      */
  87     void addEntry (double ind, double dep);
  88
  89
  90     /**
  91      * Given an x value, linearly interpolate the y value from the table.
  92      * @param x independent variable
  93      * @return interpolated dependent variable
  94      */
  95     double interpolate(double x) const;
  96
  97     /** Destructor */
  98     ~SGInterpTable();
  99 };
 100
 101
 102 #endif // _INTERPOLATER_H
 103
 104