Sacado_Tay_CacheTaylorExpr.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                           Sacado Package
//                 Copyright (2006) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
// (etphipp@sandia.gov).
//
// ***********************************************************************
// @HEADER

#ifndef SACADO_TAY_CACHETAYLOREXPR_HPP
#define SACADO_TAY_CACHETAYLOREXPR_HPP

#include "Sacado_Traits.hpp"

namespace Sacado {

  namespace Tay {


    template <typename ExprT>
    class Expr {

    public:

      typedef typename ExprT::value_type value_type;

      typedef typename ExprT::scalar_type scalar_type;

      typedef typename ExprT::base_expr_type base_expr_type;

      explicit Expr(const ExprT& expr) : expr_(expr) {}

      void allocateCache(unsigned int d) const { expr_.allocateCache(d); }

      unsigned int degree() const {return expr_.degree();}

      bool hasFastAccess(unsigned int d) const {
        return expr_.hasFastAccess(d);}

      value_type coeff(unsigned int i) const { return expr_.coeff(i);}

      value_type fastAccessCoeff(unsigned int i) const { return
          expr_.fastAccessCoeff(i);}

    protected:

      Expr() {}

      ExprT expr_;

    }; // class Expr


    template <typename ConstT>
    class ConstExpr {

    public:

      typedef ConstT value_type;

      typedef typename ScalarType<value_type>::type scalar_type;

      typedef ConstT base_expr_type;

      ConstExpr(const ConstT& constant) : constant_(constant) {}

      void allocateCache(unsigned int d) const {}

      unsigned int degree() const { return 0; }

      bool hasFastAccess(unsigned int d) const { return 1; }

      value_type value() const { return constant_; }

      value_type coeff(unsigned int i) const {
        return i==0 ? constant_ : value_type(0); }

      value_type fastAccessCoeff(unsigned int i) const {
        return i==0 ? constant_ : value_type(0); }

    protected:

      ConstT constant_;

    }; // class ConstExpr


    template <typename ExprT, template<typename> class Op>
    class UnaryExpr {

    public:

      typedef typename ExprT::value_type value_type;

      typedef typename ExprT::scalar_type scalar_type;

      typedef typename ExprT::base_expr_type base_expr_type;

      UnaryExpr(const ExprT& expr) : expr_(expr), op_(expr) {}

      void allocateCache(unsigned int d) const {
        expr_.allocateCache(d);
        op_.allocateCache(d);
      }

      unsigned int degree() const {return expr_.degree();}

      bool hasFastAccess(unsigned int d) const {
        return expr_.hasFastAccess(d); }

      value_type coeff(unsigned int i) const {
        return op_.computeCoeff(i,expr_); }

      value_type fastAccessCoeff(unsigned int i) const {
        return op_.computeFastAccessCoeff(i,expr_);
      }

    protected:

      ExprT expr_;

      Op<ExprT> op_;

    }; // class UnaryExpr


    template <typename ExprT1, typename ExprT2,
              template<typename,typename> class Op>
    class BinaryExpr {

    public:

      typedef typename ExprT1::value_type value_type_1;
      typedef typename ExprT2::value_type value_type_2;
      typedef typename Sacado::Promote<value_type_1,
                                       value_type_2>::type value_type;

      typedef typename ExprT1::scalar_type scalar_type_1;
      typedef typename ExprT2::scalar_type scalar_type_2;
      typedef typename Sacado::Promote<scalar_type_1,
                                       scalar_type_2>::type scalar_type;

      typedef typename ExprT1::base_expr_type base_expr_type_1;
      typedef typename ExprT2::base_expr_type base_expr_type_2;
      typedef typename Sacado::Promote<base_expr_type_1,
                                       base_expr_type_2>::type base_expr_type;

      BinaryExpr(const ExprT1& expr1, const ExprT2& expr2) :
        expr1_(expr1), expr2_(expr2), op_(expr1,expr2) {}

      void allocateCache(unsigned int d) const {
        expr1_.allocateCache(d);
        expr2_.allocateCache(d);
        op_.allocateCache(d);
      }

      unsigned int degree() const {
        unsigned int d1 = expr1_.degree(), d2 = expr2_.degree();
        return d1 > d2 ? d1 : d2;
      }

      bool hasFastAccess(unsigned int d) const {
        return expr1_.hasFastAccess(d) && expr2_.hasFastAccess(d);}

      value_type coeff(unsigned int i) const {
        return op_.computeCoeff(i,expr1_,expr2_); }

      value_type fastAccessCoeff(unsigned int i) const {
        return op_.computeFastAccessCoeff(i,expr1_,expr2_);
      }

    protected:

      ExprT1 expr1_;

      ExprT2 expr2_;

      Op<ExprT1,ExprT2> op_;

    }; // class BinaryExpr


    template <typename ExprT2, template<typename,typename> class Op>
    class BinaryExpr<ConstExpr<typename ExprT2::value_type>, ExprT2, Op> {

    public:

      typedef ConstExpr<typename ExprT2::value_type> ExprT1;

      typedef typename ExprT2::value_type value_type;
      typedef typename ExprT2::scalar_type scalar_type;
      typedef typename ExprT2::base_expr_type base_expr_type;

      BinaryExpr(const ExprT1& expr1, const ExprT2& expr2) :
        expr1_(expr1), expr2_(expr2), op_(expr1,expr2) {}

      void allocateCache(unsigned int d) const {
        expr2_.allocateCache(d);
        op_.allocateCache(d);
      }

      unsigned int degree() const {
        return expr2_.degree();
      }

      bool hasFastAccess(unsigned int d) const {
        return expr2_.hasFastAccess(d);}

      value_type coeff(unsigned int i) const {
        return op_.computeCoeff(i,expr1_,expr2_); }

      value_type fastAccessCoeff(unsigned int i) const {
        return op_.computeFastAccessCoeff(i,expr1_,expr2_);
      }

    protected:

      ExprT1 expr1_;

      ExprT2 expr2_;

      Op<ExprT1,ExprT2> op_;

    }; // class BinaryExpr


    template <typename ExprT1, template<typename,typename> class Op>
    class BinaryExpr<ExprT1,ConstExpr<typename ExprT1::value_type>, Op> {

    public:

      typedef ConstExpr<typename ExprT1::value_type> ExprT2;

      typedef typename ExprT1::value_type value_type;
      typedef typename ExprT1::scalar_type scalar_type;
      typedef typename ExprT1::base_expr_type base_expr_type;

      BinaryExpr(const ExprT1& expr1, const ExprT2& expr2) :
        expr1_(expr1), expr2_(expr2), op_(expr1,expr2) {}

      void allocateCache(unsigned int d) const {
        expr1_.allocateCache(d);
        op_.allocateCache(d);
      }

      unsigned int degree() const {
        return expr1_.degree();
      }

      bool hasFastAccess(unsigned int d) const {
        return expr1_.hasFastAccess(d);}

      value_type coeff(unsigned int i) const {
        return op_.computeCoeff(i,expr1_,expr2_); }

      value_type fastAccessCoeff(unsigned int i) const {
        return op_.computeFastAccessCoeff(i,expr1_,expr2_);
      }

    protected:

      ExprT1 expr1_;

      ExprT2 expr2_;

      Op<ExprT1,ExprT2> op_;

    }; // class BinaryExpr

  } // namespace Tay

  template <typename T>
  struct IsExpr< Tay::Expr<T> > {
    static const bool value = true;
  };

  template <typename T>
  struct BaseExprType< Tay::Expr<T> > {
    typedef typename Tay::Expr<T>::base_expr_type type;
  };

} // namespace Sacado

#endif // SACADO_TAY_CACHETAYLOREXPR_HPP