Polynomials

Functions
cpl_error_code	cpl_polynomial_add (cpl_polynomial *self, const cpl_polynomial *first, const cpl_polynomial *second)
	Add two polynomials of the same dimension. More...
int	cpl_polynomial_compare (const cpl_polynomial *p1, const cpl_polynomial *p2, double tol)
	Compare the coefficients of two polynomials. More...
cpl_error_code	cpl_polynomial_copy (cpl_polynomial *out, const cpl_polynomial *in)
	This function copies contents of a polynomial into another one. More...
void	cpl_polynomial_delete (cpl_polynomial *p)
	Delete a cpl_polynomial. More...
cpl_error_code	cpl_polynomial_derivative (cpl_polynomial *self, cpl_size dim)
	Compute a first order partial derivative. More...
cpl_error_code	cpl_polynomial_dump (const cpl_polynomial *p, FILE *stream)
	Dump a cpl_polynomial as ASCII to a stream. More...
cpl_polynomial *	cpl_polynomial_duplicate (const cpl_polynomial *p)
	This function duplicates an existing polynomial. More...
double	cpl_polynomial_eval (const cpl_polynomial *p, const cpl_vector *x)
	Evaluate the polynomial at the given point. More...
double	cpl_polynomial_eval_1d (const cpl_polynomial *self, double x, double *pd)
	Evaluate a univariate (1D) polynomial using Horners rule. More...
double	cpl_polynomial_eval_1d_diff (const cpl_polynomial *self, double a, double b, double *ppa)
	Evaluate p(a) - p(b) using Horners rule. More...
cpl_polynomial *	cpl_polynomial_extract (const cpl_polynomial *self, cpl_size dim, const cpl_polynomial *other)
	Collapse one dimension of a multi-variate polynomial by composition. More...
cpl_error_code	cpl_polynomial_fit (cpl_polynomial *self, const cpl_matrix *samppos, const cpl_boolean *sampsym, const cpl_vector *fitvals, const cpl_vector *fitsigm, cpl_boolean dimdeg, const cpl_size *mindeg, const cpl_size *maxdeg)
	Fit a polynomial to a set of samples in a least squares sense. More...
cpl_polynomial *	cpl_polynomial_fit_1d_create (const cpl_vector *x_pos, const cpl_vector *values, cpl_size degree, double *mse)
	Fit a 1D-polynomial to a 1D-signal in a least squares sense. More...
cpl_polynomial *	cpl_polynomial_fit_2d_create (cpl_bivector *xy_pos, cpl_vector *values, cpl_size degree, double *mse)
	Fit a 2D-polynomial to a 2D-surface in a least squares sense. More...
double	cpl_polynomial_get_coeff (const cpl_polynomial *in, const cpl_size *pows)
	Get a coefficient of the polynomial. More...
cpl_size	cpl_polynomial_get_degree (const cpl_polynomial *p)
	The degree of the polynomial. More...
cpl_size	cpl_polynomial_get_dimension (const cpl_polynomial *p)
	The dimension of the polynomial. More...
cpl_error_code	cpl_polynomial_multiply_scalar (cpl_polynomial *self, const cpl_polynomial *other, double factor)
	Multiply a polynomial with a scalar. More...
cpl_polynomial *	cpl_polynomial_new (cpl_size dim)
	Create a new cpl_polynomial. More...
cpl_error_code	cpl_polynomial_set_coeff (cpl_polynomial *in, const cpl_size *pows, double c)
	Set a coefficient of the polynomial. More...
cpl_error_code	cpl_polynomial_shift_1d (cpl_polynomial *p, cpl_size i, double u)
	Modify p, p(x0, x1, ..., xi, ...) := (x0, x1, ..., xi+u, ...) More...
cpl_error_code	cpl_polynomial_solve_1d (const cpl_polynomial *p, double x0, double *px, cpl_size mul)
	A real solution to p(x) = 0 using Newton-Raphsons method. More...
cpl_error_code	cpl_polynomial_subtract (cpl_polynomial *self, const cpl_polynomial *first, const cpl_polynomial *second)
	Subtract two polynomials of the same dimension. More...
cpl_error_code	cpl_vector_fill_polynomial (cpl_vector *v, const cpl_polynomial *p, double x0, double d)
	Evaluate a 1D-polynomial on equidistant points using Horners rule. More...
cpl_error_code	cpl_vector_fill_polynomial_fit_residual (cpl_vector *self, const cpl_vector *fitvals, const cpl_vector *fitsigm, const cpl_polynomial *fit, const cpl_matrix *samppos, double *rechisq)
	Compute the residual of a polynomial fit. More...

Detailed Description

This module provides functions to handle uni- and multivariate polynomials.

