172 lines
9.3 KiB
HTML
172 lines
9.3 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title>taskflow/taskflow.hpp file | 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="dir_88dad41ea55ca2177e141d32a93e931c.html">taskflow</a>/</span>taskflow.hpp <span class="m-thin">file</span>
|
|
</h1>
|
|
<p>main taskflow include file</p>
|
|
<nav class="m-block m-default">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li>
|
|
Reference
|
|
<ul>
|
|
<li><a href="#namespaces">Namespaces</a></li>
|
|
<li><a href="#define-members">Defines</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<section id="namespaces">
|
|
<h2><a href="#namespaces">Namespaces</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>namespace <a href="namespacetf.html" class="m-doc">tf</a></dt>
|
|
<dd>taskflow namespace</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="define-members">
|
|
<h2><a href="#define-members">Defines</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a603f6f29f0f179ee85ecde7d5311a76e" class="m-doc">TF_DEFAULT_BOUNDED_TASK_QUEUE_LOG_SIZE</a></span>
|
|
</dt>
|
|
<dd></dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a45e25b85f72dd5c43f2c9010205c3e37" class="m-doc">TF_DEFAULT_UNBOUNDED_TASK_QUEUE_LOG_SIZE</a></span>
|
|
</dt>
|
|
<dd></dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a4df13cef00c37d2c56239c6e3b58e03f" class="m-doc">TF_VERSION</a></span>
|
|
</dt>
|
|
<dd>version of the Taskflow (currently 3.8.0)</dd>
|
|
<dt id="ac543189162351f11cc56cbc81e609e21">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#ac543189162351f11cc56cbc81e609e21" class="m-doc-self">TF_MAJOR_VERSION</a></span>
|
|
</dt>
|
|
<dd>major version of Taskflow, which is equal to <code>TF_VERSION/100000</code></dd>
|
|
<dt id="ac79e1d6e02bafb712ca6b8580fc35d0d">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#ac79e1d6e02bafb712ca6b8580fc35d0d" class="m-doc-self">TF_MINOR_VERSION</a></span>
|
|
</dt>
|
|
<dd>minor version of Taskflow, which is equal to <code>TF_VERSION / 100 % 1000</code></dd>
|
|
<dt id="af5d0ce402f403151eb848aceacfe28ec">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#af5d0ce402f403151eb848aceacfe28ec" class="m-doc-self">TF_PATCH_VERSION</a></span>
|
|
</dt>
|
|
<dd>patch version of Taskflow, which is equal to <code>TF_VERSION % 100</code></dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
<h2>Define documentation</h2>
|
|
<section class="m-doc-details" id="a603f6f29f0f179ee85ecde7d5311a76e"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a603f6f29f0f179ee85ecde7d5311a76e" class="m-doc-self">TF_DEFAULT_BOUNDED_TASK_QUEUE_LOG_SIZE</a></span>
|
|
</h3>
|
|
<p>This macro defines the default size of the bounded task queue in Log2. Bounded task queue is used by each worker.</p>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a45e25b85f72dd5c43f2c9010205c3e37"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a45e25b85f72dd5c43f2c9010205c3e37" class="m-doc-self">TF_DEFAULT_UNBOUNDED_TASK_QUEUE_LOG_SIZE</a></span>
|
|
</h3>
|
|
<p>This macro defines the default size of the unbounded task queue in Log2. Unbounded task queue is used by the executor.</p>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a4df13cef00c37d2c56239c6e3b58e03f"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a4df13cef00c37d2c56239c6e3b58e03f" class="m-doc-self">TF_VERSION</a></span>
|
|
</h3>
|
|
<p>version of the Taskflow (currently 3.8.0)</p>
|
|
<p>The version system is made of a major version number, a minor version number, and a patch number:</p><ul><li>TF_VERSION % 100 is the patch level</li><li>TF_VERSION / 100 % 1000 is the minor version</li><li>TF_VERSION / 100000 is the major version</li></ul>
|
|
</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">…</div>
|
|
</div>
|
|
<div class="m-doc-search-content">
|
|
<form>
|
|
<input type="search" name="q" id="search-input" placeholder="Loading …" 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">↓</span>
|
|
/ <span class="m-label m-dim">↑</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–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>
|