blk_tsr_expr.h

Go to the documentation of this file.

/*
 *  This file is a part of TiledArray.
 *  Copyright (C) 2015  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
 *
 *  blk_tsr_expr.h
 *  May 20, 2015
 *
 */

#ifndef TILEDARRAY_EXPRESSIONS_BLK_TSR_EXPR_H__INCLUDED
#define TILEDARRAY_EXPRESSIONS_BLK_TSR_EXPR_H__INCLUDED

#include <TiledArray/expressions/unary_expr.h>
#include "blk_tsr_engine.h"

namespace TiledArray {
  namespace expressions {

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

    template <typename Array>
    using ConjBlkTsrExpr =
        ScalBlkTsrExpr<Array, TiledArray::detail::ComplexConjugate<void> >;

    template <typename Array, typename Scalar>
    using ScalConjBlkTsrExpr =
        ScalBlkTsrExpr<Array, TiledArray::detail::ComplexConjugate<Scalar> >;

    using TiledArray::detail::conj_op;
    using TiledArray::detail::mult_t;
    using TiledArray::detail::numeric_t;
    using TiledArray::detail::scalar_t;

    template <typename> struct is_aliased;
    template <typename Array, bool Alias>
    struct is_aliased<BlkTsrExpr<Array, Alias> > :
        public std::integral_constant<bool, Alias> { };

    template <typename Array, bool Alias>
    struct ExprTrait<BlkTsrExpr<Array, Alias> > {
      typedef Array array_type; 
      typedef Array& reference; 
      typedef numeric_t<Array> numeric_type; 
      typedef scalar_t<Array> scalar_type; 
      typedef BlkTsrEngine<Array, typename Array::eval_type, Alias>
          engine_type; 
    };

    template <typename Array, bool Alias>
    struct ExprTrait<BlkTsrExpr<const Array, Alias> > {
      typedef Array array_type; 
      typedef const Array& reference; 
      typedef numeric_t<Array> numeric_type; 
      typedef scalar_t<Array> scalar_type; 
      typedef BlkTsrEngine<Array, typename Array::eval_type, Alias>
          engine_type; 
    };

    template <typename Array, typename Scalar>
    struct ExprTrait<ScalBlkTsrExpr<Array, Scalar> > {
      typedef Array array_type; 
      typedef const Array& reference; 
      typedef ScalBlkTsrEngine<Array, Scalar, typename Array::eval_type>
          engine_type; 
      typedef numeric_t<Array> numeric_type; 
      typedef Scalar scalar_type; 
    };

    template <typename Array, typename Scalar>
    struct ExprTrait<ScalBlkTsrExpr<const Array, Scalar> > {
      typedef Array array_type; 
      typedef const Array& reference; 
      typedef ScalBlkTsrEngine<Array, Scalar, typename Array::eval_type>
          engine_type; 
      typedef numeric_t<Array> numeric_type; 
      typedef Scalar scalar_type; 
    };


    template <typename Derived>
    class BlkTsrExprBase : public Expr<Derived> {
    public:
      typedef BlkTsrExprBase<Derived> BlkTsrExprBase_; 
      typedef Expr<Derived> Expr_; 
      typedef typename ExprTrait<Derived>::array_type array_type;
      typedef typename ExprTrait<Derived>::reference reference;

    protected:

      reference array_; 
      std::string vars_; 
      std::vector<std::size_t> lower_bound_; 
      std::vector<std::size_t> upper_bound_; 

