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

#include <graph_info.h>

Public Member Functions

 AdjacentList (AdjListType type, FileType file_type, const std::string &prefix="")
 
AdjListType GetType () const
 Get the type of adjacent list. More...
 
FileType GetFileType () const
 Get the file type of adjacent list. More...
 
const std::string & GetPrefix () const
 Get the prefix of adjacent list. More...
 
bool IsValidated () const
 

Detailed Description

AdjacentList is a class to store the adjacency list information.

Definition at line 121 of file graph_info.h.

Constructor & Destructor Documentation

◆ AdjacentList()

graphar::AdjacentList::AdjacentList ( AdjListType  type,
FileType  file_type,
const std::string &  prefix = "" 
)
explicit

Initialize the AdjacentList with the given type, file type, and optional prefix

Parameters
typeType of adjacent list
file_typeFile type of adjacent list chunk file
prefixThe prefix of the adjacent list. If left empty, the default prefix will be set the type name of adjacent list

Definition at line 161 of file graph_info.cc.

Member Function Documentation

◆ GetFileType()

FileType graphar::AdjacentList::GetFileType ( ) const
inline

Get the file type of adjacent list.

Returns
The file type of adjacent list

Definition at line 147 of file graph_info.h.

◆ GetPrefix()

const std::string& graphar::AdjacentList::GetPrefix ( ) const
inline

Get the prefix of adjacent list.

Returns
The path prefix of adjacent list

Definition at line 154 of file graph_info.h.

◆ GetType()

AdjListType graphar::AdjacentList::GetType ( ) const
inline

Get the type of adjacent list.

Returns
The type of adjacent list

Definition at line 140 of file graph_info.h.

◆ IsValidated()

bool graphar::AdjacentList::IsValidated ( ) const

Returns whether the adjacent list is validated.

Returns
True if the adjacent list is valid, False otherwise.

Definition at line 169 of file graph_info.cc.


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