OneDimensional.h

#ifndef _theplu_yat_regression_onedimensional_
#define _theplu_yat_regression_onedimensional_

// $Id: OneDimensional.h 2564 2011-09-25 20:03:41Z peter $

/*
  Copyright (C) 2004 Peter Johansson
  Copyright (C) 2005, 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
  Copyright (C) 2011 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 3 of the
  License, or (at your option) any later version.

  The yat library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include "yat/statistics/AveragerPair.h"

#include <iosfwd>

namespace theplu {
namespace yat {
namespace utility {
  class VectorBase;
}
namespace regression {

  class OneDimensional 
  {

  public:
    OneDimensional(void);

    virtual ~OneDimensional(void);
 
    double chisq(void) const;
    
    virtual void fit(const utility::VectorBase& x, 
                     const utility::VectorBase& y)=0; 
    
    virtual double predict(const double x) const=0;
    
    double prediction_error2(const double x) const; 

    std::ostream& print(std::ostream& os,const double min, 
                        double max, const unsigned int n) const;

    double r2(void) const;

    virtual double s2(void) const=0;

    virtual double standard_error2(const double x) const=0;

  protected:
    double variance(void) const;

    statistics::AveragerPair ap_;

    double chisq_;
  };

}}} // of namespaces regression, yat, and theplu

#endif