<html lang="en">

<meta charset="UTF-8" />

<title>Taskflow QuickStart</title>

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />

<link rel="stylesheet" href="m-dark+documentation.compiled.css" />

<link rel="icon" href="favicon.ico" type="image/vnd.microsoft.icon" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<meta name="theme-color" content="#22272e" />

<header><nav id="navigation">

<div class="m-container">

<div class="m-row">

<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">

<a href="https://taskflow.github.io"><img src="taskflow_logo.png" alt="" />Taskflow</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">QuickStart</a>

</span>

<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">

<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">

<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>

</svg></a>

<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>

<a id="m-navbar-hide" href="#" title="Hide navigation"></a>

</div>

<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">

<div class="m-row">

<ol class="m-col-t-6 m-col-m-none">

<li><a href="pages.html">Handbook</a></li>

<li><a href="namespaces.html">Namespaces</a></li>

</ol>

<ol class="m-col-t-6 m-col-m-none" start="3">

<li><a href="annotated.html" id="m-navbar-current">Classes</a></li>

<li><a href="files.html">Files</a></li>

<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">

<use href="#m-doc-search-icon-path" />

</svg></a></li>

</ol>

</div>

</div>

</div>

</div>

<div class="m-container m-container-inflatable">

<div class="m-row">

<div class="m-col-l-10 m-push-l-1">

<h1>Classes</h1>

<ul class="m-doc">

<li class="m-doc-collapsible">

<a href="#" onclick="return toggle(this)">namespace</a> <a href="namespacetf.html" class="m-doc">tf</a> <span class="m-doc">taskflow namespace</span>

<ul class="m-doc">

<li>class <a href="classtf_1_1ChromeObserver.html" class="m-doc">ChromeObserver</a> <span class="m-doc">observer interface based on Chrome tracing format</span></li>

<li>class <a href="classtf_1_1CriticalSection.html" class="m-doc">CriticalSection</a> <span class="m-doc">class to create a critical region of limited workers to run tasks</span></li>

<li>class <a href="classtf_1_1cudaCapturingBase.html" class="m-doc">cudaCapturingBase</a> <span class="m-doc">class to provide helper common methods for optimization algorithms</span></li>

<li>class <a href="classtf_1_1cudaExecutionPolicy.html" class="m-doc">cudaExecutionPolicy</a> <span class="m-doc">class to define execution policy for CUDA standard algorithms</span></li>

<li>class <a href="classtf_1_1cudaFlow.html" class="m-doc">cudaFlow</a> <span class="m-doc">class for building a CUDA task dependency graph</span></li>

<li>class <a href="classtf_1_1cudaFlowCapturer.html" class="m-doc">cudaFlowCapturer</a> <span class="m-doc">class for building a CUDA task dependency graph through stream capture</span></li>

<li>class <a href="classtf_1_1cudaLinearCapturing.html" class="m-doc">cudaLinearCapturing</a> <span class="m-doc">class to capture a linear CUDA graph using a sequential stream</span></li>

<li>class <a href="classtf_1_1cudaRoundRobinCapturing.html" class="m-doc">cudaRoundRobinCapturing</a> <span class="m-doc">class to capture a CUDA graph using a round-robin algorithm</span></li>

<li>class <a href="classtf_1_1cudaScopedDevice.html" class="m-doc">cudaScopedDevice</a> <span class="m-doc">RAII-styled device context switch.</span></li>

<li>class <a href="classtf_1_1cudaScopedPerThreadEvent.html" class="m-doc">cudaScopedPerThreadEvent</a> <span class="m-doc">class that provides RAII-styled guard of event acquisition</span></li>

<li>class <a href="classtf_1_1cudaScopedPerThreadStream.html" class="m-doc">cudaScopedPerThreadStream</a> <span class="m-doc">class that provides RAII-styled guard of stream acquisition</span></li>

<li>class <a href="classtf_1_1cudaSequentialCapturing.html" class="m-doc">cudaSequentialCapturing</a> <span class="m-doc">class to capture a CUDA graph using a sequential stream</span></li>

<li>class <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a> <span class="m-doc">handle to a node of the internal CUDA graph</span></li>