      void check_valid() const {
        const unsigned int rank = array_.trange().tiles_range().rank();
        // Check the dimension of the lower block bound
        if(TiledArray::detail::size(lower_bound_) != rank) {
          if(TiledArray::get_default_world().rank() == 0) {
            TA_USER_ERROR_MESSAGE( \
                "The size lower bound of the block is not equal to rank of " \
                "the array: " \
                << "\n    array rank  = " << array_.trange().tiles_range().rank() \
                << "\n    lower bound = " << lower_bound_ );

            TA_EXCEPTION("The size lower bound of the block is not equal to " \
                "rank of the array.");
          }
        }

        // Check the dimension of the upper block bound
        if(TiledArray::detail::size(upper_bound_) != rank) {
          if(TiledArray::get_default_world().rank() == 0) {
            TA_USER_ERROR_MESSAGE( \
                "The size upper bound of the block is not equal to rank of " \
                "the array: " \
                << "\n    array rank  = " << rank \
                << "\n    upper bound = " << upper_bound_ );

            TA_EXCEPTION("The size upper bound of the block is not equal to " \
                "rank of the array.");
          }
        }

        const bool lower_bound_check =
            std::equal(std::begin(lower_bound_), std::end(lower_bound_),
                    array_.trange().tiles_range().lobound_data(),
                    [] (std::size_t l, std::size_t r) { return l >= r; });
        const bool upper_bound_check =
            std::equal(std::begin(upper_bound_), std::end(upper_bound_),
                    array_.trange().tiles_range().upbound_data(),
                    [] (std::size_t l, std::size_t r) { return l <= r; });
        if(! (lower_bound_check && upper_bound_check)) {
          if(TiledArray::get_default_world().rank() == 0) {
            TA_USER_ERROR_MESSAGE( \
                "The block range is not a sub-block of the array range: " \
                << "\n    array range = " << array_.trange().tiles_range() \
                << "\n    block range = [ " << lower_bound_  << " , " << upper_bound_ << " )");
          }

          TA_EXCEPTION("The block range is not a sub-block of the array range.");
        }

        const bool lower_upper_bound_check =
            std::equal(std::begin(lower_bound_), std::end(lower_bound_),
                    std::begin(upper_bound_),
                    [] (std::size_t l, std::size_t r) { return l < r; });
        if(! lower_upper_bound_check) {
          if(TiledArray::get_default_world().rank() == 0) {
            TA_USER_ERROR_MESSAGE( \
                "The block lower bound is not less than the upper bound: " \
                << "\n    lower bound = " << lower_bound_ \
                << "\n    upper bound = " << upper_bound_);
          }

          TA_EXCEPTION("The block lower bound is not less than the upper bound.");
        }
      }

    public:

      // Compiler generated functions
      BlkTsrExprBase(const BlkTsrExprBase_&) = default;
      BlkTsrExprBase(BlkTsrExprBase_&&) = default;
      ~BlkTsrExprBase() = default;
      BlkTsrExprBase_& operator=(const BlkTsrExprBase_&) = delete;
      BlkTsrExprBase_& operator=(BlkTsrExprBase_&&) = delete;


      template <typename Index>
      BlkTsrExprBase(reference array, const std::string& vars,
          const Index& lower_bound, const Index& upper_bound) :
        Expr_(), array_(array), vars_(vars),
        lower_bound_(std::begin(lower_bound), std::end(lower_bound)),
        upper_bound_(std::begin(upper_bound), std::end(upper_bound))
      {
#ifndef NDEBUG
        check_valid();
#endif // NDEBUG
      }


      reference array() const { return array_; }


      const std::string& vars() const { return vars_; }


      const std::vector<std::size_t>& lower_bound() const { return lower_bound_; }


      const std::vector<std::size_t>& upper_bound() const { return upper_bound_; }

    }; // class BlkTsrExprBase


    template <typename Array, bool Alias>
    class BlkTsrExpr : public BlkTsrExprBase<BlkTsrExpr<Array, Alias> > {
    public:
      typedef BlkTsrExpr<Array, Alias> BlkTsrExpr_; 
      typedef BlkTsrExprBase<BlkTsrExpr_>
          BlkTsrExprBase_; 
      typedef typename ExprTrait<BlkTsrExpr_>::engine_type engine_type;
      typedef typename ExprTrait<BlkTsrExpr_>::array_type array_type;
      typedef typename ExprTrait<BlkTsrExpr_>::reference reference;

      // Compiler generated functions
      BlkTsrExpr() = delete;
      BlkTsrExpr(const BlkTsrExpr_&) = default;
      BlkTsrExpr(BlkTsrExpr_&&) = default;
      ~BlkTsrExpr() = default;


      template <typename Index>
      BlkTsrExpr(reference array, const std::string& vars,
          const Index& lower_bound, const Index& upper_bound) :
        BlkTsrExprBase_(array, vars, lower_bound, upper_bound)
      { }


      reference operator=(const BlkTsrExpr_& other) {
        other.eval_to(*this);
        return BlkTsrExprBase_::array_;
      }


      reference operator=(BlkTsrExpr_&& other) {
        other.eval_to(*this);
        return BlkTsrExprBase_::array_;
      }


