Public Member Functions | Public Attributes

graphlab::engine_options Class Reference

#include <engine_options.hpp>

Inheritance diagram for graphlab::engine_options:
graphlab::command_line_options

List of all members.

Public Member Functions

void use_distributed_options ()
 Use distributed options instead of shared memory options.
void set_cpu_affinities (bool enabled)
 Set the cpu affinities value (true = enabled).
bool get_cpu_affinities () const
 Get the cpu affinities value (true = enabled).
void set_sched_yield (bool enabled)
 Turn on schedule yielding (true = enabled).
bool get_sched_yield () const
 Get schedule yielding value (true = enabled).
void set_ncpus (size_t n)
 Set the number of cpus.
size_t get_ncpus () const
 Get the number of cpus.
bool set_engine_type (const std::string &etype)
 Set the engine type.
const std::string & get_engine_type () const
 Get the engine type.
bool set_scope_type (const std::string &stype)
 Set the scope type.
const std::string & get_scope_type () const
 Get the scope type.
bool set_scheduler_type (const std::string &stype)
 Set the scope type.
const std::string & get_scheduler_type () const
 Get the scope type.
bool set_metrics_type (const std::string &mtype)
 Set the metrics type.
const std::string & get_metrics_type () const
 Get the metrics type.
const scheduler_optionsget_scheduler_options () const
 Get the scheduler options.
scheduler_optionsget_scheduler_options ()
 Get the scheduler options.
const scheduler_optionsget_engine_options () const
 Get the scheduler options.
scheduler_optionsget_engine_options ()
 Get the scheduler options.
const std::string & get_compile_flags () const
 Get the compiler options (flags).
virtual void print () const
void save (oarchive &arc) const
void load (iarchive &arc)

Public Attributes

size_t ncpus
 The number of cpus.
std::string engine_type
 The type of engine {async, async_sim, synchronous}.
scheduler_options engine_opts
std::string scope_type
 The type of scope.
std::string scheduler_type
 The type of scheduler to use.
std::string metrics_type
 Metrics type.
scheduler_options scheduler_opts
 The options associated with the scheduler.
std::string compile_flags
 The compiler flags.
bool enable_cpu_affinities
 Use CPU affinities.
bool enable_sched_yield
bool distributed_options

Detailed Description

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

Definition at line 55 of file engine_options.hpp.


Member Function Documentation

void graphlab::engine_options::load ( iarchive arc  )  [inline]

Load the engine options from a serialized archive TODO: does not save scheduler options

Definition at line 268 of file engine_options.hpp.

virtual void graphlab::engine_options::print (  )  const [inline, virtual]

create an engine for the given graph using the engine options. If the engine options are not set correctly this will return NULL. Display the current engine options

Definition at line 231 of file engine_options.hpp.

void graphlab::engine_options::save ( oarchive arc  )  const [inline]

Save the engine options to a serialized archive TODO: does not save scheduler options

Definition at line 252 of file engine_options.hpp.


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