Added some convenience functions to point3d.

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

diff --git a/simgear/math/interpolater.hxx b/simgear/math/interpolater.hxx
index 31f03dc562f3408f736cb0ed1465643bf1692d1f..501e4ac8d452f54d144c0fd5c7a6d29df5e20a3d 100644 (file)
--- a/simgear/math/interpolater.hxx
+++ b/simgear/math/interpolater.hxx
@@ -1,7 +1,9 @@
-//
-// 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
@@ -35,26 +37,37 @@
 #include <simgear/compiler.h>
 
 #include STL_STRING
-FG_USING_STD(string);
+SG_USING_STD(string);
 
 #define MAX_TABLE_SIZE 32
 
-
+/**
+ * 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 {
     int size;
     double table[MAX_TABLE_SIZE][2];
 
 public:
 
-    // Constructor -- loads the interpolation table from the specified
-    // file
+    /**
+     * 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
+    /**
+     * Given an x value, linearly interpolate the y value from the table.
+     * @param x independent variable
+     * @return interpolated dependent variable
+     */
     double interpolate(double x);
 
-    // Destructor
-    ~SGInterpTable( void );
+    /** Destructor */
+    ~SGInterpTable();
 };