add_engine.h

Go to the documentation of this file.

/*
 *  This file is a part of TiledArray.
 *  Copyright (C) 2014  Virginia Tech
 *
 *  This program 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.
 *
 *  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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  Justus Calvin
 *  Department of Chemistry, Virginia Tech
 *
 *  add_engine.h
 *  Mar 31, 2014
 *
 */

#ifndef TILEDARRAY_EXPRESSIONS_ADD_ENGINE_H__INCLUDED
#define TILEDARRAY_EXPRESSIONS_ADD_ENGINE_H__INCLUDED

#include <TiledArray/expressions/binary_engine.h>
#include <TiledArray/tile_op/add.h>
#include <TiledArray/tile_op/binary_wrapper.h>

namespace TiledArray {
  namespace expressions {

    // Forward declarations
    template <typename, typename> class AddExpr;
    template <typename, typename, typename> class ScalAddExpr;
    template <typename, typename, typename> class AddEngine;
    template <typename, typename, typename, typename> class ScalAddEngine;

    template <typename Left, typename Right, typename Result>
    struct EngineTrait<AddEngine<Left, Right, Result> > {
      static_assert(std::is_same<typename EngineTrait<Left>::policy,
          typename EngineTrait<Right>::policy>::value,
          "The left- and right-hand expressions must use the same policy class");

      // Argument typedefs
      typedef Left left_type; 
      typedef Right right_type; 

      // Operational typedefs
      typedef TiledArray::detail::Add<Result, typename EngineTrait<Left>::eval_type,
          typename EngineTrait<Right>::eval_type,
          EngineTrait<Left>::consumable, EngineTrait<Right>::consumable>
          op_base_type; 
      typedef TiledArray::detail::BinaryWrapper<op_base_type>
          op_type; 
      typedef typename op_type::result_type
          value_type; 
      typedef typename eval_trait<value_type>::type
          eval_type;  
      typedef typename Left::policy policy; 
      typedef TiledArray::detail::DistEval<value_type, policy>
          dist_eval_type; 

      // Meta data typedefs
      typedef typename policy::size_type size_type; 
      typedef typename policy::trange_type trange_type; 
      typedef typename policy::shape_type shape_type; 
      typedef typename policy::pmap_interface
          pmap_interface; 

      static constexpr bool consumable = true;
      static constexpr unsigned int leaves =
          EngineTrait<Left>::leaves + EngineTrait<Right>::leaves;
    };

    template <typename Left, typename Right, typename Scalar, typename Result>
    struct EngineTrait<ScalAddEngine<Left, Right, Scalar, Result> > {
      static_assert(std::is_same<typename EngineTrait<Left>::policy,
          typename EngineTrait<Right>::policy>::value,
          "The left- and right-hand expressions must use the same policy class");

      // Argument typedefs
      typedef Left left_type; 
      typedef Right right_type; 

      // Operational typedefs
      typedef Scalar scalar_type; 
      typedef TiledArray::detail::ScalAdd<Result,
          typename EngineTrait<Left>::eval_type,
          typename EngineTrait<Right>::eval_type, scalar_type,
          EngineTrait<Left>::consumable, EngineTrait<Right>::consumable>
          op_base_type; 
      typedef TiledArray::detail::BinaryWrapper<op_base_type>
          op_type; 
      typedef typename op_type::result_type
          value_type; 
      typedef typename eval_trait<value_type>::type
          eval_type;  
      typedef typename Left::policy policy; 
      typedef TiledArray::detail::DistEval<value_type, policy>
          dist_eval_type; 

      // Meta data typedefs
      typedef typename policy::size_type size_type; 
      typedef typename policy::trange_type trange_type; 
      typedef typename policy::shape_type shape_type; 
      typedef typename policy::pmap_interface
          pmap_interface; 

      static constexpr bool consumable = is_consumable_tile<eval_type>::value;
      static constexpr unsigned int leaves =
          EngineTrait<Left>::leaves + EngineTrait<Right>::leaves;
    };


    template <typename Left, typename Right, typename Result>
    class AddEngine : public BinaryEngine<AddEngine<Left, Right, Result> > {
    public:
      // Class hierarchy typedefs
      typedef AddEngine<Left, Right, Result> AddEngine_; 
      typedef BinaryEngine<AddEngine_>
      BinaryEngine_; 
      typedef typename BinaryEngine_::ExprEngine_
          ExprEngine_; 

