docs/install.html · ly-code/taskflow

Fetch the repository succeeded.

richgiteeai

Watch

Unwatch Watching Releases Only Ignoring

1 Star 0 Fork 0

ly-code/taskflow

Code Issues 0 Pull Requests 0 Wiki Insights Pipelines

Service

Tencent Cloud Serverless

Create your Gitee Account

Explore and code with more than 14 million developers,Free private repositories !:)

Already have an account? Sign in

文件

master

Branches (3)

Tags (16)

Manage

master

dev

dev-defer

v3.6.0

v3.5.0

v3.4.0

v3.3.0

v3.2.0

v3.1.0

v3.0.0

v2.7.0

v2.6.0

v2.5.0

v2.4.0

v2.3.1

v2.3.0

v2.2.0

v2.1.0

v2.0.0

Clone or Download

Clone/Download

HTTPS SSH SVN SVN+SSH Download ZIP

Prompt

To download the code, please copy the following command and execute it in the terminal

To ensure that your submitted code identity is correctly recognized by Gitee, please execute the following command.

git config --global user.name userName 
git config --global user.email userEmail

When using the SSH protocol for the first time to clone or push code, follow the prompts below to complete the SSH configuration.

1 Generate RSA keys.

2 Obtain the content of the RSA public key and configure it in SSH Public Keys

To use SVN on Gitee, please visit the usage guide

When using the HTTPS protocol, the command line will prompt for account and password verification as follows. For security reasons, Gitee recommends configure and use personal access tokens instead of login passwords for cloning, pushing, and other operations.

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # Private Token

Branches 3

Tags 16

taskflow

docs

install.html

install.html 15.40 KB

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8" />
 <title>Building and Installing | 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>
 Building and Installing
 </h1>
 <nav class="m-block m-default">
 <h3>Contents</h3>
 <ul>
 <li><a href="#BAISupportedCompilers">Supported Compilers</a></li>
 <li><a href="#BAIIntegrateTaskflowToYourProject">Integrate Taskflow to Your Project</a></li>
 <li><a href="#BAIBuildExamplesAndUnitTests">Build Examples and Unit Tests</a></li>
 <li><a href="#BAIBuildCUDACode">Build CUDA Examples and Unit Tests</a></li>
 <li><a href="#BAIBuildSanitizers">Build Sanitizers</a></li>
 <li><a href="#BAIBuildBenchmarks">Build Benchmarks</a></li>
 <li><a href="#BAIBuildDocumentation">Build Documentation</a></li>
 </ul>
 </nav>
<p>This page describes how to set up Taskflow in your project. We will also go through the building process of unit tests and examples.</p><section id="BAISupportedCompilers"><h2><a href="#BAISupportedCompilers">Supported Compilers</a></h2><p>To use Taskflow, you only need a compiler that supports C++17:</p><ul><li>GNU C++ Compiler at least v8.4 with -std=c++17</li><li>Clang C++ Compiler at least v6.0 with -std=c++17</li><li>Microsoft Visual Studio at least v15.7 (MSVC++ 19.14)</li><li>AppleClang Xcode Version at least v12.0 with -std=c++17</li><li>Nvidia CUDA Toolkit and Compiler (nvcc) at least v11.1 with -std=c++17</li><li>Intel C++ Compiler (nvcc) at least v19.0.1 with -std=c++17</li><li>Intel DPC++ Clang Compiler at least v13.0.0 with -std=c++17 and SYCL20</li></ul><p>Taskflow works on Linux, Windows, and Mac OS X.</p></section><section id="BAIIntegrateTaskflowToYourProject"><h2><a href="#BAIIntegrateTaskflowToYourProject">Integrate Taskflow to Your Project</a></h2><p>Taskflow is <em>header-only</em> and there is no need for installation. Simply download the source and copy the headers under the directory <code>taskflow/</code> to your project.</p><pre class="m-console"><span class="go">~$ git clone https://github.com/taskflow/taskflow.git</span>
<span class="go">~$ cd taskflow/</span>
<span class="go">~$ cp -r taskflow myproject/include/</span></pre><p>Taskflow is written in C++17 and is built on top of C++ standardized threading libraries to improve portability. To compile a Taskflow program, say <code>simple.cpp</code>, you need to tell the compiler where to find the Taskflow header files and link it through the system thread library (usually <a href="http://man7.org/linux/man-pages/man7/pthreads.7.html">POSIX threads</a> in Linux-like systems). Take gcc for an example:</p><pre class="m-console"><span class="go">~$ g++ simple.cpp -std=c++17 -I myproject/include/ -O2 -pthread -o simple</span></pre></section><section id="BAIBuildExamplesAndUnitTests"><h2><a href="#BAIBuildExamplesAndUnitTests">Build Examples and Unit Tests</a></h2><p>Taskflow uses CMake to build examples and unit tests. We recommend using out-of-source build.</p><pre class="m-console"><span class="go">~$ cd path/to/taskflow</span>
<span class="go">~$ mkdir build</span>
<span class="go">~$ cd build</span>
<span class="go">~$ cmake ../</span>
<span class="go">~$ make # compile all examples and unittests</span>
<span class="go">~$ make test</span>

