mult_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
 *
 *  mult_engine.h
 *  Mar 31, 2014
 *
 */

#ifndef TILEDARRAY_EXPRESSIONS_MULT_ENGINE_H__INCLUDED
#define TILEDARRAY_EXPRESSIONS_MULT_ENGINE_H__INCLUDED

#include <TiledArray/expressions/cont_engine.h>
#include <TiledArray/tile_op/mult.h>
#include <TiledArray/tile_op/binary_wrapper.h>


namespace TiledArray {
  namespace expressions {

    // Forward declarations
    template <typename, typename> class MultExpr;
    template <typename, typename, typename> class ScalMultExpr;
    template <typename, typename, typename> class MultEngine;
    template <typename, typename, typename, typename> class ScalMultEngine;

    template <typename Left, typename Right, typename Result>
    struct EngineTrait<MultEngine<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::Mult<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 TiledArray::detail::numeric_type<value_type>::type
          scalar_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 Scalar, typename Result>
    struct EngineTrait<ScalMultEngine<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::ScalMult<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 MultEngine : public ContEngine<MultEngine<Left, Right, Result> > {
    public:
      // Class hierarchy typedefs
      typedef MultEngine<Left, Right, Result> MultEngine_; 
      typedef ContEngine<MultEngine_>
          ContEngine_; 
      typedef BinaryEngine<MultEngine_>
          BinaryEngine_; 
      typedef BinaryEngine<MultEngine_>
          ExprEngine_; 

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

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

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

    private:

      bool contract_; 

    public:


      template <typename L, typename R>
      MultEngine(const MultExpr<L, R>& expr) :
        ContEngine_(expr), contract_(false)
      { }



      void perm_vars(const VariableList& target_vars) {
        if(contract_)
          ContEngine_::perm_vars(target_vars);
        else {
          BinaryEngine_::perm_vars(target_vars);
        }
      }


      void perm_vars() {
        if(contract_)
          ContEngine_::perm_vars();
        else {
          BinaryEngine_::perm_vars();
        }
      }


      void init_vars(const VariableList& target_vars) {
        BinaryEngine_::left_.init_vars();
        BinaryEngine_::right_.init_vars();

        if(BinaryEngine_::left_.vars().is_permutation(BinaryEngine_::right_.vars())) {
          BinaryEngine_::perm_vars(target_vars);
        } else {
          contract_ = true;
          ContEngine_::init_vars();
          ContEngine_::perm_vars(target_vars);
        }
      }

      void init_vars() {
        BinaryEngine_::left_.init_vars();
        BinaryEngine_::right_.init_vars();

        if(BinaryEngine_::left_.vars().is_permutation(BinaryEngine_::right_.vars())) {
          if(left_type::leaves <= right_type::leaves)
            ExprEngine_::vars_ = BinaryEngine_::left_.vars();
          else
            ExprEngine_::vars_ = BinaryEngine_::right_.vars();
        } else {
          contract_ = true;
          ContEngine_::init_vars();
        }
      }


      void init_struct(const VariableList& target_vars) {
        if(contract_)
          ContEngine_::init_struct(target_vars);
        else
          BinaryEngine_::init_struct(target_vars);
      }


      void init_distribution(World* world, std::shared_ptr<pmap_interface> pmap) {
        if(contract_)
          ContEngine_::init_distribution(world, pmap);
        else
          BinaryEngine_::init_distribution(world, pmap);
      }


      trange_type make_trange() const {
        if(contract_)
          return ContEngine_::make_trange();
        else
          return BinaryEngine_::make_trange();
      }


      trange_type make_trange(const Permutation& perm) const {
        if(contract_)
          return ContEngine_::make_trange(perm);
        else
          return BinaryEngine_::make_trange(perm);
      }


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


      shape_type make_shape(const Permutation& perm) const {
        return BinaryEngine_::left_.shape().mult(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); }


