doc update

Author: camilo

CMakeLists.txt

@@ -11,7 +11,7 @@
 
 cmake_minimum_required( VERSION 3.2 )
 project( qlibs
-         VERSION 1.2.8
+         VERSION 1.2.9
          DESCRIPTION "A collection of useful libraries for embedded systems"
          LANGUAGES C
        )
@@ -30,5 +30,6 @@ add_library( ${PROJECT_NAME}
              qtdl.c
              qtypegeneric.c
              qvfloat.c
+             qinterp1.c
            )
 target_include_directories( ${PROJECT_NAME} PUBLIC include )

README.md

@@ -58,5 +58,6 @@ Below is the list of the modules provided and their features:
 - Type-generic array operations
 - Single precision floating-point vector(1D-Array) operations
 - Fast single precision floating-point math
+- One-dimensional interpolation
 
 

doc/mainpage.dox

@@ -1,10 +1,10 @@
 /** @mainpage qLibs
-* @image html https://user-images.githubusercontent.com/11412210/199044031-0e37f39d-5a57-4a68-9da1-fe3cdbc7c0fa.jpg 
-* A collection of useful libraries written in C for embedded systems. 
+* @image html https://user-images.githubusercontent.com/11412210/199044031-0e37f39d-5a57-4a68-9da1-fe3cdbc7c0fa.jpg
+* A collection of useful libraries written in C for embedded systems.
 *
 * @remark
-* qLibs is developed using a formal and rigorous process framed in compliance with 
-* the MISRA C 2012 and CERT coding standard guidelines and complemented with 
+* qLibs is developed using a formal and rigorous process framed in compliance with
+* the MISRA C 2012 and CERT coding standard guidelines and complemented with
 * multiple static-analysis checks targeted to safe critical applications.
 *
 * qLibs includes the following modules:
@@ -37,6 +37,7 @@
 * - @subpage qrms_desc "qRMS : Recursive Root Mean Square (RMS) calculation"
 * - @subpage qcrc_desc "qCRC : Generic Cyclic Redundancy Check (CRC) calculator"
 * - @subpage qtdl_desc "qTDL : Tapped Delay Line in O(1)"
+* - @subpage qinterp1_desc "qInterp1 : 1D Interpolation class"
 * - Type-generic array operations
 * - Single precision floating-point vector(1D-Array) operations
 * - Fast single-precision floating-point math

doc/qinterp1.dox

@@ -0,0 +1,33 @@
+/*! @page qinterp1_desc 1D Interpolation class
+* The \ref qInterp1 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:
+* - QINTERP1_NEXT : Return the next neighbor.
+* - QINTERP1_PREVIOUS : Return the previous neighbor.
+* - QINTERP1_NEAREST : Return the nearest neighbor.
+* - QINTERP1_LINEAR : Linear interpolation from nearest neighbors.
+* - QINTERP1_SINE : Sine interpolation.
+* - QINTERP1_CUBIC : Cubic interpolation.
+* - QINTERP1_HERMITE : Piecewise cubic Hermite interpolation.
+* - QINTERP1_SPLINE : Catmull spline interpolation.
+* - QINTERP1_CONSTRAINED_SPLINE : A special kind of spline that doesn't overshoot.
+*
+* If value is beyond the endpoints, extrapolation is performed using the current
+* method.
+*
+* @section qinterp1_ex1 Example : Code snippet that demonstrates the spline interpolation .
+*
+*  @code{.c}
+*  float xdat[] = { 1.0f, 6.0f, 11.0f, 16.0f, 21.0f, 26.0f, 31.0f, 36.0f };
+*  float ydat[] = { 59.6870f,  44.5622f, -0.8642f , 0.8725f, -2.3016f, -50.3095f, -54.5966f, 37.9036f };
+*  qInterp1_t interpolator( xdat, ydat );
+*  qInterp1_Setup( &interpolator, xdat, ydat, sizeof(xdat)/sizeof(xdat[0]) );
+*  qInterp1_SetMethod( &interpolator, QINTERP1_SPLINE );
+*  float ye = qInterp1_Get( &interpolator, 18.5f ); //interpolated value at 18.5
+*  @endcode
+*
+*/