      // Argument typedefs
      typedef typename EngineTrait<AddEngine_>::left_type
          left_type; 
      typedef typename EngineTrait<AddEngine_>::right_type
          right_type; 

      // Operational typedefs
      typedef typename EngineTrait<AddEngine_>::value_type
          value_type; 
      typedef typename EngineTrait<AddEngine_>::op_base_type
          op_base_type; 
      typedef typename EngineTrait<AddEngine_>::op_type
          op_type; 
      typedef typename EngineTrait<AddEngine_>::policy
          policy; 
      typedef typename EngineTrait<AddEngine_>::dist_eval_type
          dist_eval_type; 

      // Meta data typedefs
      typedef typename EngineTrait<AddEngine_>::size_type
          size_type; 
      typedef typename EngineTrait<AddEngine_>::trange_type
          trange_type; 
      typedef typename EngineTrait<AddEngine_>::shape_type
          shape_type; 
      typedef typename EngineTrait<AddEngine_>::pmap_interface
          pmap_interface; 


      template <typename L, typename R>
      AddEngine(const AddExpr<L, R>& expr) : BinaryEngine_(expr) { }


      shape_type make_shape() const {
        return BinaryEngine_::left_.shape().add(BinaryEngine_::right_.shape());
      }


      shape_type make_shape(const Permutation& perm) const {
        return BinaryEngine_::left_.shape().add(BinaryEngine_::right_.shape(), perm);
      }


      static op_type make_tile_op() { return op_type(op_base_type()); }


      static op_type make_tile_op(const Permutation& perm) {
        return op_type(op_base_type(), perm);
      }


      const char* make_tag() const { return "[+] "; }

    }; // class AddEngine



    template <typename Left, typename Right, typename Scalar, typename Result>
    class ScalAddEngine :
        public BinaryEngine<ScalAddEngine<Left, Right, Scalar, Result> >
    {
    public:
      // Class hierarchy typedefs
      typedef ScalAddEngine<Left, Right, Scalar, Result>
      ScalAddEngine_; 
      typedef BinaryEngine<ScalAddEngine_>
      BinaryEngine_; 
      typedef ExprEngine<ScalAddEngine_>
      ExprEngine_; 

      // Argument typedefs
      typedef typename EngineTrait<ScalAddEngine_>::left_type
          left_type; 
      typedef typename EngineTrait<ScalAddEngine_>::right_type
          right_type; 

      // Operational typedefs
      typedef typename EngineTrait<ScalAddEngine_>::value_type
          value_type; 
      typedef typename EngineTrait<ScalAddEngine_>::scalar_type
          scalar_type; 
      typedef typename EngineTrait<ScalAddEngine_>::op_base_type
          op_base_type; 
      typedef typename EngineTrait<ScalAddEngine_>::op_type
          op_type; 
      typedef typename EngineTrait<ScalAddEngine_>::policy
          policy; 
      typedef typename EngineTrait<ScalAddEngine_>::dist_eval_type
          dist_eval_type; 

      // Meta data typedefs
      typedef typename EngineTrait<ScalAddEngine_>::size_type
          size_type; 
      typedef typename EngineTrait<ScalAddEngine_>::trange_type
          trange_type; 
      typedef typename EngineTrait<ScalAddEngine_>::shape_type
          shape_type; 
      typedef typename EngineTrait<ScalAddEngine_>::pmap_interface
          pmap_interface; 

    private:

      scalar_type factor_; 

    public:


      template <typename L, typename R, typename S>
      ScalAddEngine(const ScalAddExpr<L, R, S>& expr) :
        BinaryEngine_(expr), factor_(expr.factor())
      { }


      shape_type make_shape() const {
        return BinaryEngine_::left_.shape().add(BinaryEngine_::right_.shape(),
            factor_);
      }


      shape_type make_shape(const Permutation& perm) const {
        return BinaryEngine_::left_.shape().add(BinaryEngine_::right_.shape(),
            factor_, perm);
      }


      op_type make_tile_op() const { return op_type(op_base_type(factor_)); }


      op_type make_tile_op(const Permutation& perm) const {
        return op_type(op_base_type(factor_), perm);
      }


      scalar_type factor() { return factor_; }


      std::string make_tag() const {
        std::stringstream ss;
        ss << "[+] [" << factor_ << "] ";
        return ss.str();
      }

    }; // class ScalAddEngine

  }  // namespace expressions
} // namespace TiledArray

#endif // TILEDARRAY_EXPRESSIONS_ADD_ENGINE_H__INCLUDED