florian/mesytec-mnode
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
mesytec-mnode/external/taskflow-3.8.0/docs/classtf_1_1cudaTask.html
Florian Lüke e426fb7628 add taskflow-3.8.0
2025-01-04 01:25:05 +01:00

322 lines
18 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>tf::cudaTask class | 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" />
</head>
<body>
<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">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>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
<span class="m-breadcrumb"><a href="namespacetf.html">tf</a>::<wbr/></span>cudaTask <span class="m-thin">class</span>
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="cuda__task_8hpp.html">&lt;taskflow/cuda/cuda_task.hpp&gt;</a></div>
</h1>
<p>class to create a task handle over an internal node of a cudaFlow graph</p>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
<li><a href="#pub-methods">Public functions</a></li>
<li><a href="#friends">Friends</a></li>
</ul>
</li>
</ul>
</nav>
<section id="typeless-methods">
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
<dl class="m-doc">
<dt id="a68942b759c0420da99b639a8de3cc3d1">
<span class="m-doc-wrap-bumper"><a href="#a68942b759c0420da99b639a8de3cc3d1" class="m-doc-self">cudaTask</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-info">defaulted</span></span>
</dt>
<dd>constructs an empty <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a></dd>
<dt id="a367cf46c1ea828de4502a2ddc805c094">
<span class="m-doc-wrap-bumper"><a href="#a367cf46c1ea828de4502a2ddc805c094" class="m-doc-self">cudaTask</a>(</span><span class="m-doc-wrap">const <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a>&amp;) <span class="m-label m-flat m-info">defaulted</span></span>
</dt>
<dd>copy-constructs a <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a></dd>
</dl>
</section>
<section id="pub-methods">
<h2><a href="#pub-methods">Public functions</a></h2>
<dl class="m-doc">
<dt id="af17c570ca9a43ad71c4b626635ea9cbb">
<span class="m-doc-wrap-bumper">auto <a href="#af17c570ca9a43ad71c4b626635ea9cbb" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap">const <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a>&amp;) -&gt; <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a>&amp; <span class="m-label m-flat m-info">defaulted</span></span>
</dt>
<dd>copy-assigns a <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a></dd>
<dt>
<div class="m-doc-template">template&lt;typename... Ts&gt;</div>
<span class="m-doc-wrap-bumper">auto <a href="#abdd68287ec4dff4216af34d1db44d1b4" class="m-doc">precede</a>(</span><span class="m-doc-wrap">Ts &amp;&amp; ... tasks) -&gt; <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a>&amp;</span>
</dt>
<dd>adds precedence links from this to other tasks</dd>
<dt>
<div class="m-doc-template">template&lt;typename... Ts&gt;</div>
<span class="m-doc-wrap-bumper">auto <a href="#a4a9ca1a34bac47e4c9b04eb4fb2f7775" class="m-doc">succeed</a>(</span><span class="m-doc-wrap">Ts &amp;&amp; ... tasks) -&gt; <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a>&amp;</span>
</dt>
<dd>adds precedence links from other tasks to this</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#ab81b4f71a44af8d61758524f0c274962" class="m-doc">name</a>(</span><span class="m-doc-wrap">const <a href="http://en.cppreference.com/w/cpp/string/basic_string.html" class="m-doc-external">std::<wbr />string</a>&amp; name) -&gt; <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a>&amp;</span>
</dt>
<dd>assigns a name to the task</dd>
<dt id="aa80fb7a06b2828bd95c43fb465e10abe">
<span class="m-doc-wrap-bumper">auto <a href="#aa80fb7a06b2828bd95c43fb465e10abe" class="m-doc-self">name</a>(</span><span class="m-doc-wrap">) const -&gt; const <a href="http://en.cppreference.com/w/cpp/string/basic_string.html" class="m-doc-external">std::<wbr />string</a>&amp;</span>
</dt>
<dd>queries the name of the task</dd>
<dt id="a581673ad83a48a2d3b4f06f125043c32">
<span class="m-doc-wrap-bumper">auto <a href="#a581673ad83a48a2d3b4f06f125043c32" class="m-doc-self">num_successors</a>(</span><span class="m-doc-wrap">) const -&gt; size_t</span>
</dt>
<dd>queries the number of successors</dd>
<dt id="afe21933815619b8f51f0efa2706aa16e">
<span class="m-doc-wrap-bumper">auto <a href="#afe21933815619b8f51f0efa2706aa16e" class="m-doc-self">num_dependents</a>(</span><span class="m-doc-wrap">) const -&gt; size_t</span>
</dt>
<dd>queries the number of dependents</dd>
<dt id="a1b0da9e643b80008063406fe1bf207b9">
<span class="m-doc-wrap-bumper">auto <a href="#a1b0da9e643b80008063406fe1bf207b9" class="m-doc-self">empty</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
</dt>
<dd>queries if the task is associated with a cudaFlowNode</dd>
<dt id="a7eab02ec6633a5cf17cc15898db2d648">
<span class="m-doc-wrap-bumper">auto <a href="#a7eab02ec6633a5cf17cc15898db2d648" class="m-doc-self">type</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="namespacetf.html#afebc56ae6d5765010d0dd13a5f04132e" class="m-doc">cudaTaskType</a></span>
</dt>
<dd>queries the task type</dd>
<dt>
<div class="m-doc-template">template&lt;typename T&gt;</div>
<span class="m-doc-wrap-bumper">void <a href="#af2ce580b0bfb771e463e66af64c2c571" class="m-doc">dump</a>(</span><span class="m-doc-wrap">T&amp; ostream) const</span>
</dt>
<dd>dumps the task through an output stream</dd>
<dt id="aebdbc276e0b3b72b5c9e574e801e76dc">
<div class="m-doc-template">template&lt;typename V&gt;</div>
<span class="m-doc-wrap-bumper">void <a href="#aebdbc276e0b3b72b5c9e574e801e76dc" class="m-doc-self">for_each_successor</a>(</span><span class="m-doc-wrap">V&amp;&amp; visitor) const</span>
</dt>
<dd>applies an visitor callable to each successor of the task</dd>
<dt id="afd23fdf190317e790e7fc35049b53fcf">
<div class="m-doc-template">template&lt;typename V&gt;</div>
<span class="m-doc-wrap-bumper">void <a href="#afd23fdf190317e790e7fc35049b53fcf" class="m-doc-self">for_each_dependent</a>(</span><span class="m-doc-wrap">V&amp;&amp; visitor) const</span>
</dt>
<dd>applies an visitor callable to each dependents of the task</dd>
</dl>
</section>
<section id="friends">
<h2><a href="#friends">Friends</a></h2>
<dl class="m-doc">
<dt id="aa48fa98a827ff71f8c3845a29f5e4d10">
<span class="m-doc-wrap-bumper">auto <a href="#aa48fa98a827ff71f8c3845a29f5e4d10" class="m-doc-self">operator&lt;&lt;</a>(</span><span class="m-doc-wrap"><a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" class="m-doc-external">std::<wbr />ostream</a>&amp;,
const <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a>&amp;) -&gt; <a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" class="m-doc-external">std::<wbr />ostream</a>&amp;</span>
</dt>
<dd>overload of ostream inserter operator for <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a></dd>
</dl>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="abdd68287ec4dff4216af34d1db44d1b4"><div>
<h3>
<div class="m-doc-template">
template&lt;typename... Ts&gt;
</div>
<span class="m-doc-wrap-bumper"><a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a>&amp; tf::<wbr />cudaTask::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#abdd68287ec4dff4216af34d1db44d1b4" class="m-doc-self">precede</a>(</span><span class="m-doc-wrap">Ts &amp;&amp; ... tasks)</span></span>
</h3>
<p>adds precedence links from this to other tasks</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">Ts</td>
<td>parameter pack</td>
</tr>
</tbody>
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td>tasks</td>
<td>one or multiple tasks</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><code>*this</code></td>
</tr>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="a4a9ca1a34bac47e4c9b04eb4fb2f7775"><div>
<h3>
<div class="m-doc-template">
template&lt;typename... Ts&gt;
</div>
<span class="m-doc-wrap-bumper"><a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a>&amp; tf::<wbr />cudaTask::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a4a9ca1a34bac47e4c9b04eb4fb2f7775" class="m-doc-self">succeed</a>(</span><span class="m-doc-wrap">Ts &amp;&amp; ... tasks)</span></span>
</h3>
<p>adds precedence links from other tasks to this</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">Ts</td>
<td>parameter pack</td>
</tr>
</tbody>
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td>tasks</td>
<td>one or multiple tasks</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><code>*this</code></td>
</tr>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="ab81b4f71a44af8d61758524f0c274962"><div>
<h3>
<span class="m-doc-wrap-bumper"><a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a>&amp; tf::<wbr />cudaTask::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab81b4f71a44af8d61758524f0c274962" class="m-doc-self">name</a>(</span><span class="m-doc-wrap">const <a href="http://en.cppreference.com/w/cpp/string/basic_string.html" class="m-doc-external">std::<wbr />string</a>&amp; name)</span></span>
</h3>
<p>assigns a name to the task</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">name</td>
<td>a <a href="https://en.cppreference.com/w/cpp/string/basic_string">std::<wbr />string</a> acceptable string</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><code>*this</code></td>
</tr>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="af2ce580b0bfb771e463e66af64c2c571"><div>
<h3>
<div class="m-doc-template">
template&lt;typename T&gt;
</div>
<span class="m-doc-wrap-bumper">void tf::<wbr />cudaTask::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af2ce580b0bfb771e463e66af64c2c571" class="m-doc-self">dump</a>(</span><span class="m-doc-wrap">T&amp; ostream) const</span></span>
</h3>
<p>dumps the task through an output stream</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">T</td>
<td>output stream type with insertion operator (&lt;&lt;) defined</td>
</tr>
</tbody>
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td>ostream</td>
<td>an output stream target</td>
</tr>
</tbody>
</table>
</div></section>
</section>
</div>
</div>
</div>
</article></main>
<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>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
<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;2024.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.9.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
</div>
</div>
</div>
</nav></footer>
</body>
</html>
Reference in a new issue View git blame Copy permalink