      template <typename D>
      reference operator=(const Expr<D>& other) {
        static_assert(TiledArray::expressions::is_aliased<D>::value,
            "no_alias() expressions are not allowed on the right-hand side of "
            "the assignment operator.");
        other.derived().eval_to(*this);
        return BlkTsrExprBase_::array_;
      }


      template <typename D>
      reference operator+=(const Expr<D>& other) {
        static_assert(TiledArray::expressions::is_aliased<D>::value,
            "no_alias() expressions are not allowed on the right-hand side of "
            "the assignment operator.");
        return operator=(AddExpr<BlkTsrExpr_, D>(*this, other.derived()));
      }


      template <typename D>
      reference operator-=(const Expr<D>& other) {
        static_assert(TiledArray::expressions::is_aliased<D>::value,
            "no_alias() expressions are not allowed on the right-hand side of "
            "the assignment operator.");
        return operator=(SubtExpr<BlkTsrExpr_, D>(*this, other.derived()));
      }


      template <typename D>
      reference operator*=(const Expr<D>& other) {
        static_assert(TiledArray::expressions::is_aliased<D>::value,
            "no_alias() expressions are not allowed on the right-hand side of "
            "the assignment operator.");
        return operator=(MultExpr<BlkTsrExpr_, D>(*this, other.derived()));
      }


      BlkTsrExpr<Array, false>
      no_alias() const {
        return BlkTsrExpr<Array, false>(BlkTsrExprBase_::array_,
            BlkTsrExprBase_::vars_);
      }



      ConjBlkTsrExpr<array_type> conj() const {
        return ConjBlkTsrExpr<array_type>(BlkTsrExprBase_::array(),
            BlkTsrExprBase_::vars(), conj_op(),
            BlkTsrExprBase_::lower_bound(), BlkTsrExprBase_::upper_bound());
      }

    }; // class BlkTsrExpr


    template <typename Array>
    class BlkTsrExpr<const Array, true> :
        public BlkTsrExprBase<BlkTsrExpr<const Array, true> >
    {
    public:
      typedef BlkTsrExpr<const Array, true> BlkTsrExpr_; 
      typedef BlkTsrExprBase<BlkTsrExpr_>
          BlkTsrExprBase_; 
      typedef typename ExprTrait<BlkTsrExpr_>::engine_type engine_type;
      typedef typename ExprTrait<BlkTsrExpr_>::array_type array_type;
      typedef typename ExprTrait<BlkTsrExpr_>::reference reference;

      // Compiler generated functions
      BlkTsrExpr() = delete;
      BlkTsrExpr(const BlkTsrExpr_&) = default;
      BlkTsrExpr(BlkTsrExpr_&&) = default;
      ~BlkTsrExpr() = default;
      BlkTsrExpr_& operator=(const BlkTsrExpr_&) = delete;
      BlkTsrExpr_& operator=(BlkTsrExpr_&&) = delete;



      template <typename Index>
      BlkTsrExpr(reference array, const std::string& vars,
          const Index& lower_bound, const Index& upper_bound) :
        BlkTsrExprBase_(array, vars, lower_bound, upper_bound)
      { }



      ConjBlkTsrExpr<array_type> conj() const {
        return ConjBlkTsrExpr<array_type>(BlkTsrExprBase_::array(),
            BlkTsrExprBase_::vars(), conj_op(),
            BlkTsrExprBase_::lower_bound(), BlkTsrExprBase_::upper_bound());
      }

    }; // class BlkTsrExpr<const Array>


    template <typename Array, typename Scalar>
    class ScalBlkTsrExpr : public BlkTsrExprBase<ScalBlkTsrExpr<Array, Scalar> > {
    public:
      typedef ScalBlkTsrExpr<Array, Scalar> ScalBlkTsrExpr_; 
      typedef BlkTsrExprBase<ScalBlkTsrExpr_> BlkTsrExprBase_;
      typedef typename ExprTrait<ScalBlkTsrExpr_>::engine_type engine_type;
      typedef typename ExprTrait<ScalBlkTsrExpr_>::array_type array_type;
      typedef typename ExprTrait<ScalBlkTsrExpr_>::reference reference;
      typedef typename ExprTrait<ScalBlkTsrExpr_>::scalar_type scalar_type;

    private:

      scalar_type factor_; 

    public:

