..
   Generated automatically by cpp2rst

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


.. _mpi__mpi_broadcast:

mpi::mpi_broadcast
==================

*#include <mpi.hpp>*



**Synopsis**

 .. rst-class:: cppsynopsis

    1. | :green:`template<typename T>`
       | void :red:`mpi_broadcast` (T & :param:`x`, :ref:`communicator <mpi__communicator>` :param:`c` = {}, int :param:`root` = 0)

    2. | :green:`template<typename T>`
       | void :red:`mpi_broadcast` (std::vector<T> & :param:`v`, :ref:`communicator <mpi__communicator>` :param:`c` = {}, int :param:`root` = 0)

    3. | void :red:`mpi_broadcast` (std::string & :param:`s`, :ref:`communicator <mpi__communicator>` :param:`c`, int :param:`root`)

Documentation





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

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


Parameters
^^^^^^^^^^

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

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

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

 * :param:`v` std::vector to broadcast.

 * :param:`s` std::string to broadcast.