..
   Generated automatically by cpp2rst

.. highlight:: c
.. role:: red
.. role:: green
.. role:: param


.. _mpi__lazy:

mpi::lazy
=========

*#include <mpi.hpp>*

.. rst-class:: cppsynopsis

     template<typename A> class  :red:`lazy`




Template parameters
-------------------

 * **A**: nda::Array type to be scattered.


Public members
--------------

.. table::
   :widths: 40 60


   +------+-------------------+----------------------------------------------------------------------------+
   | rhs  | const_view_type   |  View of the array/view to be scattered.                                   |
   +------+-------------------+----------------------------------------------------------------------------+
   | comm | mpi::communicator |  MPI communicator.                                                         |
   +------+-------------------+----------------------------------------------------------------------------+
   | root | const int         |  MPI root process.                                                         |
   +------+-------------------+----------------------------------------------------------------------------+
   | all  | const bool        |  Should all processes receive the result. (doesn't make sense for scatter) |
   +------+-------------------+----------------------------------------------------------------------------+


Member types
------------

.. table::
   :widths: 40 60


   +-----------------+--------------------------------------+---------------------------------------------------------------+
   | value_type      | typename std::decay_t<A>::value_type |  Value type of the array/view.                                |
   +-----------------+--------------------------------------+---------------------------------------------------------------+
   | const_view_type | decltype(std::declval<const A>()())  |  Const view type of the array/view stored in the lazy object. |
   +-----------------+--------------------------------------+---------------------------------------------------------------+


Member functions
----------------

.. table::
   :widths: 40 60


   +-----------------------------------+-----------------------------------------------------------------------------+
   | :ref:`shape <mpi__lazy__shape>`   | Compute the shape of the target array.                                      |
   +-----------------------------------+-----------------------------------------------------------------------------+
   | :ref:`invoke <mpi__lazy__invoke>` | Execute the lazy MPI operation and write the result to a target array/view. |
   +-----------------------------------+-----------------------------------------------------------------------------+

.. toctree::
    :hidden:

    lazy/shape
    lazy/invoke