--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/polyfit.h Sat Oct 14 18:50:47 2023 +0200 @@ -0,0 +1,58 @@ +/** + * @brief Header file for MLS polynomial fitting. + * @file polyfit.h + * @author Henry Forson, Melbourne, FL + */ + + +//------------------------------------------------------------------------------------ +// MIT License +// +// Copyright (c) 2020 Henry M. Forson +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +//------------------------------------------------------------------------------------ + + +#ifndef POLYFIT_H +#define POLYFIT_H + +#include <QString> + + + +/** + * @namespace Polyfit + * + * @brief Global math functions. + */ +namespace Polyfit { + /** + * @brief Computes polynomial coefficients that best fit a set of input points. + * @param pointCount Number of points + * @param xValues Array of double values. + * @param yValues Array of double values. + * @param coefficientCount Number of coefficients in results. + * @param coefficientResults Array of coefficientCount double results. + * @return Error result, 0 is Ok. + */ + int polyfit( int pointCount, double *xValues, double *yValues, int coefficientCount, double *coefficientResults ); +} + +#endif // POLYFIT_H