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

#include <chunk_info_reader.h>

Public Member Functions

 AdjListChunkInfoReader (const std::shared_ptr< EdgeInfo > &edge_info, AdjListType adj_list_type, const std::string &prefix)
 Initialize the AdjListChunkInfoReader. More...
 
Status seek_src (IdType id)
 Sets chunk position indicator for reader by source internal vertex id. More...
 
Status seek_dst (IdType id)
 Sets chunk position indicator for reader by destination internal vertex id. More...
 
Status seek (IdType index)
 Sets chunk position indicator for reader by edge index. More...
 
Result< std::string > GetChunk ()
 
Status next_chunk ()
 

Static Public Member Functions

static Result< std::shared_ptr< AdjListChunkInfoReader > > Make (const std::shared_ptr< EdgeInfo > &edge_info, AdjListType adj_list_type, const std::string &prefix)
 Create an AdjListChunkInfoReader instance from edge info. More...
 
static Result< std::shared_ptr< AdjListChunkInfoReader > > Make (const std::shared_ptr< GraphInfo > &graph_info, const std::string &src_label, const std::string &edge_label, const std::string &dst_label, AdjListType adj_list_type)
 Create an AdjListChunkInfoReader instance from graph info. More...
 

Detailed Description

The chunk info reader for adj list topology chunk.

Definition at line 119 of file chunk_info_reader.h.

Constructor & Destructor Documentation

◆ AdjListChunkInfoReader()

graphar::AdjListChunkInfoReader::AdjListChunkInfoReader ( const std::shared_ptr< EdgeInfo > &  edge_info,
AdjListType  adj_list_type,
const std::string &  prefix 
)
explicit

Initialize the AdjListChunkInfoReader.

Parameters
edge_infoThe edge info that describes the edge type.
adj_list_typeThe adj list type for the edges.
prefixThe absolute prefix of the graph.

Definition at line 113 of file chunk_info_reader.cc.

Member Function Documentation

◆ GetChunk()

Result< std::string > graphar::AdjListChunkInfoReader::GetChunk ( )

Return the current chunk file path of chunk position indicator.

Definition at line 208 of file chunk_info_reader.cc.

◆ Make() [1/2]

Result< std::shared_ptr< AdjListChunkInfoReader > > graphar::AdjListChunkInfoReader::Make ( const std::shared_ptr< EdgeInfo > &  edge_info,
AdjListType  adj_list_type,
const std::string &  prefix 
)
static

Create an AdjListChunkInfoReader instance from edge info.

Parameters
edge_infoThe edge info.
adj_list_typeThe adj list type for the edges.
prefixThe absolute prefix of the graph.

Definition at line 232 of file chunk_info_reader.cc.

◆ Make() [2/2]

Result< std::shared_ptr< AdjListChunkInfoReader > > graphar::AdjListChunkInfoReader::Make ( const std::shared_ptr< GraphInfo > &  graph_info,
const std::string &  src_label,
const std::string &  edge_label,
const std::string &  dst_label,
AdjListType  adj_list_type 
)
static

Create an AdjListChunkInfoReader instance from graph info.

Parameters
graph_infoThe graph info.
src_labelThe source vertex label.
edge_labelThe edge label.
dst_labelThe destination vertex label.
adj_list_typeThe adj list type for the edges.

Definition at line 244 of file chunk_info_reader.cc.

◆ next_chunk()

Status graphar::AdjListChunkInfoReader::next_chunk ( )

Sets chunk position indicator to next chunk.

if current chunk is the last chunk, will return Status::IndexError error.

Definition at line 215 of file chunk_info_reader.cc.

◆ seek()

Status graphar::AdjListChunkInfoReader::seek ( IdType  index)

Sets chunk position indicator for reader by edge index.

Parameters
offsetedge index of the vertex chunk. Note: the offset is the edge index of the vertex chunk, not the edge index of the whole graph.

Definition at line 198 of file chunk_info_reader.cc.

◆ seek_dst()

Status graphar::AdjListChunkInfoReader::seek_dst ( IdType  id)

Sets chunk position indicator for reader by destination internal vertex id.

Parameters
idthe destination internal vertex id.

Definition at line 166 of file chunk_info_reader.cc.

◆ seek_src()

Status graphar::AdjListChunkInfoReader::seek_src ( IdType  id)

Sets chunk position indicator for reader by source internal vertex id.

Parameters
idthe source internal vertex id.

Definition at line 133 of file chunk_info_reader.cc.

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