Apache GraphAr C++ Library
The C++ Library for Apache GraphAr
Public Member Functions | List of all members
graphar::VertexIter Class Reference

The iterator for traversing a type of vertices. More...

#include <graph_reader.h>

Public Member Functions

 VertexIter (const std::shared_ptr< VertexInfo > &vertex_info, const std::string &prefix, IdType offset, const std::vector< std::string > &labels, const bool &is_filtered=false, const std::vector< IdType > &filtered_ids={}) noexcept
 
 VertexIter (const VertexIter &other)
 
Vertex operator* () noexcept
 
IdType id ()
 
template<typename T >
Result< T > property (const std::string &property) noexcept
 
Result< bool > hasLabel (const std::string &label) noexcept
 
Result< std::vector< std::string > > label () noexcept
 
VertexIter & operator++ () noexcept
 
VertexIter operator++ (int)
 
VertexIter operator+ (IdType offset)
 
VertexIter & operator+= (IdType offset)
 
bool operator== (const VertexIter &rhs) const noexcept
 
bool operator!= (const VertexIter &rhs) const noexcept
 

Detailed Description

The iterator for traversing a type of vertices.

Definition at line 171 of file graph_reader.h.

Constructor & Destructor Documentation

◆ VertexIter() [1/2]

graphar::VertexIter::VertexIter ( const std::shared_ptr< VertexInfo > &  vertex_info,
const std::string &  prefix,
IdType  offset,
const std::vector< std::string > &  labels,
const bool &  is_filtered = false,
const std::vector< IdType > &  filtered_ids = {} 
)
inlineexplicitnoexcept

Initialize the iterator.

Parameters
vertex_infoThe vertex info that describes the vertex type.
prefixThe absolute prefix.
offsetThe current offset of the readers.

Definition at line 180 of file graph_reader.h.

◆ VertexIter() [2/2]

graphar::VertexIter::VertexIter ( const VertexIter &  other)
inline

Copy constructor.

Definition at line 199 of file graph_reader.h.

Member Function Documentation

◆ hasLabel()

Result< bool > graphar::VertexIter::hasLabel ( const std::string &  label)
noexcept

Determine whether a vertex has the input label.

Definition at line 103 of file graph_reader.cc.

◆ id()

IdType graphar::VertexIter::id ( )
inline

Get the vertex id of the current offset.

Definition at line 223 of file graph_reader.h.

◆ label()

Result< std::vector< std::string > > graphar::VertexIter::label ( )
noexcept

Get the labels of the current vertex.

Definition at line 117 of file graph_reader.cc.

◆ operator!=()

bool graphar::VertexIter::operator!= ( const VertexIter &  rhs) const
inlinenoexcept

The inequality operator.

Definition at line 304 of file graph_reader.h.

◆ operator*()

Vertex graphar::VertexIter::operator* ( )
inlinenoexcept

Construct and return the vertex of the current offset.

Definition at line 208 of file graph_reader.h.

◆ operator+()

VertexIter graphar::VertexIter::operator+ ( IdType  offset)
inline

The add operator.

Definition at line 286 of file graph_reader.h.

◆ operator++() [1/2]

VertexIter& graphar::VertexIter::operator++ ( )
inlinenoexcept

The prefix increment operator.

Definition at line 273 of file graph_reader.h.

◆ operator++() [2/2]

VertexIter graphar::VertexIter::operator++ ( int  )
inline

The postfix increment operator.

Definition at line 279 of file graph_reader.h.

◆ operator+=()

VertexIter& graphar::VertexIter::operator+= ( IdType  offset)
inline

The add-assign operator.

Definition at line 293 of file graph_reader.h.

◆ operator==()

bool graphar::VertexIter::operator== ( const VertexIter &  rhs) const
inlinenoexcept

The equality operator.

Definition at line 299 of file graph_reader.h.

◆ property()

template<typename T >
Result<T> graphar::VertexIter::property ( const std::string &  property)
inlinenoexcept

Get the value for a property of the current vertex.

Definition at line 233 of file graph_reader.h.

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