<span class="go">Running tests...</span>
<span class="go">/usr/bin/ctest --force-new-ctest-process</span>
<span class="go">Test project /home/tsung-wei/Code/taskflow/build</span>
<span class="go"> Start 1: passive_vector</span>
<span class="go"> 1/254 Test #1: passive_vector ................... Passed 0.04 sec</span>
<span class="go"> Start 2: function_traits</span>
<span class="go"> 2/254 Test #2: function_traits .................. Passed 0.00 sec</span>
<span class="go"> Start 3: object_pool.sequential</span>
<span class="go"> 3/254 Test #3: object_pool.sequential ........... Passed 0.10 sec</span>
<span class="go">...</span>

<span class="go">100% tests passed, 0 tests failed out of 254</span>

<span class="go">Total Test time (real) = 29.67 sec</span></pre><p>When the building completes, you can find the executables for examples and tests under the two folders, <code>examples/</code> and <code>unittests/</code>. You can list a set of available options in the cmake.</p><pre class="m-console"><span class="go">~$ cmake -LA</span>
<span class="go">...</span>
<span class="gp">TF_BUILD_EXAMPLES:BOOL=ON # </span>by default, we compile examples
<span class="gp">TF_BUILD_TESTS:BOOL=ON # </span>by default, we compile tests
<span class="gp">TF_BUILD_BENCHMARKS:BOOL=OFF # </span>by default, we don<span class="s1">&#39;t compile benchmarks </span>
<span class="gp">TF_BUILD_CUDA:BOOL=OFF # </span><span class="s1">by default, we don&#39;</span>t compile CUDA code
<span class="go">...</span>
<span class="go">... more options</span></pre><p>Currently, our CMake script supports the following options:</p><table class="m-table"><thead><tr><th>CMake Option</th><th>Default</th><th>Usage</th></tr></thead><tbody><tr><td>TF_BUILD_EXAMPLES</td><td>ON</td><td>enable/disable building examples</td></tr><tr><td>TF_BUILD_TESTS</td><td>ON</td><td>enable/disable building unit tests</td></tr><tr><td>TF_BUILD_BENCHMARKS</td><td>OFF</td><td>enable/disable building benchmarks</td></tr><tr><td>TF_BUILD_CUDA</td><td>OFF</td><td>enable/disable building CUDA code</td></tr></tbody></table><p>To enable or disable a specific option, use <code>-D</code> in the CMake build. For example:</p><pre class="m-console"><span class="go">~$ cmake ../ -DTF_BUILD_EXAMPLES=OFF</span></pre><p>The above command turns off building Taskflow examples.</p></section><section id="BAIBuildCUDACode"><h2><a href="#BAIBuildCUDACode">Build CUDA Examples and Unit Tests</a></h2><p>To build CUDA code, including unit tests and examples, enable the CMake option <code>TF_BUILD_CUDA</code> to <code>ON</code>. Cmake will automatically detect the existence of <code>nvcc</code> and use it to compile and link .cu code.</p><pre class="m-console"><span class="go">~$ cmake ../ -DTF_BUILD_CUDA=ON</span>
<span class="go">~$ make</span></pre><p>Please visit the page <a href="CompileTaskflowWithCUDA.html" class="m-doc">Compile Taskflow with CUDA</a> for details.</p></section><section id="BAIBuildSanitizers"><h2><a href="#BAIBuildSanitizers">Build Sanitizers</a></h2><p>You can build Taskflow with <em>sanitizers</em> to detect a variety of errors, such as data race, memory leak, undefined behavior, and others. To enable a sanitizer, add the sanitizer flag to the CMake variable <code>CMAKE_CXX_FLAGS</code>. The following example enables thread sanitizer in building Taskflow code to detect data race:</p><pre class="m-console"><span class="gp"># </span>build Taskflow code with thread sanitizer to detect data race
<span class="go">~$ cmake ../ -DCMAKE_CXX_FLAGS=&quot;-fsanitize=thread -g&quot;</span>