      dist_eval_type make_dist_eval() const {
        if(contract_)
          return ContEngine_::make_dist_eval();
        else
          return BinaryEngine_::make_dist_eval();
      }


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


      void print(ExprOStream os, const VariableList& target_vars) const {
        if(contract_)
          return ContEngine_::print(os, target_vars);
        else
          return BinaryEngine_::print(os, target_vars);
      }

    }; // class MultEngine



    template <typename Left, typename Right, typename Scalar, typename Result>
    class ScalMultEngine :
        public ContEngine<ScalMultEngine<Left, Right, Scalar, Result> >
    {
    public:
      // Class hierarchy typedefs
      typedef ScalMultEngine<Left, Right, Scalar, Result>
          ScalMultEngine_; 
      typedef ContEngine<ScalMultEngine_>
          ContEngine_; 
      typedef BinaryEngine<ScalMultEngine_>
          BinaryEngine_; 
      typedef BinaryEngine<ScalMultEngine_>
          ExprEngine_; 

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

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

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

    private:

      bool contract_; 

    public:


      template <typename L, typename R, typename S>
      ScalMultEngine(const ScalMultExpr<L, R, S>& expr) : ContEngine_(expr), contract_(false) { }


      void perm_vars(const VariableList& target_vars) {
        if(contract_)
          ContEngine_::perm_vars(target_vars);
        else {
          BinaryEngine_::perm_vars(target_vars);
        }
      }


      void perm_vars() {
        if(contract_)
          ContEngine_::perm_vars();
        else {
          BinaryEngine_::perm_vars();
        }
      }


      void init_vars(const VariableList& target_vars) {
        BinaryEngine_::left_.init_vars();
        BinaryEngine_::right_.init_vars();

        if(BinaryEngine_::left_.vars().is_permutation(BinaryEngine_::right_.vars())) {
          BinaryEngine_::perm_vars(target_vars);
        } else {
          contract_ = true;
          ContEngine_::init_vars();
          ContEngine_::perm_vars(target_vars);
        }
      }

      void init_vars() {
        BinaryEngine_::left_.init_vars();
        BinaryEngine_::right_.init_vars();

        if(BinaryEngine_::left_.vars().is_permutation(BinaryEngine_::right_.vars())) {
          if(left_type::leaves <= right_type::leaves)
            ExprEngine_::vars_ = BinaryEngine_::left_.vars();
          else
            ExprEngine_::vars_ = BinaryEngine_::right_.vars();
        } else {
          contract_ = true;
          ContEngine_::init_vars();
        }
      }


      void init_struct(const VariableList& target_vars) {
        if(contract_)
          ContEngine_::init_struct(target_vars);
        else
          BinaryEngine_::init_struct(target_vars);
      }


      void init_distribution(World* world, std::shared_ptr<pmap_interface> pmap) {
        if(contract_)
          ContEngine_::init_distribution(world, pmap);
        else
          BinaryEngine_::init_distribution(world, pmap);
      }


      dist_eval_type make_dist_eval() const {
        if(contract_)
          return ContEngine_::make_dist_eval();
        else
          return BinaryEngine_::make_dist_eval();
      }


      trange_type make_trange() const {
        if(contract_)
          return ContEngine_::make_trange();
        else
          return BinaryEngine_::make_trange();
      }


      trange_type make_trange(const Permutation& perm) const {
        if(contract_)
          return ContEngine_::make_trange(perm);
        else
          return BinaryEngine_::make_trange(perm);
      }


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


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


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


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




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


      void print(ExprOStream os, const VariableList& target_vars) const {
        if(contract_)
          return ContEngine_::print(os, target_vars);
        else
          return BinaryEngine_::print(os, target_vars);
      }

    }; // class ScalMultEngine

  }  // namespace expressions
} // namespace TiledArray

#endif // TILEDARRAY_EXPRESSIONS_MULT_ENGINE_H__INCLUDED