simgear/math/interpolater.cxx

   1 //
   2 // interpolater.cxx -- routines to handle linear interpolation from a table of
   3 //                     x,y   The table must be sorted by "x" in ascending order
   4 //
   5 // Written by Curtis Olson, started April 1998.
   6 //
   7 // Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
   8 //
   9 // This library is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU Library General Public
  11 // License as published by the Free Software Foundation; either
  12 // version 2 of the License, or (at your option) any later version.
  13 //
  14 // This library is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 // Library General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22 //
  23 // $Id$
  24
  25 #ifdef HAVE_CONFIG_H
  26 #  include <simgear_config.h>
  27 #endif
  28
  29 #include <simgear/compiler.h>
  30
  31 #include <string>
  32
  33 #include <simgear/debug/logstream.hxx>
  34 #include <simgear/misc/sgstream.hxx>
  35 #include <simgear/props/props.hxx>
  36
  37 #include "interpolater.hxx"
  38
  39 // Constructor -- starts with an empty table.
  40 SGInterpTable::SGInterpTable()
  41 {
  42 }
  43
  44 SGInterpTable::SGInterpTable(const SGPropertyNode* interpolation)
  45 {
  46     if (!interpolation)
  47         return;
  48     std::vector<SGPropertyNode_ptr> entries = interpolation->getChildren("entry");
  49     for (unsigned i = 0; i < entries.size(); ++i)
  50         addEntry(entries[i]->getDoubleValue("ind", 0.0),
  51                  entries[i]->getDoubleValue("dep", 0.0));
  52 }
  53
  54 // Constructor -- loads the interpolation table from the specified
  55 // file
  56 SGInterpTable::SGInterpTable( const std::string& file )
  57 {
  58     SG_LOG( SG_MATH, SG_INFO, "Initializing Interpolator for " << file );
  59
  60     sg_gzifstream in( file );
  61     if ( !in.is_open() ) {
  62         SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << file );
  63         return;
  64     }
  65
  66     in >> skipcomment;
  67     while ( in ) {
  68       double ind, dep;
  69       in >> ind >> dep;
  70       in >> skipws;
  71       _table[ind] = dep;
  72     }
  73 }
  74
  75
  76 // Add an entry to the table.
  77 void SGInterpTable::addEntry (double ind, double dep)
  78 {
  79   _table[ind] = dep;
  80 }
  81
  82 // Given an x value, linearly interpolate the y value from the table
  83 double SGInterpTable::interpolate(double x) const
  84 {
  85   // Empty table??
  86   if (_table.empty())
  87     return 0;
  88
  89   // Find the table bounds for the requested input.
  90   Table::const_iterator upBoundIt = _table.upper_bound(x);
  91   // points to a value outside the map. That is we are out of range.
  92   // use the last entry
  93   if (upBoundIt == _table.end())
  94     return _table.rbegin()->second;
  95
  96   // points to the first key must be lower
  97   // use the first entry
  98   if (upBoundIt == _table.begin())
  99     return upBoundIt->second;
 100
 101   // we know that we do not stand at the beginning, so it is safe to do so
 102   Table::const_iterator loBoundIt = upBoundIt;
 103   --loBoundIt;
 104
 105   // Just do linear interpolation.
 106   double loBound = loBoundIt->first;
 107   double upBound = upBoundIt->first;
 108   double loVal = loBoundIt->second;
 109   double upVal = upBoundIt->second;
 110
 111   // division by zero should not happen since the std::map
 112   // has sorted out duplicate entries before. Also since we have a
 113   // map, we know that we get different first values for different iterators
 114   return loVal + (upVal - loVal)*(x - loBound)/(upBound - loBound);
 115 }
 116
 117
 118 // Destructor
 119 SGInterpTable::~SGInterpTable() {
 120 }
 121
 122