<span class="gp"># </span>build Taskflow code with address sanitizer to detect illegal memory access
<span class="go">~$ cmake ../ -DCMAKE_CXX_FLAGS=&quot;-fsanitize=address -g&quot;</span>

<span class="gp"># </span>build Taskflow code with ub sanitizer to detect undefined behavior
<span class="go">~$ cmake ../ -DCMAKE_CXX_FLAGS=&quot;-fsanitize=undefined -g&quot;</span></pre><p>Our <a href="https://github.com/taskflow/taskflow/actions">continuous integration workflows</a> incorporates thread sanitizer (<a href="https://clang.llvm.org/docs/ThreadSanitizer.html">-fsanitize=thread</a>), address sanitizer (<a href="https://clang.llvm.org/docs/AddressSanitizer.html">-fsanitize=address</a>), and leak sanitizer (<a href="https://clang.llvm.org/docs/LeakSanitizer.html">-fsanitize=leak</a>) to detect data race, illegal memory address, and memory leak. To our best knowledge, Taskflow is one of the very few parallel programming libraries that are free from data race.</p><aside class="m-note m-info"><h4>Note</h4><p>Some sanitizers are supported by certain computing architectures. You can find the information about architecture support of each sanitizer at <a href="https://clang.llvm.org/docs/index.html">Clang Documentation</a> and <a href="https://gcc.gnu.org/onlinedocs/gcc/Instrumentation-Options.html">GCC Instrumentation Options</a>.</p></aside></section><section id="BAIBuildBenchmarks"><h2><a href="#BAIBuildBenchmarks">Build Benchmarks</a></h2><p>The Taskflow project contains a set of benchmarks to evaluate and compare the performance of <a href="classtf_1_1Taskflow.html" class="m-doc">Taskflow</a> with existing parallel programming libraries. To build the benchmark code, enable the CMake option <code>TF_BUILD_BENCHMARKS</code> to <code>ON</code> as follows:</p><pre class="m-console"><span class="go">~$ cmake ../ -DTF_BUILD_BENCHMARKS=ON</span>
<span class="go">~$ make</span></pre><p>Please visit the page <a href="BenchmarkTaskflow.html" class="m-doc">Benchmark Taskflow</a> for details.</p></section><section id="BAIBuildDocumentation"><h2><a href="#BAIBuildDocumentation">Build Documentation</a></h2><p>Taskflow uses <a href="https://www.doxygen.nl/index.html">Doxygen</a> and <a href="https://mcss.mosra.cz/documentation/doxygen/">m.css</a> to generate this documentation. The source of documentation is located in the folder <code>taskflow/doxygen</code> and the generated html is output to the folder <code>taskflow/docs</code>. To generate the documentation, clone the m.css project and enter the <code>m.css/documentation</code> directory:</p><pre class="m-console"><span class="go">~$ git clone git://github.com/mosra/m.css</span>
<span class="go">~$ cd m.css/documentation</span></pre><p>The script <code>doxygen.py</code> requires Python 3.6, depends on <a href="http://jinja.pocoo.org/">Jinja2</a> for templating and <a href="http://pygments.org/">Pygments</a> for code block highlighting. You can install the dependencies via <code>pip</code> or your distribution package manager:</p><pre class="m-console"><span class="gp"># </span>You may need sudo here
<span class="gp"># </span>More details are available at https://mcss.mosra.cz/documentation/doxygen/
<span class="go">~$ pip3 install jinja2 Pygments</span></pre><p>Next, invoke <code>doxygen.py</code> and point it to the <code>taskflow/doxygen/conf.py</code>:</p><pre class="m-console"><span class="go">~$ ./doxygen.py path/to/taskflow/doxygen/conf.py</span></pre><p>You can find the documentation output in <code>taskflow/docs</code>.</p></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;2023.<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>
</nav></footer>
</body>
</html>

