Class for interpolation of f = f(x) data in one independent variable x. More...

#include <CD_LookupTable1D.H>

Inheritance diagram for LookupTable1D< T, N, I >:

Public Member Functions
	LookupTable1D () noexcept
	Default constructor. Creates a table without any entries.

virtual	~LookupTable1D () noexcept=default
	Destructor (does nothing).

void	reset () noexcept
	Reset everything.

template<size_t M, typename... Ts>
LookupTable1D< T, M, I >	slice (const Ts &... a_columns) const noexcept
	Slice this table, keeping only the user-specified columns.

template<typename... Ts>
void	addData (const Ts &... x) noexcept
	Add entry.

void	addData (const std::array< T, N+1 > &x) noexcept
	Add entry.

void	swap (size_t a_columnOne, size_t a_columnTwo) noexcept
	Utility function for swapping columns.

template<size_t K>
void	scale (const T &a_scale) noexcept
	Utility function which scales one of the columns (either dependent or independent variable)

void	truncate (const T &a_min, const T &a_max, size_t a_column) noexcept
	Utility function for truncating raw data along one of the variables (either dependent or independent).

void	setRangeStrategyLo (const LookupTable::OutOfRangeStrategy &a_strategy) noexcept
	Set the out-of-range strategy on the low end.

void	setRangeStrategyHi (const LookupTable::OutOfRangeStrategy &a_strategy) noexcept
	Set the out-of-range strategy on the high end.

void	prepareTable (const size_t &a_independentVariable, const size_t &a_numPoints, const LookupTable::Spacing &a_spacing)
	Turn the raw data into uniform data for fast lookup.

template<size_t K>
T	interpolate (const T &a_x) const
	Interpolation function for specific dependent variable K.

std::array< T, N+1 >	interpolate (const T &x) const
	Interpolate whole table.

std::vector< std::array< T, N+1 > > &	getRawData () noexcept
	Access function for raw data.

std::vector< std::array< T, N+1 > > &	getStructuredData () noexcept
	Access function for structured data.

const std::vector< std::array< T, N+1 > > &	getRawData () const noexcept
	Access function for raw data.

const std::vector< std::array< T, N+1 > > &	getStructuredData () const noexcept
	Access function for structured data.

void	writeRawData (const std::string &a_file) const noexcept
	Dump raw table data to file.

void	writeStructuredData (const std::string &a_file) const noexcept
	Dump structured table data to file.

void	outputRawData (std::ostream &a_ostream=std::cout) const noexcept
	Dump raw table data to output stream.

void	outputStructuredData (std::ostream &a_ostream=std::cout) const noexcept
	Dump structured table data to file.

Protected Member Functions
void	outputData (std::ostream &a_ostream, const std::vector< std::array< T, N+1 > > &a_data) const noexcept
	Utility function for outputting data.

void	writeToFile (const std::string &a_file, const std::vector< std::array< T, N+1 > > &a_data) const noexcept
	Utility function for outputting data to a file.

size_t	getIndexLo (const T &a_x) const
	Get the lower index that brackets the input variable between two data points in the structured grid.

Protected Attributes
bool	m_isGood
	Check if data can be interpolated.

LookupTable::OutOfRangeStrategy	m_rangeStrategyLo
	Out-of-range strategy on low end.

LookupTable::OutOfRangeStrategy	m_rangeStrategyHi
	Out-of-range strategy on high end.

std::tuple< LookupTable::Spacing, size_t, T, T, T >	m_grid
	Underlying 1D grid. This is populated when calling prepareTable.

std::vector< std::array< T, N+1 > >	m_rawData
	Raw data.

std::vector< std::array< T, N+1 > >	m_structuredData
	Structured data. This is populated when calling prepareTable.

Detailed Description

template<typename T = Real, size_t N = 1, typename I = std::enable_if_t<std::is_floating_point<T>::value>>
class LookupTable1D< T, N, I >

Class for interpolation of f = f(x) data in one independent variable x.

N is the number of additional dependent variables. T must be a floating point type (e.g., float, double)

Member Function Documentation

◆ addData() [1/2]

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::addData ( const std::array< T, N+1 > & x )

inlinenoexcept

Add entry.

Parameters

[in] x Entry to add.

◆ addData() [2/2]

template<typename T , size_t N, typename I >

template<typename... Ts>

void LookupTable1D< T, N, I >::addData ( const Ts &... x )

inlinenoexcept

Add entry.

Parameters

[in] x Entry to add. For example addData(1,1,1,1). Number of elements in x must be N+1

◆ getIndexLo()

template<typename T , size_t N, typename I >

size_t LookupTable1D< T, N, I >::getIndexLo ( const T & a_x ) const

inlineprotected

Get the lower index that brackets the input variable between two data points in the structured grid.

Parameters

[in] a_x Independent variable.

Returns: Index lo

◆ getRawData() [1/2]

template<typename T , size_t N, typename I >

const std::vector< std::array< T, N+1 > > & LookupTable1D< T, N, I >::getRawData ( ) const

inlinenoexcept

Access function for raw data.

Returns: Returns m_rawData

◆ getRawData() [2/2]

template<typename T , size_t N, typename I >

std::vector< std::array< T, N+1 > > & LookupTable1D< T, N, I >::getRawData ( )

inlinenoexcept

Access function for raw data.

Returns: Returns m_rawData

◆ getStructuredData() [1/2]

template<typename T , size_t N, typename I >

const std::vector< std::array< T, N+1 > > & LookupTable1D< T, N, I >::getStructuredData ( ) const