      // Compiler generated functions
      ScalBlkTsrExpr() = delete;
      ScalBlkTsrExpr(const ScalBlkTsrExpr_&) = default;
      ScalBlkTsrExpr(ScalBlkTsrExpr_&&) = default;
      ~ScalBlkTsrExpr() = default;
      ScalBlkTsrExpr_& operator=(const ScalBlkTsrExpr_&) = delete;
      ScalBlkTsrExpr_& operator=(ScalBlkTsrExpr_&&) = delete;



      template <typename Index>
      ScalBlkTsrExpr(reference array, const std::string& vars,
          const scalar_type factor,
          const Index& lower_bound, const Index& upper_bound) :
        BlkTsrExprBase_(array, vars, lower_bound, upper_bound), factor_(factor)
      { }


      scalar_type factor() const { return factor_; }

    }; // class ScalBlkTsrExpr


    template <typename Array, typename Scalar, bool Alias,
        typename std::enable_if<
            TiledArray::detail::is_numeric<Scalar>::value
        >::type* = nullptr>
    inline ScalBlkTsrExpr<typename std::remove_const<Array>::type, Scalar>
    operator*(const BlkTsrExpr<Array, Alias>& expr, const Scalar& factor) {
      return ScalBlkTsrExpr<typename std::remove_const<Array>::type, Scalar>(
          expr.array(), expr.vars(), factor, expr.lower_bound(),
          expr.upper_bound());
    }


    template <typename Array, typename Scalar, bool Alias,
        typename std::enable_if<
            TiledArray::detail::is_numeric<Scalar>::value
        >::type* = nullptr>
    inline ScalBlkTsrExpr<typename std::remove_const<Array>::type, Scalar>
    operator*(const Scalar& factor, const BlkTsrExpr<Array, Alias>& expr) {
      return ScalBlkTsrExpr<typename std::remove_const<Array>::type, Scalar>(
          expr.array(), expr.vars(), factor, expr.lower_bound(),
          expr.upper_bound());
    }


    template <typename Array, typename Scalar1, typename Scalar2,
        typename std::enable_if<
            TiledArray::detail::is_numeric<Scalar2>::value
        >::type* = nullptr>
    inline ScalBlkTsrExpr<Array, mult_t<Scalar1, Scalar2> >
    operator*(const ScalBlkTsrExpr<Array, Scalar1>& expr, const Scalar2& factor) {
      return ScalBlkTsrExpr<Array, mult_t<Scalar1, Scalar2> >(expr.array(),
          expr.vars(), expr.factor() * factor, expr.lower_bound(),
          expr.upper_bound());
    }


    template <typename Array, typename Scalar1, typename Scalar2,
        typename std::enable_if<
            TiledArray::detail::is_numeric<Scalar1>::value
        >::type * = nullptr>
    inline ScalBlkTsrExpr<Array, mult_t<Scalar2, Scalar1> >
    operator*(const Scalar1& factor, const ScalBlkTsrExpr<Array, Scalar2>& expr) {
      return ScalBlkTsrExpr<Array, mult_t<Scalar2, Scalar1> >(expr.array(),
          expr.vars(), expr.factor() * factor, expr.lower_bound(),
          expr.upper_bound());
    }


    template <typename Array>
    inline ScalBlkTsrExpr<typename std::remove_const<Array>::type,
        typename ExprTrait<BlkTsrExpr<Array, true> >::numeric_type>
    operator-(const BlkTsrExpr<Array, true>& expr) {
      typedef typename ExprTrait<BlkTsrExpr<Array, true> >::numeric_type
          numeric_type;
      return ScalBlkTsrExpr<typename std::remove_const<Array>::type,
          numeric_type>(expr.array(), expr.vars(), -1, expr.lower_bound(),
          expr.upper_bound());
    }


    template <typename Array, typename Scalar>
    inline ScalBlkTsrExpr<Array, Scalar>
    operator-(const ScalBlkTsrExpr<Array, Scalar>& expr) {
      return ScalBlkTsrExpr<Array, Scalar>(expr.array(), expr.vars(),
          -expr.factor(), expr.lower_bound(), expr.upper_bound());
    }



    template <typename Array, bool Alias>
    inline ConjBlkTsrExpr<typename std::remove_const<Array>::type>
    conj(const BlkTsrExpr<Array, Alias>& expr) {
      return ConjBlkTsrExpr<typename std::remove_const<Array>::type>(
          expr.array(), expr.vars(), conj_op(), expr.lower_bound(),
          expr.upper_bound());
    }


