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::graph_config Class Reference

#include <graph_config.h>

Public Member Functions

 graph_config ()
 The default constructor that set all configurations to their default values.
 
void print_help ()
 Print the explanations of all configurations.
 
void print ()
 Print the current values of all configurations.
 
void init (config_map::ptr map)
 Set the configurations to the user-defined values.
 
const std::string & get_prof_file () const
 Get the output file containing CPU profiling. More...
 
int get_num_threads () const
 Get the number of worker threads used by the graph engine. More...
 
bool get_elevator_enabled () const
 Determine whehter to use the elevator algorithm in accessing the adjacency lists of vertices from SSDs. More...
 
const std::string & get_trace_file () const
 Get the I/O trace file that records all I/O requests generated by the graph engine. More...
 
int get_max_processing_vertices () const
 Get the maximal number of vertices being processed by a worker thread. More...
 
int get_part_range_size_log () const
 Get the size of a partition range at log scale. More...
 
bool preload () const
 Determine whether to preload the graph data to the page cache. More...
 
int get_index_file_weight () const
 Get the weight for graph index file. A SAFS file has weight that is used in the page cache. The pages of the files with higher weight should are more likely to stay in the page cache. More...
 
bool use_in_mem_index () const
 Determine whether to use in-mem vertex index. More...
 
bool use_in_mem_graph () const
 Determine whether to use in-mem graph data. More...
 
bool use_serial_run () const
 Determine whether to run the user code on a vertex in serial. More...
 
int get_num_vparts () const
 Get the number of vertical partitions. More...
 
int get_min_vpart_degree () const
 Get the min degree of a vertex to perform vertical partitioning. More...
 
int get_vertex_merge_gap () const
 Get the size of a gap that is allowed when merging two vertex requests. When the gap is 0, it means only two vertices that are either on the same page or two adjacent pages can be merged. More...
 

Detailed Description

The data structure contains the configurations for the graph engine.

Member Function Documentation

bool fg::graph_config::get_elevator_enabled ( ) const
inline

Determine whehter to use the elevator algorithm in accessing the adjacency lists of vertices from SSDs.

Returns
true if the elevator algorithm is used.
int fg::graph_config::get_index_file_weight ( ) const
inline

Get the weight for graph index file. A SAFS file has weight that is used in the page cache. The pages of the files with higher weight should are more likely to stay in the page cache.

Returns
the weight for graph index file.
int fg::graph_config::get_max_processing_vertices ( ) const
inline

Get the maximal number of vertices being processed by a worker thread.

Returns
the maximal number of vertices.
int fg::graph_config::get_min_vpart_degree ( ) const
inline

Get the min degree of a vertex to perform vertical partitioning.

Returns
The min degree of a vertex to perform vertical partitioning.
int fg::graph_config::get_num_threads ( ) const
inline

Get the number of worker threads used by the graph engine.

Returns
The number of worker threads.
int fg::graph_config::get_num_vparts ( ) const
inline

Get the number of vertical partitions.

Returns
The number of vertical partitions.
int fg::graph_config::get_part_range_size_log ( ) const
inline

Get the size of a partition range at log scale.

Returns
the size of a partition range at log scale.
const std::string& fg::graph_config::get_prof_file ( ) const
inline

Get the output file containing CPU profiling.

Returns
the file name.
const std::string& fg::graph_config::get_trace_file ( ) const
inline

Get the I/O trace file that records all I/O requests generated by the graph engine.

Returns
the I/O trace file anme.
int fg::graph_config::get_vertex_merge_gap ( ) const
inline

Get the size of a gap that is allowed when merging two vertex requests. When the gap is 0, it means only two vertices that are either on the same page or two adjacent pages can be merged.

Returns
the gap size (in pages).
bool fg::graph_config::preload ( ) const
inline

Determine whether to preload the graph data to the page cache.

Returns
true if the graph is preloaded; else false.
bool fg::graph_config::use_in_mem_graph ( ) const
inline

Determine whether to use in-mem graph data.

Returns
true if the graph engine loads the entire graph data in memory in advance.
bool fg::graph_config::use_in_mem_index ( ) const
inline

Determine whether to use in-mem vertex index.

Returns
true if the graph engine uses in-mem vertex index.
bool fg::graph_config::use_serial_run ( ) const
inline

Determine whether to run the user code on a vertex in serial.

Returns
true if the graph engine runs the user code on a vertex in serial.

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