Vulcan
Aerospace Engineering Utilities Built on Janus
Loading...
Searching...
No Matches
vulcan::ScatteredTable1D Class Reference

#include <TableInterpolator.hpp>

Public Member Functions

 ScatteredTable1D (const janus::NumericVector &x, const janus::NumericVector &y, int grid_resolution=50, RBFKernel kernel=RBFKernel::ThinPlateSpline)
 Construct 1D scattered interpolation table.
template<janus::JanusScalar Scalar>
Scalar operator() (const Scalar &x) const
 Query table at a single point.
double reconstruction_error () const
 Get RMS reconstruction error at original data points.
int dims () const
 Get number of dimensions (always 1).
bool valid () const
 Check if table is valid (initialized).

Constructor & Destructor Documentation

◆ ScatteredTable1D()

vulcan::ScatteredTable1D::ScatteredTable1D ( const janus::NumericVector & x,
const janus::NumericVector & y,
int grid_resolution = 50,
RBFKernel kernel = RBFKernel::ThinPlateSpline )
inline

Construct 1D scattered interpolation table.

Parameters
xIndependent variable values (can be non-uniform)
yDependent variable values at x points
grid_resolutionGrid points for resampling (default: 50)
kernelRBF kernel type (default: ThinPlateSpline)
Exceptions
janus::InterpolationErrorif sizes don't match or < 2 points
Examples
/home/runner/work/vulcan/vulcan/include/vulcan/core/TableInterpolator.hpp.

Member Function Documentation

◆ dims()

int vulcan::ScatteredTable1D::dims ( ) const
inline

◆ operator()()

template<janus::JanusScalar Scalar>
Scalar vulcan::ScatteredTable1D::operator() ( const Scalar & x) const
inline

Query table at a single point.

Template Parameters
ScalarQuery type (double or janus::SymbolicScalar)
Parameters
xQuery point
Returns
Interpolated value
Examples
/home/runner/work/vulcan/vulcan/include/vulcan/core/TableInterpolator.hpp.

◆ reconstruction_error()

double vulcan::ScatteredTable1D::reconstruction_error ( ) const
inline

Get RMS reconstruction error at original data points.

Lower values indicate better fit quality.

Examples
/home/runner/work/vulcan/vulcan/include/vulcan/core/TableInterpolator.hpp.

◆ valid()

bool vulcan::ScatteredTable1D::valid ( ) const
inline

Check if table is valid (initialized).

Examples
/home/runner/work/vulcan/vulcan/include/vulcan/core/TableInterpolator.hpp.

The documentation for this class was generated from the following file: