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

#ifndef TILEDARRAY_EXPRESSIONS_TSR_ENGINE_H__INCLUDED
#define TILEDARRAY_EXPRESSIONS_TSR_ENGINE_H__INCLUDED

#include <TiledArray/expressions/leaf_engine.h>
#include <TiledArray/tile_op/noop.h>
#include <TiledArray/tile_op/unary_wrapper.h>

namespace TiledArray {

  // Forward declaration
  template <typename, typename> class DistArray;

  namespace expressions {

    // Forward declaration
    template <typename, bool> class TsrExpr;
    template <typename, typename, bool> class TsrEngine;

    template <typename Tile, typename Policy, typename Result, bool Alias>
    struct EngineTrait<TsrEngine<DistArray<Tile, Policy>, Result, Alias> > {
      // Argument typedefs
      typedef DistArray<Tile, Policy> array_type; 

      // Operational typedefs
      // Note: the consumable flag is true for noop to avoid unnecessary copies.
      // This is OK because the result consumable flag is set to false.
      typedef TiledArray::detail::Noop<Result, typename array_type::eval_type,
          true> op_base_type; 
      typedef TiledArray::detail::UnaryWrapper<op_base_type> op_type;
      typedef TiledArray::detail::LazyArrayTile<typename array_type::value_type,
          op_type> value_type;  
      typedef typename eval_trait<value_type>::type
          eval_type; 
      typedef typename TiledArray::detail::scalar_type<DistArray<Tile,
          Policy> >::type scalar_type; 
      typedef 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 = (! Alias) ||
          eval_trait<typename array_type::value_type>::is_consumable;
      static constexpr unsigned int leaves = 1;
    };


    template <typename Array, typename Result, bool Alias>
    class TsrEngine : public LeafEngine<TsrEngine<Array, Result, Alias> > {
    public:
      // Class hierarchy typedefs
      typedef TsrEngine<Array, Result, Alias> TsrEngine_; 
      typedef LeafEngine<TsrEngine_> LeafEngine_; 
      typedef typename LeafEngine_::ExprEngine_
          ExprEngine_; 

      // Argument typedefs
      typedef typename EngineTrait<TsrEngine_>::array_type
          array_type; 

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

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

      template <typename A>
      TsrEngine(const TsrExpr<A, Alias>& expr) : LeafEngine_(expr) { }


      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);
      }

    }; // class TsrEngine

  }  // namespace expressions
} // namespace TiledArray

#endif // TILEDARRAY_EXPRESSIONS_TSR_ENGINE_H__INCLUDED