Univariate (1D) polynomials use the Horner rule for evaluation, while multivariate polynomials are evaluated simply as the sum of each term.

This means that of the two polynomials

* P1(x) = p0 + p1.x + p4.x^2
* 

and

* P2(x,y) = p0 + p1.x + p2.y + p3.x.y + p4.x^2 + p5.y^2
* 

P1(x) may evaluate to more accurate results than P2(x,0), especially around the roots.

Note that a polynomial like P3(z) = p0 + p1.z + p2.z^2 + p3.z^3, z=x^4 is preferable to p4(x) = p0 + p1.x^4 + p2.x^8 + p3.x^12.

Function Documentation

cpl_error_code cpl_polynomial_add	(	cpl_polynomial *	self,
		const cpl_polynomial *	first,
		const cpl_polynomial *	second
	)

Add two polynomials of the same dimension.

Parameters

self	The polynomial to hold the result
first	The 1st polynomial to add
second	The 2nd polynomial to add

Returns

CPL_ERROR_NONE or the relevant CPL error code

Note

self may be passed also as first and/or second

Possible CPL error code set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_INCOMPATIBLE_INPUT if the polynomials do not have identical dimensions
• CPL_ERROR_UNSUPPORTED_MODE if the dimension is not 1 (FIXME)

References cpl_ensure_code, CPL_ERROR_INCOMPATIBLE_INPUT, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, CPL_ERROR_UNSUPPORTED_MODE, cpl_polynomial_get_coeff(), cpl_polynomial_get_degree(), cpl_polynomial_get_dimension(), and cpl_polynomial_set_coeff().

int cpl_polynomial_compare	(	const cpl_polynomial *	p1,
		const cpl_polynomial *	p2,
		double	tol
	)

Compare the coefficients of two polynomials.

Parameters

p1	the 1st polynomial
p2	the 2nd polynomial
tol	The absolute (non-negative) tolerance

Returns

0 when equal, positive when different, negative on error.

The two polynomials are considered equal iff they have identical dimensions and the absolute difference between their coefficients does not exceed the tolerance.

This means that the following pair of polynomials per definition are considered different: P1(x1,x2) = 3*x1 different from P2(x1) = 3*x1.

If all parameters are valid and p1 and p2 point to the same polynomial the functions returns 0.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_ILLEGAL_INPUT if tol is negative

References cpl_calloc(), cpl_ensure, CPL_ERROR_ILLEGAL_INPUT, CPL_ERROR_NULL_INPUT, and cpl_free().

cpl_error_code cpl_polynomial_copy	(	cpl_polynomial *	out,
		const cpl_polynomial *	in
	)

This function copies contents of a polynomial into another one.

Parameters

out	Pre-allocated output cpl_polynomial
in	Input cpl_polynomial

Returns

CPL_ERROR_NONE or the relevant _cpl_error_code_

in and out must point to different polynomials.

If out already contains coefficients, they are overwritten.

This is the only function that can modify the dimension of a polynomial.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_INCOMPATIBLE_INPUT if in and out point to the same polynomial

References cpl_ensure_code, CPL_ERROR_INCOMPATIBLE_INPUT, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, cpl_free(), cpl_malloc(), cpl_polynomial_delete(), cpl_polynomial_duplicate(), and cpl_realloc().

Referenced by cpl_wlcalib_find_best_1d().

void cpl_polynomial_delete

(

cpl_polynomial *

p

)

Delete a cpl_polynomial.

Parameters

p	cpl_polynomial to delete

Returns

void

The function deallocates the memory used by the polynomial p. If p is NULL, nothing is done, and no error is set.

References cpl_free().

Referenced by cpl_image_fill_jacobian_polynomial(), cpl_polynomial_copy(), cpl_polynomial_fit_1d_create(), cpl_polynomial_fit_2d_create(), cpl_polynomial_shift_1d(), cpl_ppm_match_points(), and cpl_wlcalib_find_best_1d().

cpl_error_code cpl_polynomial_derivative	(	cpl_polynomial *	self,
		cpl_size	dim
	)

Compute a first order partial derivative.

Parameters

self	The polynomial to be modified in place
dim	The dimension to differentiate (zero for first dimension)

Returns

CPL_ERROR_NONE or the relevant _cpl_error_code_

The dimension of the polynomial is preserved, even if the operation may cause the polynomial to become independent of the dimension dim of the variable.

The call requires n FLOPs, where n is the number of (non-zero) polynomial coefficients whose power in dimension dim is at least 1.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_ILLEGAL_INPUT if dim is negative.
• CPL_ERROR_ACCESS_OUT_OF_RANGE if dim exceeds the dimension of self.

References cpl_ensure_code, CPL_ERROR_ACCESS_OUT_OF_RANGE, CPL_ERROR_ILLEGAL_INPUT, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, and cpl_realloc().