inlinenoexcept

Access function for structured data.

Returns: Returns m_structuredData

◆ getStructuredData() [2/2]

template<typename T , size_t N, typename I >

std::vector< std::array< T, N+1 > > & LookupTable1D< T, N, I >::getStructuredData ( )

inlinenoexcept

Access function for structured data.

Returns: Returns m_structuredData

◆ interpolate() [1/2]

template<typename T , size_t N, typename I >

template<size_t K>

T LookupTable1D< T, N, I >::interpolate ( const T & a_x ) const

inline

Interpolation function for specific dependent variable K.

Parameters

[in] a_x Independent variable x

Returns: Return value

◆ interpolate() [2/2]

template<typename T , size_t N, typename I >

std::array< T, N+1 > LookupTable1D< T, N, I >::interpolate ( const T & x ) const

inline

Interpolate whole table.

Returns: Return value

Parameters

[in] x X

◆ outputData()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::outputData	(	std::ostream &	a_ostream,
		const std::vector< std::array< T, N+1 > > &	a_data
	)		const

inlineprotectednoexcept

Utility function for outputting data.

Parameters

[in]	a_ostream	Output stream
[in]	a_data	Data to be sent to output stream

◆ outputRawData()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::outputRawData ( std::ostream & a_ostream = std::cout ) const

inlinenoexcept

Dump raw table data to output stream.

Parameters

[in] a_ostream Output stream

◆ outputStructuredData()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::outputStructuredData ( std::ostream & a_ostream = std::cout ) const

inlinenoexcept

Dump structured table data to file.

Parameters

[in] a_ostream Output stream

◆ prepareTable()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::prepareTable	(	const size_t &	a_independentVariable,
		const size_t &	a_numPoints,
		const LookupTable::Spacing &	a_spacing
	)

inline

Turn the raw data into uniform data for fast lookup.

Parameters

[in]	a_independentVariable	The independent variable (i.e., column in the input data).
[in]	a_numPoints	Number of points in the input table.
[in]	a_spacing	Table spacing

◆ scale()

template<typename T , size_t N, typename I >

template<size_t K>

void LookupTable1D< T, N, I >::scale ( const T & a_scale )

inlinenoexcept

Utility function which scales one of the columns (either dependent or independent variable)

Parameters

[in] a_scale Scaling factor

◆ setRangeStrategyHi()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::setRangeStrategyHi ( const LookupTable::OutOfRangeStrategy & a_strategy )

inlinenoexcept

Set the out-of-range strategy on the high end.

Parameters

[in] a_strategy Out-of-range strategy on the high end

◆ setRangeStrategyLo()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::setRangeStrategyLo ( const LookupTable::OutOfRangeStrategy & a_strategy )

inlinenoexcept

Set the out-of-range strategy on the low end.

Parameters

[in] a_strategy Out-of-range strategy on low end

◆ slice()

template<typename T , size_t N, typename I >

template<size_t M, typename... Ts>

LookupTable1D< T, M, I > LookupTable1D< T, N, I >::slice ( const Ts &... a_columns ) const

noexcept

Slice this table, keeping only the user-specified columns.

This returns a new table with a reduced number of columns.

Parameters

[in] a_columns Column indices to include in the sliced table

Returns: Sliced lookup table

◆ swap()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::swap	(	size_t	a_columnOne,
		size_t	a_columnTwo
	)

inlinenoexcept

Utility function for swapping columns.

This is done on the raw data – if the user wants to swap columns in the resampled/structured data then he needs to call this function first and then resample the table.

Parameters

[in]	a_columnOne	Column to swap.
[in]	a_columnTwo	Column to swap.

◆ truncate()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::truncate	(	const T &	a_min,
		const T &	a_max,
		size_t	a_column
	)

inlinenoexcept

Utility function for truncating raw data along one of the variables (either dependent or independent).

This will discard (from the raw data) all data that fall outside the input interval. This is done on the raw data – the user will need to call prepareTable if the result should propagate into the resampled/structured data.

Parameters

[in]	a_min	Minimum value represented.
[in]	a_max	Maximum value represented.
[in]	a_column	Description

◆ writeRawData()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::writeRawData ( const std::string & a_file ) const

inlinenoexcept

Dump raw table data to file.

Parameters

[in] a_file File name

◆ writeStructuredData()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::writeStructuredData ( const std::string & a_file ) const

inlinenoexcept

Dump structured table data to file.

Parameters

[in] a_file File name

◆ writeToFile()

template<typename T , size_t N, typename I >

void LookupTable1D< T, N, I >::writeToFile	(	const std::string &	a_file,
		const std::vector< std::array< T, N+1 > > &	a_data
	)		const

inlineprotectednoexcept

Utility function for outputting data to a file.

Parameters

[in]	a_file	File name
[in]	a_data	Data to be sent to output stream

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

Source/Utilities/CD_LookupTable1D.H
Source/Utilities/CD_LookupTable1DImplem.H

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addData() [1/2]

◆ addData() [2/2]

◆ getIndexLo()

◆ getRawData() [1/2]

◆ getRawData() [2/2]

◆ getStructuredData() [1/2]

◆ getStructuredData() [2/2]

◆ interpolate() [1/2]

◆ interpolate() [2/2]

◆ outputData()

◆ outputRawData()

◆ outputStructuredData()

◆ prepareTable()

◆ scale()

◆ setRangeStrategyHi()

◆ setRangeStrategyLo()

◆ slice()

◆ swap()

◆ truncate()

◆ writeRawData()

◆ writeStructuredData()

◆ writeToFile()