-//
-// 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 library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Library General Public License for more details.
//
-// You should have received a copy of the GNU Library General Public
-// License along with this library; if not, write to the
-// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-// Boston, MA 02111-1307, USA.
+// 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// $Id$
#define _INTERPOLATER_H
-#ifndef __cplusplus
+#ifndef __cplusplus
# error This library requires C++
-#endif
+#endif
#include <simgear/compiler.h>
-#include STL_STRING
-SG_USING_STD(string);
+#include "simgear/structure/SGReferenced.hxx"
-#define MAX_TABLE_SIZE 32
+#include <map>
+#include STL_STRING
+SG_USING_STD(string);
-class SGInterpTable {
- 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
+ /**
+ * 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 );
- // Given an x value, linearly interpolate the y value from the table
- double interpolate(double x);
- // Destructor
- ~SGInterpTable( void );
+ /**
+ * 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;
};