Referenced by cpl_image_fill_jacobian_polynomial().

cpl_error_code cpl_polynomial_dump	(	const cpl_polynomial *	p,
		FILE *	stream
	)

Dump a cpl_polynomial as ASCII to a stream.

Parameters

p	Input cpl_polynomial to dump
stream	Output stream, accepts stdout or stderr

Returns

CPL_ERROR_NONE or the relevant _cpl_error_code_

Each coefficient is preceded by its integer power(s) and written on a single line. If the polynomial has non-zero coefficients, only those are printed, otherwise the (zero-valued) constant term is printed.

Comment lines start with the hash character.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_FILE_IO if the write operation fails

References cpl_ensure_code, CPL_ERROR_FILE_IO, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, and CPL_SIZE_FORMAT.

cpl_polynomial* cpl_polynomial_duplicate

(

const cpl_polynomial *

p

)

This function duplicates an existing polynomial.

Parameters

p	The input cpl_polynomial

Returns

A newly allocated cpl_polynomial or NULL on error

Notice that the returned object is a newly allocated cpl_polynomial that must be deallocated by the caller using cpl_polynomial_delete().

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL

References cpl_ensure, CPL_ERROR_NULL_INPUT, cpl_malloc(), and cpl_polynomial_new().

Referenced by cpl_image_fill_jacobian_polynomial(), and cpl_polynomial_copy().

double cpl_polynomial_eval	(	const cpl_polynomial *	p,
		const cpl_vector *	x
	)

Evaluate the polynomial at the given point.

Parameters

p	The polynomial
x	Point of evaluation

Returns

The computed value or undefined on error.

The length of x must be the polynomial dimension.

A polynomial with no non-zero coefficients evaluates as 0.

If the classical evaluation method is used, the computational cost is:

For 1-dimensional polynomials the call requires 2n FLOPs where n+1 is the number of coefficients in p, see also cpl_polynomial_eval_1d().

For multivariate polynomials the call requires n*(1+dim) + d_1 + d_2 + ... + d_dim FLOPs, where dim is the dimension, n is the number of coefficients in p and d_i is the highest power used in dimension i, i = 1, 2, ..., dim.

If the Horner evaluation method is used the complexity has not been studied yet.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_INCOMPATIBLE_INPUT if the length of x differs from the dimension of the polynomial

References cpl_ensure, CPL_ERROR_INCOMPATIBLE_INPUT, CPL_ERROR_NULL_INPUT, cpl_polynomial_eval_1d(), cpl_vector_get(), and cpl_vector_get_size().

Referenced by cpl_image_fill_jacobian_polynomial(), and cpl_vector_fill_polynomial_fit_residual().

double cpl_polynomial_eval_1d	(	const cpl_polynomial *	self,
		double	x,
		double *	pd
	)

Evaluate a univariate (1D) polynomial using Horners rule.

Parameters

self	The 1D-polynomial
x	The point of evaluation
pd	Iff pd is non-NULL, the derivative evaluated at x

Returns

The result or undefined on error.

A polynomial with no non-zero coefficents evaluates to 0 with a derivative that does likewise.

The result is computed as p_0 + x * ( p_1 + x * ( p_2 + ... x * p_n )) and requires 2n FLOPs where n+1 is the number of coefficients.

If the derivative is requested it is computed using a nested Horner rule. This requires 4n FLOPs in total.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_INVALID_TYPE if the polynomial is not (1D) univariate

References cpl_ensure, CPL_ERROR_INVALID_TYPE, and CPL_ERROR_NULL_INPUT.

Referenced by cpl_polynomial_eval(), cpl_vector_fill_polynomial(), and cpl_wlcalib_find_best_1d().

double cpl_polynomial_eval_1d_diff	(	const cpl_polynomial *	self,
		double	a,
		double	b,
		double *	ppa
	)

Evaluate p(a) - p(b) using Horners rule.

Parameters

self	The 1D-polynomial
a	The evaluation point of the minuend
b	The evaluation point of the subtrahend
ppa	Iff ppa is not NULL, p(a)

Returns

The difference or undefined on error

The call requires about 4n FLOPs where n is the number of coefficients in self, which is the same as that required for two separate polynomial evaluations. cpl_polynomial_eval_1d_diff() is however more accurate.

ppa may be NULL. If it is not, *ppa is set to self(a), which is calculated at no extra cost.

The underlying algorithm is the same as that used in cpl_polynomial_eval_1d() when the derivative is also requested.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_INVALID_TYPE if the polynomial has the wrong dimension

References cpl_ensure, CPL_ERROR_INVALID_TYPE, and CPL_ERROR_NULL_INPUT.

