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_undirected_vertex Class Reference

This vertex class represents an undirected vertex in the page cache. More...

#include <vertex.h>

Inheritance diagram for fg::page_undirected_vertex:
fg::page_vertex

Public Member Functions

size_t get_num_edges (edge_type type=edge_type::IN_EDGE) const
 Get the number of edges of a specific edge_type associated with the vertex. More...
 
edge_iterator get_neigh_begin (edge_type type) const
 Get an STL-style const iterator pointing to the first element in the neighbor list of a vertex. More...
 
edge_iterator get_neigh_end (edge_type type) const
 Get an STL-style const iterator pointing to the end of the neighbor list of a vertex. More...
 
edge_seq_iterator get_neigh_seq_it (edge_type type, size_t start=0, size_t end=-1) const
 Get a java-style sequential const iterator for the specified range in a vertex's neighbor list. 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...
 
template<class edge_data_type >
safs::page_byte_array::seq_const_iterator
< edge_data_type > 
get_data_seq_it (size_t start, size_t end) const
 Get a java-style sequential const iterator for edge data with additional parameters to define the range to iterate. More...
 
template<class edge_data_type >
safs::page_byte_array::seq_const_iterator
< edge_data_type > 
get_data_seq_it () const
 Get a java-style sequential const iterator that iterates the edge data list. More...
 
vertex_id_t get_id () const
 Get the vertex ID. More...
 
- Public Member Functions inherited from fg::page_vertex
virtual bool is_directed () const
 Whether the vertex is directed. More...
 

Detailed Description

This vertex class represents an undirected vertex in the page cache.

Member Function Documentation

template<class edge_data_type >
safs::page_byte_array::seq_const_iterator<edge_data_type> fg::page_undirected_vertex::get_data_seq_it ( size_t  start,
size_t  end 
) const
inline

Get a java-style sequential const iterator for edge data with additional parameters to define the range to iterate.

Returns
A sequential const iterator.
Parameters
startThe starting offset in the edge list.
endThe end offset in the edge list.
template<class edge_data_type >
safs::page_byte_array::seq_const_iterator<edge_data_type> fg::page_undirected_vertex::get_data_seq_it ( ) const
inline

Get a java-style sequential const iterator that iterates the edge data list.

Returns
A sequential const iterator.
vertex_id_t fg::page_undirected_vertex::get_id ( ) const
inlinevirtual

Get the vertex ID.

Returns
The vertex ID.

Implements fg::page_vertex.

edge_iterator fg::page_undirected_vertex::get_neigh_begin ( edge_type  type) const
inlinevirtual

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

Parameters
typeThe type of edge i.e IN_EDGE, OUT_EDGE are equivalent, since it's an undirected vertex.
Returns
A const iterator pointing to the first element in the neighbor list of a vertex.

Implements fg::page_vertex.

edge_iterator fg::page_undirected_vertex::get_neigh_end ( edge_type  type) const
inlinevirtual

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

Parameters
typeThe type of edge i.e IN_EDGE, OUT_EDGE are equivalent, since it's an undirected vertex.
Returns
A const iterator pointing to the end of the neighbor list of a vertex.

Implements fg::page_vertex.

edge_seq_iterator fg::page_undirected_vertex::get_neigh_seq_it ( edge_type  type,
size_t  start = 0,
size_t  end = -1 
) const
inlinevirtual

Get a java-style sequential const iterator for the specified range in a vertex's neighbor list.

Parameters
typeThe type of edge i.e IN_EDGE, OUT_EDGE are equivalent, since it's an undirected vertex.
startThe starting offset in the neighbor list iterated by the sequential iterator.
endThe end offset in the neighbor list iterated by the sequential iterator.
Returns
A sequential const iterator for the specified range in a vertex's neighbor list.

Implements fg::page_vertex.

size_t fg::page_undirected_vertex::get_num_edges ( edge_type  type = edge_type::IN_EDGE) const
inlinevirtual

Get the number of edges of a specific edge_type associated with the vertex.

Parameters
typeThe type of edge i.e IN_EDGE, OUT_EDGE are equivalent, since it's an undirected vertex. return The number of edges associated with the vertex.

Implements fg::page_vertex.

virtual size_t fg::page_undirected_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 edge i.e IN_EDGE, OUT_EDGE are equivalent, since it's an undirected vertex.
edgesThe array of edges returned to a user.
numThe maximal number of edges read by a user.

Reimplemented from fg::page_vertex.


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