    template <typename Array>
    inline BlkTsrExpr<const Array, true>
    conj(const ConjBlkTsrExpr<Array>& expr) {
      return BlkTsrExpr<const Array, true>(expr.array(), expr.vars(),
          expr.lower_bound(), expr.upper_bound());
    }


    template <typename Array, typename Scalar>
    inline ScalConjBlkTsrExpr<Array, Scalar>
    conj(const ScalBlkTsrExpr<Array, Scalar>& expr) {
      return ScalConjBlkTsrExpr<Array, Scalar>(expr.array(), expr.vars(),
          conj_op(TiledArray::detail::conj(expr.factor())),
          expr.lower_bound(), expr.upper_bound());
    }


    template <typename Array, typename Scalar>
    inline ScalBlkTsrExpr<Array, Scalar>
    conj(const ScalConjBlkTsrExpr<Array, Scalar>& expr) {
      return ScalBlkTsrExpr<Array, Scalar>(expr.array(), expr.vars(),
          TiledArray::detail::conj(expr.factor().factor()),
          expr.lower_bound(), expr.upper_bound());
    }


    template <typename Array, typename Scalar,
        typename std::enable_if<
            TiledArray::detail::is_numeric<Scalar>::value
        >::type* = nullptr>
    inline ScalConjBlkTsrExpr<Array, Scalar>
    operator*(const ConjBlkTsrExpr<const Array>& expr, const Scalar& factor) {
      return ScalConjBlkTsrExpr<Array, Scalar>(expr.array(), expr.vars(),
          conj_op(factor), expr.lower_bound(), expr.upper_bound());
    }


    template <typename Array, typename Scalar,
        typename std::enable_if<
            TiledArray::detail::is_numeric<Scalar>::value
        >::type* = nullptr>
    inline ScalConjBlkTsrExpr<Array, Scalar>
    operator*(const Scalar& factor, const ConjBlkTsrExpr<Array>& expr) {
      return ScalConjBlkTsrExpr<Array, Scalar>(expr.array(), expr.vars(),
          conj_op(factor), expr.lower_bound(), expr.upper_bound());
    }


    template <typename Array, typename Scalar1, typename Scalar2,
        typename std::enable_if<
            TiledArray::detail::is_numeric<Scalar2>::value
        >::type* = nullptr>
    inline ScalConjBlkTsrExpr<Array, mult_t<Scalar1, Scalar2> >
    operator*(const ScalConjBlkTsrExpr<Array, Scalar1>& expr, const Scalar2& factor) {
      return ScalConjBlkTsrExpr<Array, mult_t<Scalar1, Scalar2> >(expr.array(),
          expr.vars(), conj_op(expr.factor().factor() * factor),
          expr.lower_bound(), expr.upper_bound());
    }


    template <typename Array, typename Scalar1, typename Scalar2,
        typename std::enable_if<
            TiledArray::detail::is_numeric<Scalar1>::value
        >::type* = nullptr>
    inline ScalConjBlkTsrExpr<Array, mult_t<Scalar2, Scalar1> >
    operator*(const Scalar1& factor, const ScalConjBlkTsrExpr<Array, Scalar2>& expr) {
      return ScalConjBlkTsrExpr<Array, mult_t<Scalar2, Scalar1> >(expr.array(),
          expr.vars(), conj_op(expr.factor().factor() * factor),
          expr.lower_bound(), expr.upper_bound());
    }


    template <typename Array>
    inline ScalConjBlkTsrExpr<Array,
        typename ExprTrait<ConjBlkTsrExpr<Array> >::numeric_type>
    operator-(const ConjBlkTsrExpr<Array>& expr) {
      typedef typename ExprTrait<ConjBlkTsrExpr<Array> >::numeric_type
          numeric_type;
      return ScalConjBlkTsrExpr<Array, numeric_type>(expr.array(), expr.vars(),
          conj_op<numeric_type>(-1), expr.lower_bound(), expr.upper_bound());
    }


    template <typename Array, typename Scalar>
    inline ScalConjBlkTsrExpr<Array, Scalar>
    operator-(const ScalConjBlkTsrExpr<Array, Scalar>& expr) {
      return ScalConjBlkTsrExpr<Array, Scalar>(expr.array(), expr.vars(),
          conj_op(-expr.factor().factor()), expr.lower_bound(),
          expr.upper_bound());
    }


  } // namespace expressions
} // namespace TiledArray

#endif // TILEDARRAY_EXPRESSIONS_BLK_TSR_EXPR_H__INCLUDED