Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::mpi::detail::comm_out_edge_iterator Class Reference

INTERNAL ONLY. More...

#include <graph_communicator.hpp>

Inheritance diagram for boost::mpi::detail::comm_out_edge_iterator:
Collaboration diagram for boost::mpi::detail::comm_out_edge_iterator:

Public Member Functions

 comm_out_edge_iterator ()
 
 comm_out_edge_iterator (int source, shared_array< int > neighbors, int index)
 

Protected Member Functions

const std::pair< int, int > & dereference () const
 
bool equal (const comm_out_edge_iterator &other) const
 
void increment ()
 
void decrement ()
 
void advance (int n)
 
int distance_to (const comm_out_edge_iterator &other) const
 

Protected Attributes

std::pair< int, int > edge
 
shared_array< int > neighbors
 
int index
 

Friends

class boost::iterator_core_access
 

Detailed Description

INTERNAL ONLY.

The iterator used to access the outgoing edges within a communicator's graph topology.

Constructor & Destructor Documentation

boost::mpi::detail::comm_out_edge_iterator::comm_out_edge_iterator ( )
inline
boost::mpi::detail::comm_out_edge_iterator::comm_out_edge_iterator ( int  source,
shared_array< int >  neighbors,
int  index 
)
inline

Member Function Documentation

void boost::mpi::detail::comm_out_edge_iterator::advance ( int  n)
inlineprotected

References index, and boost::n.

void boost::mpi::detail::comm_out_edge_iterator::decrement ( )
inlineprotected

References index.

const std::pair<int, int>& boost::mpi::detail::comm_out_edge_iterator::dereference ( ) const
inlineprotected

References edge, index, and neighbors.

int boost::mpi::detail::comm_out_edge_iterator::distance_to ( const comm_out_edge_iterator other) const
inlineprotected

References index.

bool boost::mpi::detail::comm_out_edge_iterator::equal ( const comm_out_edge_iterator other) const
inlineprotected

References edge, and index.

void boost::mpi::detail::comm_out_edge_iterator::increment ( )
inlineprotected

References index.

Friends And Related Function Documentation

friend class boost::iterator_core_access
friend

Member Data Documentation

std::pair<int, int> boost::mpi::detail::comm_out_edge_iterator::edge
mutableprotected

Referenced by dereference(), and equal().

int boost::mpi::detail::comm_out_edge_iterator::index
protected
shared_array<int> boost::mpi::detail::comm_out_edge_iterator::neighbors
protected

Referenced by dereference().


The documentation for this class was generated from the following file: