doc update. Add setData methods to interp1

Author: camilo

check/qlibs_cpp_test.cpp

@@ -405,6 +405,17 @@ void test_interp1( void )
     cout << interpolation.get( 3.1 ) << endl;
     cout << interpolation.get( 0.5 ) << endl;
     cout << interpolation.get( 5.0 ) << endl;
+
+
+    real_t xdat[] = { 1.0f, 6.0f, 11.0f, 16.0f, 21.0f, 26.0f, 31.0f, 36.0f };
+    real_t ydat[] = { 59.6870f,  44.5622f, -0.8642f , 0.8725f, -2.3016f, -50.3095f, -54.5966f, 37.9036f };
+    interp1 interpolation2( xdat, ydat );
+    interpolation2.setMethod( INTERP1_HERMITE );
+    cout << "spline test 2" << endl;
+    for( int i = 1; i<36;i++) {
+
+        cout << i << "  " <<  interpolation2.get( i ) << endl;
+    }
 }
 
 int main()

doc/mainpage.dox

@@ -39,7 +39,7 @@
 * - @subpage qtdl_desc "TDL : Tapped Delay Line in O(1)"
 * - Type-generic array operations
 * - Fast floating-point math library
-* - 1D Interpolation class
+* - @subpage qinterp1_desc "1D Interpolation class"
 */
 
 /**

doc/qinterp1.dox

@@ -0,0 +1,32 @@
+/*! @page qinterp1_desc 1D Interpolation class
+* The \ref qlibs::interp1 class provides a simple, consistent interface for a set of
+* one-dimensional interpolators. The class recieves X-Values and Y-Values and
+* the size of this arrays to setup the instance. The user can later pass the
+* X point to interpolate, and the interpolator instance return the estimated Y
+* at the point X using the specified method.
+*
+* The current supported methods are:
+* - qlibs::INTERP1_NEXT : Return the next neighbor.
+* - qlibs::INTERP1_PREVIOUS : Return the previous neighbor.
+* - qlibs::INTERP1_NEAREST : Return the nearest neighbor.
+* - qlibs::INTERP1_LINEAR : Linear interpolation from nearest neighbors.
+* - qlibs::INTERP1_SINE : Sine interpolation.
+* - qlibs::INTERP1_CUBIC : Cubic interpolation.
+* - qlibs::INTERP1_HERMITE : Piecewise cubic Hermite interpolation.
+* - qlibs::INTERP1_SPLINE : Catmull spline interpolation.
+* - qlibs::INTERP1_CONSTRAINED_SPLINE : A special kind of spline that doesn't overshoot.
+*
+* If value if beyond the endpoints, extrapolation is performed using the current
+* method.
+*
+* @section qinterp1_ex1 Example : Code snippet that demonstrates the spline interpolation .
+*
+*  @code{.c}
+*  real_t xdat[] = { 1.0f, 6.0f, 11.0f, 16.0f, 21.0f, 26.0f, 31.0f, 36.0f };
+*  real_t ydat[] = { 59.6870f,  44.5622f, -0.8642f , 0.8725f, -2.3016f, -50.3095f, -54.5966f, 37.9036f };
+*  interp1 interpolator( xdat, ydat );
+*  interpolator.setMethod( INTERP1_SPLINE );
+*  auto ye = interpolator.get( 18.5f ); //interpolated value at 18.5
+*  @endcode
+*
+*/

library.json

@@ -16,7 +16,7 @@
       "maintainer": true
     }
   ],
-  "version": "1.0.9",
+  "version": "1.1.0",
   "license": "MIT",
   "frameworks": "arduino",
   "platforms": "*"

library.properties

@@ -1,5 +1,5 @@
 name=qlibs
-version=1.0.9
+version=1.1.0
 license=MIT
 author=J. Camilo Gomez C. <[email protected]>
 maintainer=J. Camilo Gomez C. <[email protected]>

src/include/interp1.hpp

@@ -109,22 +109,55 @@ namespace qlibs {
             /**
             * @brief Constructor for the 1D interpolation instance.
             * @param[in] xTable An array of size @a sizeTable with the x points sorted in ascending order.
-            * @param[in] yTabLe An array of size @a sizeTable with the y points.
+            * @param[in] yTable An array of size @a sizeTable with the y points.
             * @param[in] sizeTable The number of points in @a xTable @a yTable
             */
             interp1( const real_t * const xTable,
-                     const real_t * const yTabLe,
-                     const size_t sizeTable ) : xData( xTable ), yData( yTabLe ), dataSize( sizeTable ) {}
+                     const real_t * const yTable,
+                     const size_t sizeTable ) : xData( xTable ), yData( yTable ), dataSize( sizeTable ) {}
 
             /**
             * @brief Constructor for the 1D interpolation instance.
             * @param[in] xTable An array of size @a sizeTable with the x points sorted in ascending order.
-            * @param[in] yTabLe An array of size @a sizeTable with the y points.
+            * @param[in] yTable An array of size @a sizeTable with the y points.
             */
             template <size_t sizeTable>
             interp1( real_t (&xTable)[ sizeTable ],
                      real_t (&yTable)[ sizeTable ] ) : interp1( xTable, yTable, sizeTable ) {}
 
+            /**
+            * @brief Set the data table for the 1D interpolation instance.
+            * @param[in] xTable An array of size @a sizeTable with the x points sorted in ascending order.
+            * @param[in] yTable An array of size @a sizeTable with the y points.
+            * @param[in] sizeTable The number of points in @a xTable @a yTable
+            */
+            bool setData( const real_t * const xTable,
+                          const real_t * const yTable,
+                          const size_t sizeTable )
+            {
+                bool retValue = false;
+
+                if ( ( nullptr != xTable ) && ( nullptr != yTable ) && ( sizeTable >= 4U ) ) {
+                    xData = xTable;
+                    yData = yTable;
+                    dataSize = sizeTable;
+                    retValue = true;
+                }
+                return retValue;
+            }
+
+            /**
+            * @brief Set the data for the 1D interpolation instance.
+            * @param[in] xTable An array of size @a sizeTable with the x points sorted in ascending order.
+            * @param[in] yTable An array of size @a sizeTable with the y points.
+            */
+            template <size_t sizeTable>
+            bool setData( real_t (&xTable)[ sizeTable ],
+                          real_t (&yTable)[ sizeTable ] )
+            {
+                return setData( xTable, yTable, sizeTable );
+            }
+
             /**
             * @brief Specify the interpolation method to use.
             * @param[in] m The interpolation method.

src/qlibs.h

@@ -41,8 +41,8 @@ This file is part of the QuarkTS++ OS distribution.
 #ifndef QLIBS_CPP_H
 #define QLIBS_CPP_H
 
-#define QLIBS_CPP_VERSION         "1.0.9"
-#define QLIBS_CPP_VERNUM          ( 109U )
+#define QLIBS_CPP_VERSION         "1.1.0"
+#define QLIBS_CPP_VERNUM          ( 110U )
 #define QLIBS_CPP_CAPTION         "qLibs++" QLIBS_CPP_VERSION
 
 #include <include/qlibs_types.hpp>