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 | Static Public Member Functions | List of all members
fg::FG_graph Class Reference

A user-friendly wrapper for FlashGraph's raw graph type. Very usefule when when utilizing FlashGraph pre-written/library algorithms. More...

#include <FGlib.h>

Public Member Functions

 ~FG_graph ()
 
config_map::ptr get_configs () const
 Get the map that contains the runtime configurations for FlashGraph. More...
 
const graph_headerget_graph_header ()
 Get the header of the graph that contains basic information of the graph. More...
 

Static Public Member Functions

static ptr create (const std::string &graph_file, const std::string &index_file, config_map::ptr configs)
 Method to instantiate a graph object. This method is used in lieu of explicitly calling a ctor. More...
 
static ptr create (std::shared_ptr< in_mem_graph > graph_data, std::shared_ptr< vertex_index > index_data, const std::string &graph_name, config_map::ptr configs)
 Method to instantiate a graph object. This method is used in lieu of explicitly calling a ctor. More...
 

Detailed Description

A user-friendly wrapper for FlashGraph's raw graph type. Very usefule when when utilizing FlashGraph pre-written/library algorithms.

Constructor & Destructor Documentation

fg::FG_graph::~FG_graph ( )
inline

Smart pointer through which object is accessed

Member Function Documentation

static ptr fg::FG_graph::create ( const std::string &  graph_file,
const std::string &  index_file,
config_map::ptr  configs 
)
inlinestatic

Method to instantiate a graph object. This method is used in lieu of explicitly calling a ctor.

Parameters
graph_filePath to the graph file in SAFS or in Linux filesystem.
index_filePath to the graph index file in SAFS or in Linux filesystem.
configsConfiguration in configuration file.
static ptr fg::FG_graph::create ( std::shared_ptr< in_mem_graph >  graph_data,
std::shared_ptr< vertex_index >  index_data,
const std::string &  graph_name,
config_map::ptr  configs 
)
inlinestatic

Method to instantiate a graph object. This method is used in lieu of explicitly calling a ctor.

Parameters
graph_dataThe adjacency lists of the graph stored in memory.
index_dataThe index of the graph stored in memory.
graph_nameThe name of the graph.
configsConfiguration in configuration file.
config_map::ptr fg::FG_graph::get_configs ( ) const
inline

Get the map that contains the runtime configurations for FlashGraph.

Returns
The config_map that contains all FlashGraph configurations.
const graph_header& fg::FG_graph::get_graph_header ( )
inline

Get the header of the graph that contains basic information of the graph.

Returns
The graph header.

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