PolynomialRegression.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLMath/src/ICLMath/PolynomialRegression.h             **
** Module : ICLMath                                                **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLMath/DynMatrix.h>
#include <vector>
#include <string>

namespace icl{

  namespace math{

    template<class T>
    struct PolynomialRegressionAttrib{
      virtual ~PolynomialRegressionAttrib(){}
      virtual T compute(const T *row) const = 0;
      virtual std::string toString() const = 0;
      virtual PolynomialRegressionAttrib<T> *copy() const = 0;
    };

    template<class T>
    class ICLMath_IMP PolynomialRegression{

      public:

      typedef DynMatrix<T> Matrix;

      typedef PolynomialRegressionAttrib<T> Attrib;


      class ICLMath_API Result{
        friend class PolynomialRegression;

        std::vector<const Attrib*> m_attribs;

        std::string m_function;

        mutable Matrix m_params;

        mutable Matrix m_xbuf, m_resultBuf;

        mutable int m_attribMaxIndex;

        void setup(const std::string &function);

        public:

        inline Result(){}

        Result(const std::string &xmlfilename);

        Result(const Result &r);

        Result &operator=(const Result &r);

        const Matrix &getParams() const { return m_params; }


        const Matrix &operator()(const Matrix &xs) const;

        std::vector<const Attrib*> getAttribs() const { return m_attribs; }

        std::string toString(const std::vector<std::string> &rowLabels=std::vector<std::string> ()) const;

        void save(const std::string &xmlFileName) const;
      };

      protected:

      mutable Matrix m_buf;

      Result m_result;


      public:

      PolynomialRegression(const std::string &function);



      const Result &apply(const Matrix &xs, const Matrix &ys, bool useSVD=false);

      std::string getFunctionString() const;
    };

  }
}