cpl_polynomial* cpl_polynomial_extract	(	const cpl_polynomial *	self,
		cpl_size	dim,
		const cpl_polynomial *	other
	)

Collapse one dimension of a multi-variate polynomial by composition.

Parameters

self	The multi-variate polynomial
dim	The dimension to collapse (zero for first dimension)
other	The polynomial to replace dimension dim of self

Returns

The collapsed polynomial or NULL on error

The dimension of the polynomial self must be one greater than that of the other polynomial. Given these two polynomials the dimension dim of self is collapsed by creating a new polynomial from self(x0, x1, ..., x{dim-1}, other(x0, x1, ..., x{dim-1}, x{dim+1}, x{dim+2}, ..., x{n-1}), x{dim+1}, x{dim+2}, ..., x{n-1}).

The created polynomial thus has a dimension which is one less than the polynomial self and which is equal to that of the other polynomial. Collapsing one dimension of a 1D-polynomial is equivalent to evaluating it, which can be done with cpl_polynomial_eval_1d().

FIXME: The other polynomial must currently have a degree of zero, i.e. it must be a constant.

Currently, the call requires dn + p FLOPs, where d the dimension of the polynomial self, p is the largest power of dimension dim and n the number of (non-zero) coefficients of the polynomial self.

The returned object is a newly allocated cpl_polynomial that must be deallocated by the caller using cpl_polynomial_delete().

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_INVALID_TYPE if the polynomial is uni-variate.
• CPL_ERROR_ILLEGAL_INPUT if dim is negative.
• CPL_ERROR_ACCESS_OUT_OF_RANGE if dim exceeds the dimension of self.
• CPL_ERROR_INCOMPATIBLE_INPUT if other has the wrong dimension.
• CPL_ERROR_UNSUPPORTED_MODE if other is not of degree 0.

References cpl_ensure, CPL_ERROR_ACCESS_OUT_OF_RANGE, CPL_ERROR_ILLEGAL_INPUT, CPL_ERROR_INCOMPATIBLE_INPUT, CPL_ERROR_INVALID_TYPE, CPL_ERROR_NULL_INPUT, CPL_ERROR_UNSUPPORTED_MODE, cpl_free(), cpl_malloc(), cpl_polynomial_get_coeff(), cpl_polynomial_get_degree(), cpl_polynomial_new(), and cpl_polynomial_set_coeff().

cpl_error_code cpl_polynomial_fit	(	cpl_polynomial *	self,
		const cpl_matrix *	samppos,
		const cpl_boolean *	sampsym,
		const cpl_vector *	fitvals,
		const cpl_vector *	fitsigm,
		cpl_boolean	dimdeg,
		const cpl_size *	mindeg,
		const cpl_size *	maxdeg
	)

Fit a polynomial to a set of samples in a least squares sense.

Parameters

self	Polynomial of dimension d to hold the coefficients
samppos	Matrix of p sample positions, with d rows and p columns
sampsym	NULL, or d booleans, true iff the sampling is symmetric
fitvals	Vector of the p values to fit
fitsigm	Uncertainties of the sampled values, or NULL for all ones
dimdeg	True iff there is a fitting degree per dimension
mindeg	Pointer to 1 or d minimum fitting degree(s), or NULL
maxdeg	Pointer to 1 or d maximum fitting degree(s), at least mindeg

Returns

CPL_ERROR_NONE on success, else the relevant _cpl_error_code_

Note

Currently only uni- and bi-variate polynomials are supported, fitsigm must be NULL. For all but uni-variate polynomials mindeg must be zero.

See also

cpl_vector_fill_polynomial_fit_residual()

Any pre-set non-zero coefficients in self are overwritten or reset by the fit.

For 1D-polynomials N = 1 + maxdeg - mindeg coefficients are fitted.

For multi-variate polynomials the fit depends on dimdeg:

If dimdeg is false, an n-degree coefficient is fitted iff mindeg <= n <= maxdeg. For a 2D-polynomial this means that N * (N + 1) / 2 coefficients are fitted.

If dimdeg is true, nci = 1 + maxdeg[i] + mindeg[i] coefficients are fitted for dimension i, i.e. for a 2D-polynomial N = nc1 * nc2 coefficients are fitted.

The number of distinct samples should exceed the number of coefficients to fit. The number of distinct samples may also equal the number of coefficients to fit, but in this case the fit has another meaning (any non-zero residual is due to rounding errors, not a fitting error). It is an error to try to fit more coefficients than there are distinct samples.

If the relative uncertainties of the sampled values are known, they may be passed via fitsigm. NULL means that all uncertainties equals one.

symsamp is ignored if mindeg is nonzero, otherwise the caller may use sampsym to indicate an a priori knowledge that the sampling positions are symmetric. NULL indicates no knowledge of such symmetry. sampsym[i] may be set to true iff the sampling is symmetric around u_i, where u_i is the mean of the sampling positions in dimension i.