Copy Edit Raw Blame History

twhuang authored 2023年05月10日 03:18 +08:00 . fixed old async behavior in documentation

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8" />
 <title>Building and Installing | 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>
 Building and Installing
 </h1>
 <nav class="m-block m-default">
 <h3>Contents</h3>
 <ul>
 <li><a href="#BAISupportedCompilers">Supported Compilers</a></li>
 <li><a href="#BAIIntegrateTaskflowToYourProject">Integrate Taskflow to Your Project</a></li>
 <li><a href="#BAIBuildExamplesAndUnitTests">Build Examples and Unit Tests</a></li>
 <li><a href="#BAIBuildCUDACode">Build CUDA Examples and Unit Tests</a></li>
 <li><a href="#BAIBuildSanitizers">Build Sanitizers</a></li>
 <li><a href="#BAIBuildBenchmarks">Build Benchmarks</a></li>
 <li><a href="#BAIBuildDocumentation">Build Documentation</a></li>
 </ul>
 </nav>
<p>This page describes how to set up Taskflow in your project. We will also go through the building process of unit tests and examples.</p><section id="BAISupportedCompilers"><h2><a href="#BAISupportedCompilers">Supported Compilers</a></h2><p>To use Taskflow, you only need a compiler that supports C++17:</p><ul><li>GNU C++ Compiler at least v8.4 with -std=c++17</li><li>Clang C++ Compiler at least v6.0 with -std=c++17</li><li>Microsoft Visual Studio at least v15.7 (MSVC++ 19.14)</li><li>AppleClang Xcode Version at least v12.0 with -std=c++17</li><li>Nvidia CUDA Toolkit and Compiler (nvcc) at least v11.1 with -std=c++17</li><li>Intel C++ Compiler (nvcc) at least v19.0.1 with -std=c++17</li><li>Intel DPC++ Clang Compiler at least v13.0.0 with -std=c++17 and SYCL20</li></ul><p>Taskflow works on Linux, Windows, and Mac OS X.</p></section><section id="BAIIntegrateTaskflowToYourProject"><h2><a href="#BAIIntegrateTaskflowToYourProject">Integrate Taskflow to Your Project</a></h2><p>Taskflow is <em>header-only</em> and there is no need for installation. Simply download the source and copy the headers under the directory <code>taskflow/</code> to your project.</p><pre class="m-console"><span class="go">~$ git clone https://github.com/taskflow/taskflow.git</span>
<span class="go">~$ cd taskflow/</span>
<span class="go">~$ cp -r taskflow myproject/include/</span></pre><p>Taskflow is written in C++17 and is built on top of C++ standardized threading libraries to improve portability. To compile a Taskflow program, say <code>simple.cpp</code>, you need to tell the compiler where to find the Taskflow header files and link it through the system thread library (usually <a href="http://man7.org/linux/man-pages/man7/pthreads.7.html">POSIX threads</a> in Linux-like systems). Take gcc for an example:</p><pre class="m-console"><span class="go">~$ g++ simple.cpp -std=c++17 -I myproject/include/ -O2 -pthread -o simple</span></pre></section><section id="BAIBuildExamplesAndUnitTests"><h2><a href="#BAIBuildExamplesAndUnitTests">Build Examples and Unit Tests</a></h2><p>Taskflow uses CMake to build examples and unit tests. We recommend using out-of-source build.</p><pre class="m-console"><span class="go">~$ cd path/to/taskflow</span>
<span class="go">~$ mkdir build</span>
<span class="go">~$ cd build</span>
<span class="go">~$ cmake ../</span>
<span class="go">~$ make # compile all examples and unittests</span>
<span class="go">~$ make test</span>