<li>class <a href="classtf_1_1Executor.html" class="m-doc">Executor</a> <span class="m-doc">execution interface for running a taskflow graph</span></li>

<li>class <a href="classtf_1_1FlowBuilder.html" class="m-doc">FlowBuilder</a> <span class="m-doc">building methods of a task dependency graph</span></li>

<li>class <a href="classtf_1_1Future.html" class="m-doc">Future</a> <span class="m-doc">class to access the result of task execution</span></li>

<li>class <a href="classtf_1_1ObserverInterface.html" class="m-doc">ObserverInterface</a> <span class="m-doc">The interface class for creating an executor observer.</span></li>

<li>class <a href="classtf_1_1Semaphore.html" class="m-doc">Semaphore</a> <span class="m-doc">class to create a semophore object for building a concurrency constraint</span></li>

<li>class <a href="classtf_1_1Subflow.html" class="m-doc">Subflow</a> <span class="m-doc">class to construct a subflow graph from the execution of a dynamic task</span></li>

<li>class <a href="classtf_1_1syclFlow.html" class="m-doc">syclFlow</a> <span class="m-doc">class for building a SYCL task dependency graph</span></li>

<li>class <a href="classtf_1_1syclTask.html" class="m-doc">syclTask</a> <span class="m-doc">handle to a node of the internal CUDA graph</span></li>

<li>class <a href="classtf_1_1Task.html" class="m-doc">Task</a> <span class="m-doc">handle to a node in a task dependency graph</span></li>

<li>class <a href="classtf_1_1Taskflow.html" class="m-doc">Taskflow</a> <span class="m-doc">main entry to create a task dependency graph</span></li>

<li>class <a href="classtf_1_1TaskView.html" class="m-doc">TaskView</a> <span class="m-doc">class to access task information from the observer interface</span></li>

<li>class <a href="classtf_1_1TFProfObserver.html" class="m-doc">TFProfObserver</a> <span class="m-doc">observer interface based on the built-in taskflow profiler format</span></li>

<li>class <a href="classtf_1_1WorkerView.html" class="m-doc">WorkerView</a> <span class="m-doc">class to create an immutable view of a worker in an executor</span></li>

</ul>

</li>

</ul>

<script>

function toggle(e) {

e.parentElement.className = e.parentElement.className == 'm-doc-collapsible' ?

'm-doc-expansible' : 'm-doc-collapsible';

return false;

}

/* Collapse all nodes marked as such. Doing it via JS instead of

var collapsed = document.getElementsByClassName("collapsed");

for(var i = collapsed.length - 1; i >= 0; --i)

collapsed[i].className = 'm-doc-expansible';

</script>

</div>

</div>

</div>

<div class="m-doc-search" id="search">

<a href="#!" onclick="return hideSearch()"></a>

<div class="m-container">

<div class="m-row">

<div class="m-col-m-8 m-push-m-2">

<div class="m-doc-search-header m-text m-small">

<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>

<div id="search-symbolcount">&hellip;</div>

</div>

<div class="m-doc-search-content">

<form>

<input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />

</form>

<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>

<div id="search-help" class="m-text m-dim m-text-center">

<p class="m-noindent">Search for symbols, directories, files, pages or

modules. You can omit any prefix from the symbol or file path; adding a

<code>:</code> or <code>/</code> suffix lists all members of given symbol or

directory.</p>

<p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>

/ <span class="m-label m-dim">&uarr;</span> to navigate through the list,

<span class="m-label m-dim">Enter</span> to go.

<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can

copy a link to the result using <span class="m-label m-dim">⌘</span>

<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>

<span class="m-label m-dim">M</span> produces a Markdown link.</p>

</div>

<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>

<ul id="search-results"></ul>

</div>

</div>

</div>

</div>

<script src="search-v1.js"></script>

<script src="searchdata-v1.js" async="async"></script>

<div class="m-container">

<div class="m-row">

<div class="m-col-l-10 m-push-l-1">

<p>Taskflow handbook is part of the <a href="https://taskflow.github.io">Taskflow project</a>, copyright © <a href="https://tsung-wei-huang.github.io/">Dr. Tsung-Wei Huang</a>, 2018&ndash;2021.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.8.14 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>

</div>

</div>

</div>