STK_IRegress.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2010  Serge Iovleff

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

 This program 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 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with this program; if not, write to the
 Free Software Foundation, Inc.,
 59 Temple Place,
 Suite 330,
 Boston, MA 02111-1307
 USA

 Contact : Serge.Iovleff@stkpp.org
 */

/*
 * Project:  stkpp::Regress
 * created on: 23 juin 2010
 * Purpose:  Interface base class for regression methods.
 * Author:   iovleff, serge.iovleff@stkpp.org
 **/

#ifndef STK_IREGRESS_H
#define STK_IREGRESS_H

#include "../../Algebra/include/STK_Vector.h"
#include "../../Algebra/include/STK_TExpAlgebra.h"

namespace STK
{

template <class YContainer, class XContainer>
class IRegress
{
  protected:
    YContainer const* p_y_;
    XContainer const* p_x_;
    Vector const* p_weights_;
    YContainer* p_predicted_;
    YContainer* p_residuals_;

  public:
    IRegress( YContainer const* p_y =0, XContainer const* p_x =0)
            : p_y_(p_y)
            , p_x_(p_x)
            , p_weights_(0)
            , p_predicted_(0)
            , p_residuals_(0)
    { ;}

    virtual ~IRegress()
    { clear();}

    void run()
    {
      // remove any existing storage
      clear();
      // compute regression
      regression();
      // predictions
      prediction();
      // compute residuals
      residuals();
    }

    void run( Vector const* p_weights)
    {
      // set weights
      p_weights_ = p_weights;
      // remove any existing storage
      clear();
      // compute weighted regression
      wregression();
      // create container of the predicted value and compute prediction
      prediction();
      // create container of the residuals and compute them
      residuals();
    }

    inline YContainer* p_predicted() const
    { return p_predicted_;}
    inline YContainer* p_residuals() const
    {  return p_residuals_;}

    void setData( YContainer const* p_y, XContainer const* p_x)
    { p_y_ = p_y; p_x_ = p_x;}

    void setY( YContainer const* p_y)
    { p_y_ = p_y;}

    void setX( XContainer const* p_x)
    { p_x_ = p_x;}

  protected:
    virtual void preWork()
    { }

    inline void residuals()
    {
       p_residuals_ =  p_y_->clone();
      *p_residuals_ = *p_y_ - *p_predicted_;
    }

  private:
    virtual void regression() =0;
    virtual void wregression() =0;
    virtual void prediction() =0;
    void clear()
    {
      if (p_predicted_) delete p_predicted_;
      if (p_residuals_) delete p_residuals_;
      p_predicted_ = 0;
      p_residuals_ = 0;
    }

};

}

#endif /* STK_IREGRESS_H */