<span class="go">Running tests...</span>
<span class="go">/usr/bin/ctest --force-new-ctest-process</span>
<span class="go">Test project /home/tsung-wei/Code/taskflow/build</span>
<span class="go"> Start 1: passive_vector</span>
<span class="go"> 1/254 Test #1: passive_vector ................... Passed 0.04 sec</span>
<span class="go"> Start 2: function_traits</span>
<span class="go"> 2/254 Test #2: function_traits .................. Passed 0.00 sec</span>
<span class="go"> Start 3: object_pool.sequential</span>
<span class="go"> 3/254 Test #3: object_pool.sequential ........... Passed 0.10 sec</span>
<span class="go">...</span>

<span class="go">100% tests passed, 0 tests failed out of 254</span>

<span class="go">Total Test time (real) = 29.67 sec</span></pre><p>When the building completes, you can find the executables for examples and tests under the two folders, <code>examples/</code> and <code>unittests/</code>. You can list a set of available options in the cmake.</p><pre class="m-console"><span class="go">~$ cmake -LA</span>
<span class="go">...</span>
<span class="gp">TF_BUILD_EXAMPLES:BOOL=ON # </span>by default, we compile examples
<span class="gp">TF_BUILD_TESTS:BOOL=ON # </span>by default, we compile tests
<span class="gp">TF_BUILD_BENCHMARKS:BOOL=OFF # </span>by default, we don<span class="s1">&#39;t compile benchmarks </span>
<span class="gp">TF_BUILD_CUDA:BOOL=OFF # </span><span class="s1">by default, we don&#39;</span>t compile CUDA code
<span class="go">...</span>
<span class="go">... more options</span></pre><p>Currently, our CMake script supports the following options:</p><table class="m-table"><thead><tr><th>CMake Option</th><th>Default</th><th>Usage</th></tr></thead><tbody><tr><td>TF_BUILD_EXAMPLES</td><td>ON</td><td>enable/disable building examples</td></tr><tr><td>TF_BUILD_TESTS</td><td>ON</td><td>enable/disable building unit tests</td></tr><tr><td>TF_BUILD_BENCHMARKS</td><td>OFF</td><td>enable/disable building benchmarks</td></tr><tr><td>TF_BUILD_CUDA</td><td>OFF</td><td>enable/disable building CUDA code</td></tr></tbody></table><p>To enable or disable a specific option, use <code>-D</code> in the CMake build. For example:</p><pre class="m-console"><span class="go">~$ cmake ../ -DTF_BUILD_EXAMPLES=OFF</span></pre><p>The above command turns off building Taskflow examples.</p></section><section id="BAIBuildCUDACode"><h2><a href="#BAIBuildCUDACode">Build CUDA Examples and Unit Tests</a></h2><p>To build CUDA code, including unit tests and examples, enable the CMake option <code>TF_BUILD_CUDA</code> to <code>ON</code>. Cmake will automatically detect the existence of <code>nvcc</code> and use it to compile and link .cu code.</p><pre class="m-console"><span class="go">~$ cmake ../ -DTF_BUILD_CUDA=ON</span>
<span class="go">~$ make</span></pre><p>Please visit the page <a href="CompileTaskflowWithCUDA.html" class="m-doc">Compile Taskflow with CUDA</a> for details.</p></section><section id="BAIBuildSanitizers"><h2><a href="#BAIBuildSanitizers">Build Sanitizers</a></h2><p>You can build Taskflow with <em>sanitizers</em> to detect a variety of errors, such as data race, memory leak, undefined behavior, and others. To enable a sanitizer, add the sanitizer flag to the CMake variable <code>CMAKE_CXX_FLAGS</code>. The following example enables thread sanitizer in building Taskflow code to detect data race:</p><pre class="m-console"><span class="gp"># </span>build Taskflow code with thread sanitizer to detect data race
<span class="go">~$ cmake ../ -DCMAKE_CXX_FLAGS=&quot;-fsanitize=thread -g&quot;</span>

