Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 555a9bb

Browse files
heLomaNheLomaN
authored
fix spelling mistake 'Fugure' to 'Future' (taskflow#417)
1 parent 96620cc commit 555a9bb

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

‎docs/classtf_1_1Executor.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -852,7 +852,7 @@ <h3>
852852
</tr>
853853
</tfoot>
854854
</table>
855-
<p>The method creates an asynchronous task to launch the given function on the given arguments. Unlike std::async, the return here is a <em><a href="classtf_1_1Future.html" class="m-doc">tf::<wbr />Future</a></em> that holds an optional object to the result. If the asynchronous task is cancelled before it runs, the return is a <code>std::nullopt</code>, or the value returned by the callable.</p><pre class="m-code"><span class="n">tf</span><span class="o">::</span><span class="n">Fugure</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">optional</span><span class="o">&lt;</span><span class="kt">int</span><span class="o">&gt;&gt;</span><span class="w"> </span><span class="n">future</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">executor</span><span class="p">.</span><span class="n">async</span><span class="p">([](){</span><span class="w"></span>
855+
<p>The method creates an asynchronous task to launch the given function on the given arguments. Unlike std::async, the return here is a <em><a href="classtf_1_1Future.html" class="m-doc">tf::<wbr />Future</a></em> that holds an optional object to the result. If the asynchronous task is cancelled before it runs, the return is a <code>std::nullopt</code>, or the value returned by the callable.</p><pre class="m-code"><span class="n">tf</span><span class="o">::</span><span class="n">Future</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">optional</span><span class="o">&lt;</span><span class="kt">int</span><span class="o">&gt;&gt;</span><span class="w"> </span><span class="n">future</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">executor</span><span class="p">.</span><span class="n">async</span><span class="p">([](){</span><span class="w"></span>
856856
<span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">cout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;create an asynchronous task and returns 1</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">;</span><span class="w"></span>
857857
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span><span class="w"></span>
858858
<span class="p">});</span><span class="w"></span></pre><p>This member function is thread-safe.</p>
@@ -905,7 +905,7 @@ <h3>
905905
</tr>
906906
</tfoot>
907907
</table>
908-
<p>The method creates a named asynchronous task to launch the given function on the given arguments. Naming an asynchronous task is primarily used for profiling and visualizing the task execution timeline. Unlike std::async, the return here is a <a href="classtf_1_1Future.html" class="m-doc">tf::<wbr />Future</a> that holds an optional object to the result. If the asynchronous task is cancelled before it runs, the return is a <code>std::nullopt</code>, or the value returned by the callable.</p><pre class="m-code"><span class="n">tf</span><span class="o">::</span><span class="n">Fugure</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">optional</span><span class="o">&lt;</span><span class="kt">int</span><span class="o">&gt;&gt;</span><span class="w"> </span><span class="n">future</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">executor</span><span class="p">.</span><span class="n">named_async</span><span class="p">(</span><span class="s">&quot;name&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">[](){</span><span class="w"></span>
908+
<p>The method creates a named asynchronous task to launch the given function on the given arguments. Naming an asynchronous task is primarily used for profiling and visualizing the task execution timeline. Unlike std::async, the return here is a <a href="classtf_1_1Future.html" class="m-doc">tf::<wbr />Future</a> that holds an optional object to the result. If the asynchronous task is cancelled before it runs, the return is a <code>std::nullopt</code>, or the value returned by the callable.</p><pre class="m-code"><span class="n">tf</span><span class="o">::</span><span class="n">Future</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">optional</span><span class="o">&lt;</span><span class="kt">int</span><span class="o">&gt;&gt;</span><span class="w"> </span><span class="n">future</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">executor</span><span class="p">.</span><span class="n">named_async</span><span class="p">(</span><span class="s">&quot;name&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">[](){</span><span class="w"></span>
909909
<span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">cout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;create an asynchronous task with a name and returns 1</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">;</span><span class="w"></span>
910910
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span><span class="w"></span>
911911
<span class="p">});</span><span class="w"></span></pre><p>This member function is thread-safe.</p>

‎docs/xml/classtf_1_1Executor.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1115,7 +1115,7 @@ The method keeps running the caller worker in the work-stealing loop until the s
11151115
</parameteritem>
11161116
</parameterlist>
11171117
<simplesect kind="return"><para>a <ref refid="classtf_1_1Future" kindref="compound">tf::Future</ref> that will holds the result of the execution</para></simplesect>
1118-
The method creates an asynchronous task to launch the given function on the given arguments. Unlike std::async, the return here is a <emphasis><ref refid="classtf_1_1Future" kindref="compound">tf::Future</ref></emphasis> that holds an optional object to the result. If the asynchronous task is cancelled before it runs, the return is a <computeroutput>std::nullopt</computeroutput>, or the value returned by the callable.</para><para><programlisting filename=".cpp"><codeline><highlight class="normal">tf::Fugure&lt;std::optional&lt;int&gt;&gt;<sp/>future<sp/>=<sp/>executor.<ref refid="classtf_1_1Executor_1a1e6866c8f1b6a2e932f06d0b4eb032c0" kindref="member">async</ref>([](){</highlight></codeline>
1118+
The method creates an asynchronous task to launch the given function on the given arguments. Unlike std::async, the return here is a <emphasis><ref refid="classtf_1_1Future" kindref="compound">tf::Future</ref></emphasis> that holds an optional object to the result. If the asynchronous task is cancelled before it runs, the return is a <computeroutput>std::nullopt</computeroutput>, or the value returned by the callable.</para><para><programlisting filename=".cpp"><codeline><highlight class="normal">tf::Future&lt;std::optional&lt;int&gt;&gt;<sp/>future<sp/>=<sp/>executor.<ref refid="classtf_1_1Executor_1a1e6866c8f1b6a2e932f06d0b4eb032c0" kindref="member">async</ref>([](){</highlight></codeline>
11191119
<codeline><highlight class="normal"><sp/><sp/><ref refid="cpp/io/basic_ostream" kindref="compound" external="/home/twhuang/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::cout</ref><sp/>&lt;&lt;<sp/></highlight><highlight class="stringliteral">&quot;create<sp/>an<sp/>asynchronous<sp/>task<sp/>and<sp/>returns<sp/>1\n&quot;</highlight><highlight class="normal">;</highlight></codeline>
11201120
<codeline><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>1;</highlight></codeline>
11211121
<codeline><highlight class="normal">});</highlight></codeline>
@@ -1192,7 +1192,7 @@ The method creates an asynchronous task to launch the given function on the give
11921192
</parameteritem>
11931193
</parameterlist>
11941194
<simplesect kind="return"><para>a <ref refid="classtf_1_1Future" kindref="compound">tf::Future</ref> that will holds the result of the execution</para></simplesect>
1195-
The method creates a named asynchronous task to launch the given function on the given arguments. Naming an asynchronous task is primarily used for profiling and visualizing the task execution timeline. Unlike std::async, the return here is a <ref refid="classtf_1_1Future" kindref="compound">tf::Future</ref> that holds an optional object to the result. If the asynchronous task is cancelled before it runs, the return is a <computeroutput>std::nullopt</computeroutput>, or the value returned by the callable.</para><para><programlisting filename=".cpp"><codeline><highlight class="normal">tf::Fugure&lt;std::optional&lt;int&gt;&gt;<sp/>future<sp/>=<sp/>executor.<ref refid="classtf_1_1Executor_1a51acee1670e9f246c7ccd7f6a63f1524" kindref="member">named_async</ref>(</highlight><highlight class="stringliteral">&quot;name&quot;</highlight><highlight class="normal">,<sp/>[](){</highlight></codeline>
1195+
The method creates a named asynchronous task to launch the given function on the given arguments. Naming an asynchronous task is primarily used for profiling and visualizing the task execution timeline. Unlike std::async, the return here is a <ref refid="classtf_1_1Future" kindref="compound">tf::Future</ref> that holds an optional object to the result. If the asynchronous task is cancelled before it runs, the return is a <computeroutput>std::nullopt</computeroutput>, or the value returned by the callable.</para><para><programlisting filename=".cpp"><codeline><highlight class="normal">tf::Future&lt;std::optional&lt;int&gt;&gt;<sp/>future<sp/>=<sp/>executor.<ref refid="classtf_1_1Executor_1a51acee1670e9f246c7ccd7f6a63f1524" kindref="member">named_async</ref>(</highlight><highlight class="stringliteral">&quot;name&quot;</highlight><highlight class="normal">,<sp/>[](){</highlight></codeline>
11961196
<codeline><highlight class="normal"><sp/><sp/><ref refid="cpp/io/basic_ostream" kindref="compound" external="/home/twhuang/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::cout</ref><sp/>&lt;&lt;<sp/></highlight><highlight class="stringliteral">&quot;create<sp/>an<sp/>asynchronous<sp/>task<sp/>with<sp/>a<sp/>name<sp/>and<sp/>returns<sp/>1\n&quot;</highlight><highlight class="normal">;</highlight></codeline>
11971197
<codeline><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>1;</highlight></codeline>
11981198
<codeline><highlight class="normal">});</highlight></codeline>

‎taskflow/core/executor-module-opt.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ class Executor {
497497
a @c std::nullopt, or the value returned by the callable.
498498
499499
@code{.cpp}
500-
tf::Fugure<std::optional<int>> future = executor.async([](){
500+
tf::Future<std::optional<int>> future = executor.async([](){
501501
std::cout << "create an asynchronous task and returns 1\n";
502502
return 1;
503503
});
@@ -530,7 +530,7 @@ class Executor {
530530
a @c std::nullopt, or the value returned by the callable.
531531
532532
@code{.cpp}
533-
tf::Fugure<std::optional<int>> future = executor.named_async("name", [](){
533+
tf::Future<std::optional<int>> future = executor.named_async("name", [](){
534534
std::cout << "create an asynchronous task with a name and returns 1\n";
535535
return 1;
536536
});

‎taskflow/core/executor.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,7 @@ class Executor {
561561
a @c std::nullopt, or the value returned by the callable.
562562
563563
@code{.cpp}
564-
tf::Fugure<std::optional<int>> future = executor.async([](){
564+
tf::Future<std::optional<int>> future = executor.async([](){
565565
std::cout << "create an asynchronous task and returns 1\n";
566566
return 1;
567567
});
@@ -594,7 +594,7 @@ class Executor {
594594
a @c std::nullopt, or the value returned by the callable.
595595
596596
@code{.cpp}
597-
tf::Fugure<std::optional<int>> future = executor.named_async("name", [](){
597+
tf::Future<std::optional<int>> future = executor.named_async("name", [](){
598598
std::cout << "create an asynchronous task with a name and returns 1\n";
599599
return 1;
600600
});

0 commit comments

Comments
 (0)