FlashGraph-ng
A new frontier in large-scale graph analysis and data mining
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
fg::page_vertex Class Referenceabstract

Vertex representation when in the page cache. More...

#include <vertex.h>

Inheritance diagram for fg::page_vertex:
fg::page_directed_vertex fg::page_undirected_vertex fg::TS_page_vertex

Public Member Functions

virtual size_t get_num_edges (edge_type type) const =0
 Get the number of edges connecting the vertex to othe vertices. More...
 
virtual edge_iterator get_neigh_begin (edge_type type) const =0
 Get an STL-style const iterator pointing to the first neighbor in a vertex's neighbor list. More...
 
virtual edge_iterator get_neigh_end (edge_type type) const =0
 Get an STL-style const iterator pointing to the end of a vertex's neighbor list. More...
 
virtual edge_seq_iterator get_neigh_seq_it (edge_type type, size_t start=0, size_t end=-1) const =0
 Get a java-style sequential const iterator that iterates the neighbors in the specified range. More...
 
virtual vertex_id_t get_id () const =0
 Get the vertex unique ID. More...
 
virtual size_t read_edges (edge_type type, vertex_id_t edges[], size_t num) const
 Read the edges of the specified type. More...
 
virtual bool is_directed () const
 Whether the vertex is directed. More...
 

Detailed Description

Vertex representation when in the page cache.

Member Function Documentation

virtual vertex_id_t fg::page_vertex::get_id ( ) const
pure virtual

Get the vertex unique ID.

Returns
The vertex unique ID.

Implemented in fg::page_undirected_vertex, and fg::page_directed_vertex.

virtual edge_iterator fg::page_vertex::get_neigh_begin ( edge_type  type) const
pure virtual

Get an STL-style const iterator pointing to the first neighbor in a vertex's neighbor list.

Returns
A const iterator pointing to the first neighbor in a vertex's neighbor list.
Parameters
typeThe type of edges a user wishes to iterate over e.g IN_EDGE, OUT_EDGE.

Implemented in fg::page_undirected_vertex, and fg::page_directed_vertex.

virtual edge_iterator fg::page_vertex::get_neigh_end ( edge_type  type) const
pure virtual

Get an STL-style const iterator pointing to the end of a vertex's neighbor list.

Returns
A const iterator pointing to the end of a vertex's neighbor list.
Parameters
typeThe type of edges a user wishes to iterate over e.g IN_EDGE, OUT_EDGE.

Implemented in fg::page_undirected_vertex, and fg::page_directed_vertex.

virtual edge_seq_iterator fg::page_vertex::get_neigh_seq_it ( edge_type  type,
size_t  start = 0,
size_t  end = -1 
) const
pure virtual

Get a java-style sequential const iterator that iterates the neighbors in the specified range.

Returns
A sequential const iterator.
Parameters
typeThe type of edges a user wishes to iterate over e.g IN_EDGE, OUT_EDGE.
startThe starting offset in the neighbor list iterated by the sequential iterator.
endThe end offset in the neighbor list iterated by the sequential iterator.

Implemented in fg::page_undirected_vertex, and fg::page_directed_vertex.

virtual size_t fg::page_vertex::get_num_edges ( edge_type  type) const
pure virtual

Get the number of edges connecting the vertex to othe vertices.

Returns
The number of edges conning the vertex.
Parameters
typeThe type of edges a user wishes to iterate over e.g IN_EDGE, OUT_EDGE.

Implemented in fg::page_undirected_vertex, and fg::page_directed_vertex.

virtual bool fg::page_vertex::is_directed ( ) const
inlinevirtual

Whether the vertex is directed.

Returns
true if it's a directed vertex.
virtual size_t fg::page_vertex::read_edges ( edge_type  type,
vertex_id_t  edges[],
size_t  num 
) const
inlinevirtual

Read the edges of the specified type.

Parameters
typeThe type of edges a user wishes to read e.g IN_EDGE, OUT_EDGE.
edgesThe array of edges returned to a user.
numThe maximal number of edges read by a user.

Reimplemented in fg::page_undirected_vertex, and fg::page_directed_vertex.


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