Add project.* to MSVC project files

[simgear.git] / simgear / math / interpolater.hxx

diff --git a/simgear/math/interpolater.hxx b/simgear/math/interpolater.hxx
index d802e6c78e02f10292fbd66b2b7dbc2e2b93bd3c..393e39ffb267ba58c3bfe0505d1a8f1fda2903db 100644 (file)
--- a/simgear/math/interpolater.hxx
+++ b/simgear/math/interpolater.hxx
@@ -1,24 +1,26 @@
-//
-// interpolater.hxx -- routines to handle linear interpolation from a table of
-//                     x,y   The table must be sorted by "x" in ascending order
-//
+/**
+ * \file interpolater.hxx
+ * Routines to handle linear interpolation from a table of x,y The
+ * table must be sorted by "x" in ascending order
+ */
+
 // Written by Curtis Olson, started April 1998.
 //
-// Copyright (C) 1998  Curtis L. Olson  - curt@me.umn.edu
+// Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
 //
-// This program is free software; you can redistribute it and/or
-// modify it under the terms of the GNU General Public License as
-// published by the Free Software Foundation; either version 2 of the
-// License, or (at your option) any later version.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
 //
-// This program is distributed in the hope that it will be useful, but
-// WITHOUT ANY WARRANTY; without even the implied warranty of
+// This library 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
-// General Public License for more details.
+// Library General Public License for more details.
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
@@ -27,33 +29,71 @@
 #define _INTERPOLATER_H
 
 
-#ifndef __cplusplus                                                          
+#ifndef __cplusplus
 # error This library requires C++
-#endif                                   
+#endif
 
 #include <simgear/compiler.h>
 
-#include STL_STRING
-FG_USING_STD(string);
+#include <simgear/structure/SGReferenced.hxx>
 
-#define MAX_TABLE_SIZE 32
+#include <map>
 
+#include <string>
+using std::string;
 
-class fgINTERPTABLE {
-    int size;
-    double table[MAX_TABLE_SIZE][2];
+class SGPropertyNode;
 
+/**
+ * A class that provids a simple linear 2d interpolation lookup table.
+ * The actual table is expected to be loaded from a file.  The
+ * independant variable must be strictly ascending.  The dependent
+ * variable can be anything.
+ */
+class SGInterpTable : public SGReferenced {
 public:
 
-    // Constructor -- loads the interpolation table from the specified
-    // file
-    fgINTERPTABLE( const string& file );
-
-    // Given an x value, linearly interpolate the y value from the table
-    double interpolate(double x);
-
-    // Destructor
-    ~fgINTERPTABLE( void );
+    /**
+     * Constructor. Creates a new, empty table.
+     */
+    SGInterpTable();
+
+    /**
+     * Constructor. Loads the interpolation table from an interpolation
+     * property node.
+     * @param interpolation property node having entry children
+     */
+    SGInterpTable(const SGPropertyNode* interpolation);
+
+    /**
+     * Constructor. Loads the interpolation table from the specified file.
+     * @param file name of interpolation file
+     */
+    SGInterpTable( const string& file );
+
+
+    /**
+     * Add an entry to the table, extending the table's length.
+     *
+     * @param ind The independent variable.
+     * @param dep The dependent variable.
+     */
+    void addEntry (double ind, double dep);
+    
+
+    /**
+     * Given an x value, linearly interpolate the y value from the table.
+     * @param x independent variable
+     * @return interpolated dependent variable
+     */
+    double interpolate(double x) const;
+
+    /** Destructor */
+    ~SGInterpTable();
+
+private:
+    typedef std::map<double, double> Table;
+    Table _table;
 };