In 1D this implies that the sampling points as pairs average u_0 (with an odd number of samples one sample must equal u_0). E.g. both x = (1, 2, 4, 6, 7) and x = (1, 6, 4, 2, 7) have sampling symmetry, while x = (1, 2, 4, 6) does not.

In 2D this implies that the sampling points are symmetric in the 2D-plane. For the first dimension sampling symmetry means that the sampling is line- symmetric around y = u_1, while for the second dimension, sampling symmetry implies line-symmetry around x = u_2. Point symmetry around (x,y) = (u_1, u_2) means that both sampsym[0] and sampsym[1] may be set to true.

Knowledge of symmetric sampling allows the fit to be both faster and eliminates certain round-off errors.

For higher order fitting the fitting problem known as "Runge's phenomenon" is minimized using the socalled "Chebyshev nodes" as sampling points. For Chebyshev nodes symsamp can be set to CPL_TRUE.

Warning: An increase in the polynomial degree will normally reduce the fitting error. However, due to rounding errors and the limited accuracy of the solver of the normal equations, an increase in the polynomial degree may at some point cause the fitting error to increase. In some cases this happens with an increase of the polynomial degree from 8 to 9.

The fit is done in the following steps: 1) If mindeg is zero, the sampling positions are first transformed into Xhat_i = X_i - mean(X_i), i=1, .., dimension. 2) The Vandermonde matrix is formed from Xhat. 3) The normal equations of the Vandermonde matrix is solved. 4) If mindeg is zero, the resulting polynomial in Xhat is transformed back to X.

For a univariate (1D) fit the call requires 6MN + N^3/3 + 7/2N^2 + O(M) FLOPs where M is the number of data points and where N is the number of polynomial coefficients to fit, N = 1 + maxdeg - mindeg.

For a bivariate fit the call requires MN^2 + N^3/3 + O(MN) FLOPs where M is the number of data points and where N is the number of polynomial coefficients to fit.

Examples of usage:

cpl_polynomial  * fit1d     = cpl_polynomial_new(1);
cpl_matrix      * samppos1d = my_sampling_points_1d(); // 1-row matrix
cpl_vector      * fitvals   = my_sampling_values();
const cpl_boolean sampsym   = CPL_TRUE;
const int         maxdeg1d  = 4; // Fit 5 coefficients
cpl_error_code    error1d
    = cpl_polynomial_fit(fit1d, samppos1d, &sampsym, fitvals, NULL,
                         CPL_FALSE, NULL, &maxdeg1d);

cpl_polynomial  * fit2d      = cpl_polynomial_new(2);
cpl_matrix      * samppos2d  = my_sampling_points_2d(); // 2-row matrix
cpl_vector      * fitvals    = my_sampling_values();
const int         maxdeg2d[] = {2, 1}; // Fit 6 coefficients
cpl_error_code    error2d
    = cpl_polynomial_fit(fit2d, samppos2d, NULL, fitvals, NULL, CPL_FALSE,
                         NULL, maxdeg2d);

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_ILLEGAL_INPUT if a mindeg value is negative, or if a maxdeg value is less than the corresponding mindeg value.
• CPL_ERROR_DATA_NOT_FOUND if the number of columns in samppos is less than the number of coefficients to be determined.
• CPL_ERROR_INCOMPATIBLE_INPUT if samppos, fitvals or fitsigm have incompatible sizes, or if samppos, self or sampsym have incompatible sizes.
• CPL_ERROR_SINGULAR_MATRIX if samppos contains too few distinct values
• CPL_ERROR_DIVISION_BY_ZERO if an element in fitsigm is zero
• CPL_ERROR_UNSUPPORTED_MODE if the polynomial dimension exceeds two, or if there is a non-zero value in the mindeg array.

References cpl_bivector_unwrap_vectors(), cpl_bivector_wrap_vectors(), cpl_ensure_code, CPL_ERROR_INCOMPATIBLE_INPUT, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, CPL_ERROR_UNSUPPORTED_MODE, cpl_matrix_get_data(), cpl_matrix_get_ncol(), cpl_matrix_get_nrow(), cpl_polynomial_get_dimension(), CPL_SIZE_FORMAT, cpl_vector_get_size(), cpl_vector_unwrap(), and cpl_vector_wrap().

cpl_polynomial* cpl_polynomial_fit_1d_create	(	const cpl_vector *	x_pos,
		const cpl_vector *	values,
		cpl_size	degree,
		double *	mse
	)

Fit a 1D-polynomial to a 1D-signal in a least squares sense.

Parameters

x_pos	Vector of positions of the signal to fit.
values	Vector of values of the signal to fit.
degree	Non-negative polynomial degree.
mse	Iff mse is not null, the mean squared error on success

