#include <synchronous_scope.hpp>
Public Types | |
| typedef iscope< Graph > | base |
| typedef Graph::vertex_data_type | vertex_data_type |
| The vertex data type associated with the graph. | |
| typedef Graph::edge_data_type | edge_data_type |
| The edge data type associated with the graph. | |
Public Member Functions | |
| synchronous_scope (Graph *srcgraph, Graph *destgraph, Graph *vertexdatagraph, vertex_id_t vertex) | |
| void | commit () |
| commits all changes. This is called by the engine after the update function returns. | |
| void | init (Graph *srcgraph, Graph *destgraph, Graph *vertexdatagraph, vertex_id_t vertex) |
| vertex_data_type & | vertex_data () |
| Returns the data on the base vertex. | |
| const vertex_data_type & | vertex_data () const |
| Get an immutable reference to the data associated with the vase vertex. | |
| const vertex_data_type & | const_vertex_data () const |
| Get an immutable reference to the data associated with the vase vertex. | |
| const edge_data_type & | edge_data (edge_id_t eid) const |
| Direct calls to access edge data. | |
| const edge_data_type & | const_edge_data (edge_id_t eid) const |
| Direct calls to access edge data. | |
| edge_data_type & | edge_data (edge_id_t eid) |
| Get a mutable reference to the data associated with the edge. | |
| const vertex_data_type & | neighbor_vertex_data (vertex_id_t vertex) const |
| get an immutable reference to the data associated with a neighboring vertex. | |
| const vertex_data_type & | const_neighbor_vertex_data (vertex_id_t vertex) const |
| get an immutable reference to the data associated with a neighboring vertex. | |
| vertex_data_type & | neighbor_vertex_data (vertex_id_t vertex) |
| get a mutable reference to the data associated with a neighboring vertex. | |
Detailed Description
template<typename Graph>
class graphlab::synchronous_scope< Graph >
This defines a scope type which is meant for "synchronous" type of algorithms. This type of scope should only be used by synchronous_engine
Definition at line 34 of file synchronous_scope.hpp.
Member Function Documentation
| const vertex_data_type& graphlab::synchronous_scope< Graph >::const_neighbor_vertex_data | ( | vertex_id_t | vertex | ) | const [inline, virtual] |
get an immutable reference to the data associated with a neighboring vertex.
This function should only be invoked on neighboring vertices. Unfortunately, due to the Log(d) lookup required to enforce the adjacency constraint we do not check at this time.
Implements graphlab::iscope< Graph >.
Definition at line 117 of file synchronous_scope.hpp.
| const vertex_data_type& graphlab::synchronous_scope< Graph >::const_vertex_data | ( | ) | const [inline, virtual] |
Get an immutable reference to the data associated with the vase vertex.
This should be called if the data does not need to be modified.
Implements graphlab::iscope< Graph >.
Definition at line 81 of file synchronous_scope.hpp.
| edge_data_type& graphlab::synchronous_scope< Graph >::edge_data | ( | edge_id_t | eid | ) | [inline, virtual] |
Get a mutable reference to the data associated with the edge.
This should only be invoked on edges that are adjacent to the base vertex. If the edge_data is not going to be modified the const version of this function should be used to permit further optimization.
Implements graphlab::iscope< Graph >.
Definition at line 102 of file synchronous_scope.hpp.
| const vertex_data_type& graphlab::synchronous_scope< Graph >::neighbor_vertex_data | ( | vertex_id_t | vertex | ) | const [inline, virtual] |
get an immutable reference to the data associated with a neighboring vertex.
- Deprecated:
- Use const_neighbor_vertex_data This function should only be invoked on neighboring vertices. Unfortunately, due to the Log(d) lookup required to enforce the adjacency constraint we do not check at this time.
Implements graphlab::iscope< Graph >.
Definition at line 113 of file synchronous_scope.hpp.
| vertex_data_type& graphlab::synchronous_scope< Graph >::neighbor_vertex_data | ( | vertex_id_t | vertex | ) | [inline, virtual] |
get a mutable reference to the data associated with a neighboring vertex.
This function should only be invoked on neighboring vertices. Unfortunately, due to the Log(d) lookup required to enforce the adjacency constraint we do not check at this time. If the neighboring vertex data is not going to be modified the const version of this function should be called to permit further optimization by the graphlab engine.
Implements graphlab::iscope< Graph >.
Definition at line 121 of file synchronous_scope.hpp.
| const vertex_data_type& graphlab::synchronous_scope< Graph >::vertex_data | ( | ) | const [inline, virtual] |
Get an immutable reference to the data associated with the vase vertex.
- Deprecated:
- use const_vertex_data This should be called if the data does not need to be modified.
Implements graphlab::iscope< Graph >.
Definition at line 77 of file synchronous_scope.hpp.
The documentation for this class was generated from the following file:
- src/graphlab/scope/synchronous_scope.hpp
Generated on Tue May 17 2011 15:43:55 for GraphLab: A framework for Parallel Machine Learning by
1.7.1