..
   Generated automatically by cpp2rst

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


.. _mpi__gather:

mpi::gather
===========

*#include <mpi.hpp>*



**Synopsis**

 .. rst-class:: cppsynopsis

       | :green:`template<typename T>`
       | decltype(auto) :red:`gather` (T && :param:`x`, :ref:`communicator <mpi__communicator>` :param:`c` = {}, int :param:`root` = 0, bool :param:`all` = false)











Template parameters
^^^^^^^^^^^^^^^^^^^

 * :param:`T` Type to be gathered.


Parameters
^^^^^^^^^^

 * :param:`x` Object to be gathered.

 * :param:`c` mpi::communicator.

 * :param:`root` Rank of the root process.

 * :param:`all` Should all processes receive the result of the gather.


Returns
^^^^^^^

The result of the specialized `mpi_gather` call.