Returns

The fitted polynomial or NULL on error

See also

cpl_polynomial_fit()

Deprecated:

Replace this call with cpl_polynomial_fit() and optionally cpl_vector_fill_polynomial_fit_residual().

References CPL_ERROR_NONE, cpl_polynomial_delete(), and cpl_polynomial_new().

cpl_polynomial* cpl_polynomial_fit_2d_create	(	cpl_bivector *	xy_pos,
		cpl_vector *	values,
		cpl_size	degree,
		double *	mse
	)

Fit a 2D-polynomial to a 2D-surface in a least squares sense.

Parameters

xy_pos	Bivector positions of the surface to fit.
values	Vector of values of the surface to fit.
degree	Non-negative polynomial degree.
mse	Iff mse is not null, the mean squared error on success

Returns

The fitted polynomial or NULL on error

See also

cpl_polynomial_fit()

Deprecated:

Replace this call with cpl_polynomial_fit() and optionally cpl_vector_fill_polynomial_fit_residual().

References CPL_ERROR_NONE, cpl_polynomial_delete(), and cpl_polynomial_new().

double cpl_polynomial_get_coeff	(	const cpl_polynomial *	in,
		const cpl_size *	pows
	)

Get a coefficient of the polynomial.

Parameters

in	the input polynomial
pows	the powers of the different variables

Returns

The coefficient or undefined on error

The array pows must have the size of the polynomial dimension and have non-negative elements.

It is allowed to specify a (set of) power(s) for which no coefficient has previously been set. In this case the function returns zero.

Example of usage:

const cpl_size power       = 3;
double         coefficient = cpl_polynomial_get_coeff(poly1d, &power);

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_ILLEGAL_INPUT if pows contains negative values

References cpl_ensure, CPL_ERROR_ILLEGAL_INPUT, CPL_ERROR_NULL_INPUT, and CPL_SIZE_FORMAT.

Referenced by cpl_polynomial_add(), cpl_polynomial_extract(), cpl_polynomial_multiply_scalar(), cpl_polynomial_shift_1d(), and cpl_polynomial_subtract().

cpl_size cpl_polynomial_get_degree

(

const cpl_polynomial *

p

)

The degree of the polynomial.

Parameters

p	the polynomial

Returns

The degree or negative on error

The degree is the highest sum of exponents (with a non-zero coefficient).

If there are no non-zero coefficients the degree is zero.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL

References cpl_ensure, and CPL_ERROR_NULL_INPUT.

Referenced by cpl_polynomial_add(), cpl_polynomial_extract(), cpl_polynomial_multiply_scalar(), cpl_polynomial_shift_1d(), cpl_polynomial_subtract(), and cpl_wlcalib_find_best_1d().

cpl_size cpl_polynomial_get_dimension

(

const cpl_polynomial *

p

)

The dimension of the polynomial.

Parameters

p	the polynomial

Returns

The dimension or negative on error

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL

References cpl_ensure, and CPL_ERROR_NULL_INPUT.

Referenced by cpl_image_fill_jacobian_polynomial(), cpl_image_fill_polynomial(), cpl_image_warp_polynomial(), cpl_polynomial_add(), cpl_polynomial_fit(), cpl_polynomial_multiply_scalar(), cpl_polynomial_shift_1d(), cpl_polynomial_subtract(), cpl_vector_fill_polynomial_fit_residual(), and cpl_wlcalib_find_best_1d().

cpl_error_code cpl_polynomial_multiply_scalar	(	cpl_polynomial *	self,
		const cpl_polynomial *	other,
		double	factor
	)

Multiply a polynomial with a scalar.

Parameters

self	The polynomial to hold the result
other	The polynomial to scale, may equal self
factor	The factor to multiply with

Returns

CPL_ERROR_NONE or the relevant CPL error code

Possible CPL error code set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_UNSUPPORTED_MODE if the dimension is not 1 (FIXME)

References cpl_ensure_code, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, CPL_ERROR_UNSUPPORTED_MODE, cpl_polynomial_get_coeff(), cpl_polynomial_get_degree(), cpl_polynomial_get_dimension(), and cpl_polynomial_set_coeff().

cpl_polynomial* cpl_polynomial_new

(

cpl_size

dim

)

Create a new cpl_polynomial.

Parameters

dim	The positive polynomial dimension (number of variables)

Returns

1 newly allocated cpl_polynomial, or NULL on error

The returned object must be deallocated using cpl_polynomial_delete().

A newly created polynomial has degree 0 and evaluates as 0.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_ILLEGAL_INPUT if dim is negative or zero

References cpl_calloc(), cpl_ensure, and CPL_ERROR_ILLEGAL_INPUT.

