taskflow/taskflow/algorithm/module.hpp at master · taskflow/taskflow · GitHub

History

81 lines (60 loc) · 2.23 KB

Raw

#pragma once

#include "../taskflow.hpp"

/**

@file module.hpp

@brief module algorithm include file

namespace tf {

// ----------------------------------------------------------------------------

template <GraphLike T>

auto Algorithm::make_module_task(T& target) {

return [&graph=retrieve_graph(target)](tf::Runtime& rt){

if(graph.empty()) {

return;

}

rt._executor._schedule_graph(rt._worker, graph, rt._node->_topology, rt._node);

};

}

// ----------------------------------------------------------------------------

/**

@brief creates a module task using the given graph

@tparam T type satisfying tf::GraphLike

@param target the target object used to create the module task

@return a module task that can be used by %Taskflow or asynchronous tasking

This example demonstrates how to create and launch multiple taskflows in parallel

using modules with asynchronous tasking:

@code{.cpp}

tf::Executor executor;

tf::Taskflow A;

tf::Taskflow B;

tf::Taskflow C;

tf::Taskflow D;

A.emplace([](){ printf("Taskflow A\n"); });

B.emplace([](){ printf("Taskflow B\n"); });

C.emplace([](){ printf("Taskflow C\n"); });

D.emplace([](){ printf("Taskflow D\n"); });

// launch the four taskflows using asynchronous tasking

executor.async(tf::make_module_task(A));

executor.async(tf::make_module_task(B));

executor.async(tf::make_module_task(C));

executor.async(tf::make_module_task(D));

executor.wait_for_all();

@endcode

The module task maker, tf::make_module_task, is basically the same as tf::Taskflow::composed_of

but provides a more generic interface that can be used beyond %Taskflow.

For instance, the following two approaches achieve the same functionality.

@code{.cpp}

// approach 1: composition using composed_of

tf::Task m1 = taskflow1.composed_of(taskflow2);

// approach 2: composition using make_module_task

tf::Task m1 = taskflow1.emplace(tf::make_module_task(taskflow2));

@endcode

@attention

Users are responsible for ensuring that the given target remains valid throughout its execution.

The executor does not assume ownership of the target object.

template <GraphLike T>

auto make_module_task(T& target) {

return Algorithm::make_module_task(target);

}

} // end of namespact tf -----------------------------------------------------

taskflow/taskflow/algorithm/module.hpp at master · taskflow/taskflow · GitHub

Uh oh!

Expand file tree

Breadcrumbs

module.hpp

Latest commit

History

Breadcrumbs

module.hpp

File metadata and controls