NPoly Class Template Reference

Class template interpolates multi-dimensional data with polynomials. More...

#include <NIntp.h>

Inherits NIntp< xType, yType >.

Inheritance diagram for NPoly:

[legend]List of all members.

Public Member Functions
	NPoly (const xType *const *arXn, const yType *arYn, const int *arNn, const int *arOn, int nDimen)
	NPoly (const xType *const *arXn, const yType *arYn, const int *arNn, int nDimen)
	NPoly (const NIntp< xType, yType > &ni)
	NPoly (const NPoly< xType, yType > &ni)
NPoly< xType, yType > *	reduce (NPoly< xType, yType > *&np, yType *&arYm, xType x0)
	~NPoly (void)

---

Detailed Description

template<typename xType, typename yType>
class calc::NPoly< xType, yType >

Class template interpolates multi-dimensional data with polynomials.

This class implements arrays of single-dimension interpolation polynomial (calc::Poly) objects for multi-dimensional interpolation tables. All of the data capabilities and restrictions inherent in interpolation polynomial (calc::Poly) objects carry through to multi-dimensional polynomial interpolations.

The declaration typename <xType> specifies the form of independent variables used in interpolation calculations. The declaration typename <yType> specifies the form of solution variables used in interpolation calculations. In general, the <yType> variables should be the equal or superset of the <xType> variables.

Author

efgeorge

Date

2006/07/18 01:45:34

Revision

1.2

Examples:

example_NIntp.txt.

---

Constructor & Destructor Documentation

NPoly

(

const NPoly< xType, yType > &

ni

)

Copy constructor initializes an n-Dimension polynomial interpolation object from the specified existing interpolation object.

Parameters:

ni

a reference to an n-Dimension polynomial interpolation object

NPoly

(

const NIntp< xType, yType > &

ni

)

Copy constructor initializes an n-Dimension polynomial interpolation object from the specified existing interpolation object.

Parameters:

ni

a reference to an n-Dimension polynomial interpolation object

~NPoly

(

void

)

Destructor frees allocated memory.

NPoly	(	const xType *const *	arXn,
		const yType *	arYn,
		const int *	arNn,
		int	nDimen
	)

Constructor initializes an n-Dimension polynomial interpolation object using the default polynomial control point count.

Parameters:

	arXn	a pointer to an n-Dimension independent value interpolation array (x units)
	arYn	a pointer to an n-Dimension dependent value interpolation array (y units)
	arNn	a pointer to an array containing data counts by dimension for the specified arrays arXn and arYn
	nDimen	number of dimensions

Remarks:

• The specified interpolation table dimension nDimen must be greater than zero.
• All entries in the data counts by dimension array arNn must be greater than zero, and correspond to the point count of the independent interpolation array arXn.
• For the default polynomial point count used in interpolation, see Poly::Poly().

NPoly	(	const xType *const *	arXn,
		const yType *	arYn,
		const int *	arNn,
		const int *	arOn,
		int	nDimen
	)

Constructor initializes an n-Dimension polynomial interpolation object with the specified polynomial point count by dimension array.

Parameters:

	arXn	a pointer to an n-Dimension independent value interpolation array (x units)
	arYn	a pointer to an n-Dimension dependent value interpolation array (y units)
	arNn	a pointer to an array containing data counts by dimension for the specified arrays arXn and arYn
	arOn	a pointer to an n-Dimension polynomial point count by dimension array
	nDimen	number of dimensions

Remarks:

• The specified interpolation table dimension nDimen must be greater than zero.
• All entries in the data counts by dimension array arNn must be greater than zero, and correspond to the point count of the independent interpolation array arXn.
• The polynomial point count for each dimension is constant.
• For restrictions on the polynomial point count used in interpolation, see Poly::Poly().

---

Member Function Documentation

calc::NPoly< xType, yType > * reduce	(	NPoly< xType, yType > *&	np,
		yType *&	arYm,
		xType	x0
	)

Function reduces the object's interpolation table by one dimension.

Parameters:

	x0	interpolation value to reduce the first dimension at (x units)
	np	a pointer reference to an uninitialized interpolation object to store the calculated data in
	arYm	a pointer reference to the calculated reduced dimension dependent interpolation array evaluated at x0 (y units)

Returns:

the value of the pointer np

Remarks:

• If there is an error in the function execution, the function returns a null pointer.
• The first dimension is evaluated at the specified value x0.
• Memory is allocated to the pointers arYm and np.
• The interpolation table is stored in the pointer arYm.
• Reduced object data is stored in the pointer np.

---

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

• NIntp.h
• NPoly.cpp

---