Referenced by cpl_polynomial_duplicate(), cpl_polynomial_extract(), cpl_polynomial_fit_1d_create(), cpl_polynomial_fit_2d_create(), cpl_polynomial_shift_1d(), cpl_ppm_match_points(), and cpl_wlcalib_find_best_1d().

cpl_error_code cpl_polynomial_set_coeff	(	cpl_polynomial *	in,
		const cpl_size *	pows,
		double	c
	)

Set a coefficient of the polynomial.

Parameters

in	the input polynomial
pows	the powers of the different variables
c	the coefficient

Returns

CPL_ERROR_NONE or the relevant _cpl_error_code_

The array pows must have the size of the polynomial dimension and have non-negative elements.

If the coefficient is already there, it is overwritten, if not, a new coefficient is added to the polynomial. This may cause the degree of the polynomial to be increased.

Setting the coefficient of x1^4 * x3^2 in the 4-dimensional polynomial poly4d to 12.3 would be performed by:

const cpl_size pows[] = {4, 0, 2, 0};
cpl_error_code error  = cpl_polynomial_set_coeff(poly4d, pows, 12.3);

Setting the coefficient of x^3 in the 1-dimensional polynomial poly1d to 12.3 would be performed by:

const cpl_size power = 3;
cpl_error_code error = cpl_polynomial_set_coeff(poly1d, &power, 12.3);

For efficiency reasons the coefficients of a 1D-polynomial are best inserted with that of the highest power first.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_ILLEGAL_INPUT if pows contains negative values

References cpl_ensure_code, CPL_ERROR_ILLEGAL_INPUT, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, cpl_free(), cpl_malloc(), and cpl_realloc().

Referenced by cpl_polynomial_add(), cpl_polynomial_extract(), cpl_polynomial_multiply_scalar(), cpl_polynomial_shift_1d(), and cpl_polynomial_subtract().

cpl_error_code cpl_polynomial_shift_1d	(	cpl_polynomial *	p,
		cpl_size	i,
		double	u
	)

Modify p, p(x0, x1, ..., xi, ...) := (x0, x1, ..., xi+u, ...)

Parameters

p	The polynomial to be modified in place
i	The dimension to shift (0 for first)
u	The shift

Returns

CPL_ERROR_NONE or the relevant _cpl_error_code_

Note

Currently, only dimensions 1 and 2 are supported

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_ILLEGAL_INPUT if i is negative
• CPL_ERROR_ACCESS_OUT_OF_RANGE if i exceeds the dimension of p
• CPL_ERROR_UNSUPPORTED_MODE if the polynomial has a dimension larger than 2

References cpl_ensure_code, CPL_ERROR_ACCESS_OUT_OF_RANGE, CPL_ERROR_ILLEGAL_INPUT, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, CPL_ERROR_UNSUPPORTED_MODE, cpl_polynomial_delete(), cpl_polynomial_get_coeff(), cpl_polynomial_get_degree(), cpl_polynomial_get_dimension(), cpl_polynomial_new(), and cpl_polynomial_set_coeff().

Referenced by cpl_wlcalib_find_best_1d().

cpl_error_code cpl_polynomial_solve_1d	(	const cpl_polynomial *	p,
		double	x0,
		double *	px,
		cpl_size	mul
	)

A real solution to p(x) = 0 using Newton-Raphsons method.

Parameters

p	The 1D-polynomial
x0	First guess of the solution
px	The solution, on error see below
mul	The root multiplicity (or 1 if unknown)

Returns

CPL_ERROR_NONE or the relevant _cpl_error_code_

Even if a real solution exists, it may not be found if the first guess is too far from the solution. But a solution is guaranteed to be found if all roots of p are real. If the constant term is zero, the solution 0 will be returned regardless of the first guess.

