Utopia::ParallelExecution Class Reference

Static information on the status of parallel execution. More...

#include <parallel.hh>

Public Types
enum	Setting { enabled , disabled }
	Possible settings for parallel execution. More...

Static Public Member Functions
static void	init (const DataIO::Config &cfg)
	Initialize parallel features based on configuration setting.
static void	set (const Setting value)
	Choose a setting for parallel execution at runtime.
static bool	is_enabled ()
	Query if parallel execution is currently enabled.
static bool	is_applied ()
	Actually check if parallel features are applied at runtime.

Static Private Member Functions
static std::shared_ptr< spdlog::logger >	get_logger ()
	Fetch the core logger.

Static Private Attributes
static bool	_enabled = false
	Runtime setting for parallel execution.

Detailed Description

Static information on the status of parallel execution.

Note

Using this class requires the Utopia core logger to be set up, which can conveniently done by calling Utopia::setup_loggers().

Member Enumeration Documentation

Setting

enum Utopia::ParallelExecution::Setting

Possible settings for parallel execution.

Enumerator
enabled	Enable parallel execution.
disabled	Disable parallel execution.

    {
        enabled, 
        disabled 
    };

Member Function Documentation

get_logger()

static std::shared_ptr< spdlog::logger > Utopia::ParallelExecution::get_logger ( )

inlinestaticprivate

Fetch the core logger.

Returns

Valid shared pointer to the logger

Exceptions

runtime_error

If logger does not exist

    {
        const auto log = spdlog::get(Utopia::log_core);
        if (not log)
        {
            throw std::runtime_error("Cannot fetch core logger!");
        }
 
        return log;
    }

init()

static void Utopia::ParallelExecution::init ( const DataIO::Config &  cfg )

inlinestatic

Initialize parallel features based on configuration setting.

Parameters

cfg	Parameter space config node

Note

If the required parameter is not found, parallel features are disabled by default.

    {
        bool setting = false;
 
        // Try fetching settings on parallel execution
        if (const YAML::Node& cfg_par = cfg["parallel_execution"])
        {
            setting = get_as<bool>("enabled", cfg_par);
        }
 
        if (setting)
            set(Setting::enabled);
        else
            set(Setting::disabled);
    }

is_applied()

static bool Utopia::ParallelExecution::is_applied ( )

inlinestatic

Actually check if parallel features are applied at runtime.

Note

This method is implemented for testing purposes only and should not be used to change model or algorithm behavior!

    {
#ifdef UTOPIA_PARALLEL
        return _enabled;
#else
        return false;
#endif
    }

is_enabled()

static bool Utopia::ParallelExecution::is_enabled ( )

inlinestatic

Query if parallel execution is currently enabled.

Note

This value does not imply if parallel execution actually applies. If prerequisites are not met, parallel algorithms will default to sequential execution.

{ return _enabled; }

set()

static void Utopia::ParallelExecution::set ( const Setting  value )

inlinestatic

Choose a setting for parallel execution at runtime.

This setting may be changed at any time during runtime. However, algorithms currently running will continue with the policy they have been started with.

    {
        _enabled = (value == Setting::enabled);
 
        const auto log = get_logger();
        std::string msg = fmt::format("Parallel execution {}",
                                      _enabled ? "enabled" : "disabled");
 
#ifdef UTOPIA_PARALLEL
        log->info(msg);
#else
        msg += ", but settings do NOT apply";
        if (_enabled)
            log->warn(msg);
        else
            log->debug(msg);
#endif
    }

Member Data Documentation

_enabled

bool Utopia::ParallelExecution::_enabled = false

inlinestaticprivate

Runtime setting for parallel execution.

---

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

• include/utopia/core/parallel.hh