Lib/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 program is free software; you can redistribute it and/or modify
   8 // it under the terms of the GNU General Public License as published by
   9 // the Free Software Foundation; either version 2 of the License, or
  10 // (at your option) any later version.
  11 //
  12 // This program 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
  15 // GNU General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22 // (Log is kept at end of this file)
  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
  75 // $Log$
  76 // Revision 1.1  1999/03/13 17:34:45  curt
  77 // Moved to math subdirectory.
  78 //
  79 // Revision 1.2  1998/04/21 17:03:42  curt
  80 // Prepairing for C++ integration.
  81 //
  82 // Revision 1.1  1998/04/08 22:57:25  curt
  83 // Adopted Gnu automake/autoconf system.
  84 //
  85 // Revision 1.1  1998/03/19 02:54:48  curt
  86 // Reorganized into a class lib called fgDEM.
  87 //
  88 // Revision 1.1  1997/10/13 17:02:35  curt
  89 // Initial revision.
  90 //