newton_method_jacobian_functions.h

/* Copyright (C) 2004-2012 MBSim Development Team
 *
 * This library 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.1 of the License, or (at your option) any later version.
 *
 * This 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * Contact: martin.o.foerg@googlemail.com
 */
 
#ifndef NUMERICSNEWTONMEHTODFUNCTION_H_
#define NUMERICSNEWTONMEHTODFUNCTION_H_
 
#include <fmatvec/fmatvec.h>
#include <mbsim/functions/function.h>
 
namespace MBSim {
 
  class NewtonJacobianFunction : public Function<fmatvec::SqrMat(fmatvec::Vec)> {
    public:
    NewtonJacobianFunction();
 
    /*
     * \brief destructor
     */
    ~NewtonJacobianFunction() override = default;
 
    /* GETTER / SETTER*/
    virtual void setFunction(Function<fmatvec::Vec(fmatvec::Vec)> * function_) {
      function = function_;
    }
    /*****************/
 
    /*INHERITED INTERFACE*/
    fmatvec::SqrMat operator ()(const fmatvec::Vec &x) override = 0;
    /*********************/
 
    protected:
    Function<fmatvec::Vec(fmatvec::Vec)> *function;
  };
 
  class NumericalNewtonJacobianFunction : public NewtonJacobianFunction {
    public:
      NumericalNewtonJacobianFunction();
 
      /*
       * \brief destructor
       */
      ~NumericalNewtonJacobianFunction() override = default;
 
      /*INHERITED INTERFACE*/
      fmatvec::SqrMat operator ()(const fmatvec::Vec &x) override;
  };
 
//  /*!
//   * \brief class to compute a Jacobian matrix once at the beginning and then uses it over and over again
//   *
//   * \todo: implement
//   */
//  class ConstantNewtonJacobianFunction : public NewtonJacobianFunction {
//    public:
//      /**
//       * \brief constructor
//       */
//      ConstantNewtonJacobianFunction();
//
//      /*
//       * \brief destructor
//       */
//      virtual ~ConstantNewtonJacobianFunction() {
//      }
//
//      /*INHERITED INTERFACE*/
//      virtual fmatvec::SqrMat operator ()(const fmatvec::Vec &x, Function<fmatvec::Vec(fmatvec::Vec)> *function);
//
//  };
 
//  /*!
//   * \brief class use the identity matrix as Jacobian matrix in the newton method yields a fixpoint iteration
//   *
//   * \todo: implement
//   */
//  class FixpointNewtonJacobianFunction : public NewtonJacobianFunction {
//    public:
//      /**
//       * \brief constructor
//       */
//      FixpointNewtonJacobianFunction();
//
//      /*
//       * \brief destructor
//       */
//      virtual ~FixpointNewtonJacobianFunction() {
//      }
//
//      /*INHERITED INTERFACE*/
//      virtual fmatvec::SqrMat operator ()(const fmatvec::Vec &x, Function<fmatvec::Vec(fmatvec::Vec)> *function);
//  };
}
#endif // NUMERICSNEWTONMEHTODFUNCTION_H_