vulcan::Table1D Class Reference

#include <TableInterpolator.hpp>

Public Member Functions
	Table1D (const janus::NumericVector &x, const janus::NumericVector &y, janus::InterpolationMethod method=janus::InterpolationMethod::Linear)
	Construct 1D interpolation table.
template<janus::JanusScalar Scalar>
Scalar	operator() (const Scalar &x) const
	Query table at a single point.
template<typename Derived>
auto	operator() (const Eigen::MatrixBase< Derived > &x) const
	Query table at multiple points (batch evaluation).
janus::InterpolationMethod	method () const
	Get the interpolation method.
bool	valid () const
	Check if table is valid (initialized).

Detailed Description

Examples

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

Constructor & Destructor Documentation

Table1D()

vulcan::Table1D::Table1D ( const janus::NumericVector & x, const janus::NumericVector & y, janus::InterpolationMethod method = janus::InterpolationMethod::Linear )

inline

Construct 1D interpolation table.

Parameters

x	Independent variable grid (must be sorted, ascending)
y	Dependent variable values at grid points
method	Interpolation method (default: Linear)

Exceptions

janus::InterpolationError

if x is not sorted or sizes don't match

Examples

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

Member Function Documentation

method()

janus::InterpolationMethod vulcan::Table1D::method ( ) const

inline

Get the interpolation method.

Examples

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

operator()() [1/2]

template<typename Derived>

auto vulcan::Table1D::operator() ( const Eigen::MatrixBase< Derived > & x ) const

inline

Query table at multiple points (batch evaluation).

Template Parameters

Derived

Eigen expression type

Parameters

x	Vector of query points

Returns

Vector of interpolated values

operator()() [2/2]

template<janus::JanusScalar Scalar>

Scalar vulcan::Table1D::operator() ( const Scalar & x ) const

inline

Query table at a single point.

Values outside the grid are clamped to the boundary values.

Template Parameters

Scalar

Query type (double or janus::SymbolicScalar)

Parameters

x	Query point

Returns

Interpolated value

Examples

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

valid()

bool vulcan::Table1D::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:

• include/vulcan/core/TableInterpolator.hpp