<span class="gp"># </span>build Taskflow code with address sanitizer to detect illegal memory access
<span class="go">~$ cmake ../ -DCMAKE_CXX_FLAGS=&quot;-fsanitize=address -g&quot;</span>

<span class="gp"># </span>build Taskflow code with ub sanitizer to detect undefined behavior
<span class="go">~$ cmake ../ -DCMAKE_CXX_FLAGS=&quot;-fsanitize=undefined -g&quot;</span></pre><p>Our <a href="https://github.com/taskflow/taskflow/actions">continuous integration workflows</a> incorporates thread sanitizer (<a href="https://clang.llvm.org/docs/ThreadSanitizer.html">-fsanitize=thread</a>), address sanitizer (<a href="https://clang.llvm.org/docs/AddressSanitizer.html">-fsanitize=address</a>), and leak sanitizer (<a href="https://clang.llvm.org/docs/LeakSanitizer.html">-fsanitize=leak</a>) to detect data race, illegal memory address, and memory leak. To our best knowledge, Taskflow is one of the very few parallel programming libraries that are free from data race.</p><aside class="m-note m-info"><h4>Note</h4><p>Some sanitizers are supported by certain computing architectures. You can find the information about architecture support of each sanitizer at <a href="https://clang.llvm.org/docs/index.html">Clang Documentation</a> and <a href="https://gcc.gnu.org/onlinedocs/gcc/Instrumentation-Options.html">GCC Instrumentation Options</a>.</p></aside></section><section id="BAIBuildBenchmarks"><h2><a href="#BAIBuildBenchmarks">Build Benchmarks</a></h2><p>The Taskflow project contains a set of benchmarks to evaluate and compare the performance of <a href="classtf_1_1Taskflow.html" class="m-doc">Taskflow</a> with existing parallel programming libraries. To build the benchmark code, enable the CMake option <code>TF_BUILD_BENCHMARKS</code> to <code>ON</code> as follows:</p><pre class="m-console"><span class="go">~$ cmake ../ -DTF_BUILD_BENCHMARKS=ON</span>
<span class="go">~$ make</span></pre><p>Please visit the page <a href="BenchmarkTaskflow.html" class="m-doc">Benchmark Taskflow</a> for details.</p></section><section id="BAIBuildDocumentation"><h2><a href="#BAIBuildDocumentation">Build Documentation</a></h2><p>Taskflow uses <a href="https://www.doxygen.nl/index.html">Doxygen</a> and <a href="https://mcss.mosra.cz/documentation/doxygen/">m.css</a> to generate this documentation. The source of documentation is located in the folder <code>taskflow/doxygen</code> and the generated html is output to the folder <code>taskflow/docs</code>. To generate the documentation, clone the m.css project and enter the <code>m.css/documentation</code> directory:</p><pre class="m-console"><span class="go">~$ git clone git://github.com/mosra/m.css</span>
<span class="go">~$ cd m.css/documentation</span></pre><p>The script <code>doxygen.py</code> requires Python 3.6, depends on <a href="http://jinja.pocoo.org/">Jinja2</a> for templating and <a href="http://pygments.org/">Pygments</a> for code block highlighting. You can install the dependencies via <code>pip</code> or your distribution package manager:</p><pre class="m-console"><span class="gp"># </span>You may need sudo here
<span class="gp"># </span>More details are available at https://mcss.mosra.cz/documentation/doxygen/
<span class="go">~$ pip3 install jinja2 Pygments</span></pre><p>Next, invoke <code>doxygen.py</code> and point it to the <code>taskflow/doxygen/conf.py</code>:</p><pre class="m-console"><span class="go">~$ ./doxygen.py path/to/taskflow/doxygen/conf.py</span></pre><p>You can find the documentation output in <code>taskflow/docs</code>.</p></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;2023.<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>
</nav></footer>
</body>
</html>