simgear/math/leastsqs.hxx

   1 // leastsqs.h -- Implements a simple linear least squares best fit routine
   2 //
   3 // Written by Curtis Olson, started September 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   6 //
   7 // This library is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU Library General Public
   9 // License as published by the Free Software Foundation; either
  10 // version 2 of the License, or (at your option) any later version.
  11 //
  12 // This library is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // Library General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Library General Public
  18 // License along with this library; if not, write to the
  19 // Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20 // Boston, MA  02111-1307, USA.
  21 //
  22 // $Id$
  23 ///
  24
  25
  26 #ifndef _LEASTSQS_H
  27 #define _LEASTSQS_H
  28
  29
  30 #ifndef __cplusplus
  31 # error This library requires C++
  32 #endif
  33
  34
  35 /*
  36 Least squares fit:
  37
  38 y = b0 + b1x
  39
  40      n*sum(xi*yi) - (sum(xi)*sum(yi))
  41 b1 = --------------------------------
  42      n*sum(xi^2) - (sum(xi))^2
  43
  44
  45 b0 = sum(yi)/n - b1*(sum(xi)/n)
  46 */
  47
  48 void least_squares(double *x, double *y, int n, double *m, double *b);
  49
  50 /* incrimentally update existing values with a new data point */
  51 void least_squares_update(double x, double y, double *m, double *b);
  52
  53
  54 /*
  55   return the least squares error:
  56
  57               (y[i] - y_hat[i])^2
  58               -------------------
  59                       n
  60 */
  61 double least_squares_error(double *x, double *y, int n, double m, double b);
  62
  63
  64 /*
  65   return the maximum least squares error:
  66
  67               (y[i] - y_hat[i])^2
  68 */
  69 double least_squares_max_error(double *x, double *y, int n, double m, double b);
  70
  71
  72 #endif // _LEASTSQS_H
  73
  74