No solution is found when the iterative process stops because: 1) It can not proceed because p`(x) = 0 (CPL_ERROR_DIVISION_BY_ZERO). 2) Only a finite number of iterations are allowed (CPL_ERROR_CONTINUE). Both cases may be due to lack of a real solution or a bad first guess. In these two cases *px is set to the value where the error occurred. In case of other errors *px is unmodified.

The accuracy and robustness deteriorates with increasing multiplicity of the solution. This is also the case with numerical multiplicity, i.e. when multiple solutions are located close together.

mul is assumed to be the multiplicity of the solution. Knowledge of the root multiplicity often improves the robustness and accuracy. If there is no knowledge of the root multiplicity mul should be 1. Setting mul to a too high value should be avoided.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_INVALID_TYPE if the polynomial has the wrong dimension
• CPL_ERROR_ILLEGAL_INPUT if the multiplicity is non-positive
• CPL_ERROR_DIVISION_BY_ZERO if a division by zero occurs
• CPL_ERROR_CONTINUE if the algorithm does not converge

References CPL_ERROR_NONE.

cpl_error_code cpl_polynomial_subtract	(	cpl_polynomial *	self,
		const cpl_polynomial *	first,
		const cpl_polynomial *	second
	)

Subtract two polynomials of the same dimension.

Parameters

self	The polynomial to hold the result
first	The polynomial to subtract from
second	The polynomial to subtract

Returns

CPL_ERROR_NONE or the relevant CPL error code

Note

self may be passed also as first and/or second

Possible CPL error code set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_INCOMPATIBLE_INPUT if the polynomials do not have identical dimensions
• CPL_ERROR_UNSUPPORTED_MODE if the dimension is not 1 (FIXME)

References cpl_ensure_code, CPL_ERROR_INCOMPATIBLE_INPUT, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, CPL_ERROR_UNSUPPORTED_MODE, cpl_polynomial_get_coeff(), cpl_polynomial_get_degree(), cpl_polynomial_get_dimension(), and cpl_polynomial_set_coeff().

cpl_error_code cpl_vector_fill_polynomial	(	cpl_vector *	v,
		const cpl_polynomial *	p,
		double	x0,
		double	d
	)

Evaluate a 1D-polynomial on equidistant points using Horners rule.

Parameters

v	Preallocated vector to contain the result
p	The 1D-polynomial
x0	The first point of evaluation
d	The increment between points of evaluation

Returns

CPL_ERROR_NONE or the relevant _cpl_error_code_

See also

cpl_vector_fill

The evaluation points are x_i = x0 + i * d, i=0, 1, ..., n-1, where n is the length of the vector.

If d is zero it is preferable to simply use cpl_vector_fill(v, cpl_polynomial_eval_1d(p, x0, NULL)).

The call requires about 2nm FLOPs, where m+1 is the number of coefficients in p.

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL
• CPL_ERROR_INVALID_TYPE if the polynomial has the wrong dimension

References cpl_ensure_code, CPL_ERROR_INVALID_TYPE, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, cpl_polynomial_eval_1d(), cpl_vector_get_data(), and cpl_vector_get_size().

cpl_error_code cpl_vector_fill_polynomial_fit_residual	(	cpl_vector *	self,
		const cpl_vector *	fitvals,
		const cpl_vector *	fitsigm,
		const cpl_polynomial *	fit,
		const cpl_matrix *	samppos,
		double *	rechisq
	)

Compute the residual of a polynomial fit.

Parameters

self	Vector to hold the fitting residuals, fitvals may be used
fitvals	Vector of the p fitted values
fitsigm	Uncertainties of the sampled values or NULL for a uniform uncertainty
fit	The fitted polynomial
samppos	Matrix of p sample positions, with d rows and p columns
rechisq	If non-NULL, the reduced chi square of the fit

Returns

CPL_ERROR_NONE on success, else the relevant _cpl_error_code_

Note

If necessary, self is resized to the length of fitvals.

See also

cpl_polynomial_fit()

It is allowed to pass the same vector as both fitvals and as self, in which case fitvals is overwritten with the residuals.

If the relative uncertainties of the sampled values are known, they may be passed via fitsigm. NULL means that all uncertainties equal one. The uncertainties are taken into account when computing the reduced chi square value.

If rechisq is non-NULL, the reduced chi square of the fit is computed as well.

The mean square error, which was computed directly by the former CPL functions cpl_polynomial_fit_1d_create() and cpl_polynomial_fit_2d_create() can be computed from the fitting residual like this:

const double mse = cpl_vector_product(fitresidual, fitresidual)
                 / cpl_vector_get_size(fitresidual);

Possible _cpl_error_code_ set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer (other than fitsigm) is NULL
• CPL_ERROR_INCOMPATIBLE_INPUT if samppos, fitvals, fitsigm or fit have incompatible sizes
• CPL_ERROR_DIVISION_BY_ZERO if an element in fitsigm is zero
• CPL_ERROR_DATA_NOT_FOUND if the number of columns in samppos is less than the number of coefficients in the fitted polynomial.

References cpl_ensure_code, CPL_ERROR_DATA_NOT_FOUND, CPL_ERROR_DIVISION_BY_ZERO, CPL_ERROR_INCOMPATIBLE_INPUT, CPL_ERROR_NONE, CPL_ERROR_NULL_INPUT, cpl_matrix_get(), cpl_matrix_get_ncol(), cpl_matrix_get_nrow(), cpl_polynomial_eval(), cpl_polynomial_get_dimension(), cpl_vector_delete(), cpl_vector_get(), cpl_vector_get_data(), cpl_vector_get_data_const(), cpl_vector_get_size(), cpl_vector_new(), cpl_vector_product(), and cpl_vector_set_size().