polyfit.h

Go to the documentation of this file.

//! @file polyfit.h

// This file is part of Cantera. See License.txt in the top-level directory or
// at http://www.cantera.org/license.txt for license and copyright information.

#ifndef CT_POLYFIT_H
#define CT_POLYFIT_H

#include "cantera/base/ct_defs.h"

namespace Cantera
{

//! Fits a polynomial function to a set of data points
/*!
 * Given a collection of *n* points *x* and a set of values *y* of some function
 * evaluated at those points, this function computes the weighted least-squares
 * polynomial fit of degree *deg*:
 *
 * \f[ f(x) = p[0] + p[1]*x + p[2]*x^2 + \cdots + p[deg]*x^deg \f]
 *
 * @param n    The number of points at which the function is evaluated
 * @param deg  The degree of the polynomial fit to be computed. deg <= n - 1.
 * @param x    Array of points at which the function is evaluated. Length *n*.
 * @param y    Array of function values at the points in *x*. Length *n*.
 * @param w    Array of weights. If w == nullptr or w[0] < 0, then all the
 *     weights will be set to 1.0.
 * @param[out] p  Array of polynomial coefficients, starting with the constant
 *     term. Length *deg+1*.
 * @returns the root mean squared error of the fit at the input points.
 */
double polyfit(size_t n, size_t deg, const double* x, const double* y,
               const double* w, double* p);

//! Fits a polynomial function to a set of data points
/*!
 * @deprecated The ndeg and eps arguments to polyfit are deprecated and unused.
 *     Use the form of polyfit with signature polyfit(n, deg, x, y, w, p). To be
 *     removed after Cantera 2.3.
 */
doublereal polyfit(int n, doublereal* x, doublereal* y, doublereal* w,
                   int maxdeg, int& ndeg, doublereal eps, doublereal* r);
}
#endif