X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fhtml%2Fboost%2Fmpi%2Fstatus.html;h=8486d14f8cf495d184469a81d05ef2722c4698e5;hb=08c1e93fa36a49f49325a07fe91ff92c964c2b6c;hp=c3bc4bb78aba3004fb6b7d9aecb0f6a1b9c023f5;hpb=bb4dd8289b351fae6b55e303f189127a394a1edd;p=platform%2Fupstream%2Fboost.git diff --git a/doc/html/boost/mpi/status.html b/doc/html/boost/mpi/status.html index c3bc4bb..8486d14 100644 --- a/doc/html/boost/mpi/status.html +++ b/doc/html/boost/mpi/status.html @@ -3,7 +3,7 @@ Class status - + @@ -35,61 +35,64 @@ class status { public: // construct/copy/destruct - status(); - status(MPI_Status const &); + status(); + status(MPI_Status const &); - // public member functions - int source() const; - int tag() const; - int error() const; - bool cancelled() const; - template<typename T> optional< int > count() const; - operator MPI_Status &(); - operator const MPI_Status &() const; + // public member functions + int source() const; + int tag() const; + int error() const; + bool cancelled() const; + template<typename T> optional< int > count() const; + operator MPI_Status &(); + operator const MPI_Status &() const; // public data members mutable int m_count; };
-

Description

+

Description

This structure contains status information about messages that have been received (with communicator::recv) or can be received (returned from communicator::probe or communicator::iprobe). It permits access to the source of the message, message tag, error code (rarely used), or the number of elements that have been transmitted.

-

+

status public construct/copy/destruct

    -
  1. status();
    2. -
  2. status(MPI_Status const & s);
    3. +
  3. status();
    4. +
  4. status(MPI_Status const & s);
-

-status public member functions

+

+status public member functions

  1. -
    int source() const;
    +
    int source() const;

    Retrieve the source of the message.

  2. -
    int tag() const;
    +
    int tag() const;

    Retrieve the message tag.

  3. -
    int error() const;
    +
    int error() const;

    Retrieve the error code.

  4. -
    bool cancelled() const;
    +
    bool cancelled() const;

    Determine whether the communication associated with this object has been successfully cancelled.

  5. -
    template<typename T> optional< int > count() const;
    +
    template<typename T> optional< int > count() const;

    Determines the number of elements of type T contained in the message. The type T must have an associated data type, i.e., is_mpi_datatype<T> must derive mpl::true_. In cases where the type T does not match the transmitted type, this routine will return an empty optional<int>.

    -
    +
    +++ @@ -97,11 +100,11 @@

    Returns:

    the number of T elements in the message, if it can be determined.

  6. -
    operator MPI_Status &();
    +
    operator MPI_Status &();

    References the underlying MPI_Status

  7. -
    operator const MPI_Status &() const;
    +
    operator const MPI_Status &() const;

    References the underlying MPI_Status