GraphLab: Distributed Graph-Parallel API  2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
graphlab::graphlab_options Class Reference

#include <graphlab/options/graphlab_options.hpp>

List of all members.

Public Member Functions

void set_ncpus (size_t n)
 Set the number of cpus.
size_t get_ncpus () const
 Get the number of cpus.
void set_scheduler_type (const std::string &stype)
const std::string & get_scheduler_type () const
 Get the type of scheduler.
const options_mapget_engine_args () const
 Get the engine arguments.
options_mapget_engine_args ()
 Get the engine arguments.
const options_mapget_graph_args () const
options_mapget_graph_args ()
const options_mapget_scheduler_args () const
options_mapget_scheduler_args ()
virtual void print () const

Public Attributes

size_t ncpus
 The number of cpus.
std::string scheduler_type
 The type of scheduler to use.
options_map engine_args
 additional arguments to the engine
options_map scheduler_args
 additional arguments to the scheduler
options_map graph_args
 Options for the graph.

Detailed Description

The engine options class is really a simple struct that contains the basic options needed to create an engine. These options include:

  • size_t ncpus: The number of cpus (threads) to use for this engine.

  • std::string engine_type: The type of engine to use. Currently we support {async, synchronous}.

  • std::string scheduler_type: The type of scheduler to user. Currently we support a wide range of schedulers: {synchronous, fifo, priority, sampling, splash, sweep, multiqueue_fifo, multiqueue_priority, set, clustered_priority, round_robin, chromatic}

  • size_t splash_size: The size parameter for the splash scheduler.

Definition at line 67 of file graphlab_options.hpp.


Member Function Documentation

virtual void graphlab::graphlab_options::print ( ) const
inlinevirtual

Display the current engine options

Definition at line 151 of file graphlab_options.hpp.


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