536 lines
41 KiB
XML
536 lines
41 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.1" xml:lang="en-US">
|
|
<compounddef id="classtf_1_1Pipeline" kind="class" language="C++" prot="public">
|
|
<compoundname>tf::Pipeline</compoundname>
|
|
<includes refid="pipeline_8hpp" local="no">taskflow/algorithm/pipeline.hpp</includes>
|
|
<innerclass refid="structtf_1_1Pipeline_1_1Line" prot="private">tf::Pipeline::Line</innerclass>
|
|
<innerclass refid="structtf_1_1Pipeline_1_1PipeMeta" prot="private">tf::Pipeline::PipeMeta</innerclass>
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Ps</declname>
|
|
<defname>Ps</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<sectiondef kind="private-attrib">
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1a1e3ad41a55de7fdc1f2ad40ee49a4d4a" prot="private" static="no" mutable="no">
|
|
<type><ref refid="classtf_1_1Graph" kindref="compound">Graph</ref></type>
|
|
<definition>Graph tf::Pipeline< Ps >::_graph</definition>
|
|
<argsstring></argsstring>
|
|
<name>_graph</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="496" column="9" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="496" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1a9d9fe0c2e30331b1f7e40d2dc3c5a76f" prot="private" static="no" mutable="no">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::Pipeline< Ps >::_num_tokens</definition>
|
|
<argsstring></argsstring>
|
|
<name>_num_tokens</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="498" column="10" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="498" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1a442f95439871ed72fd67edab10fc77a0" prot="private" static="no" mutable="no">
|
|
<type><ref refid="cpp/utility/tuple" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::tuple</ref>< Ps... ></type>
|
|
<definition>std::tuple<Ps...> tf::Pipeline< Ps >::_pipes</definition>
|
|
<argsstring></argsstring>
|
|
<name>_pipes</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="500" column="14" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="500" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1a836ee5a9505f07fc032ea69563063378" prot="private" static="no" mutable="no">
|
|
<type><ref refid="cpp/container/array" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::array</ref>< PipeMeta, sizeof...(Ps)></type>
|
|
<definition>std::array<PipeMeta, sizeof...(Ps)> tf::Pipeline< Ps >::_meta</definition>
|
|
<argsstring></argsstring>
|
|
<name>_meta</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="501" column="14" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="501" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1a21eaa8e9904e9ebb9a1b1ea4a1e183de" prot="private" static="no" mutable="no">
|
|
<type><ref refid="cpp/container/vector" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::vector</ref>< <ref refid="cpp/container/array" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::array</ref>< Line, sizeof...(Ps)> ></type>
|
|
<definition>std::vector<std::array<Line, sizeof...(Ps)> > tf::Pipeline< Ps >::_lines</definition>
|
|
<argsstring></argsstring>
|
|
<name>_lines</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="502" column="15" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="502" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1aba0c750fa328b21fcda5cb44801d6289" prot="private" static="no" mutable="no">
|
|
<type><ref refid="cpp/container/vector" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::vector</ref>< <ref refid="classtf_1_1Task" kindref="compound">Task</ref> ></type>
|
|
<definition>std::vector<Task> tf::Pipeline< Ps >::_tasks</definition>
|
|
<argsstring></argsstring>
|
|
<name>_tasks</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="503" column="15" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="503" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1a8d0536148e5fdd373b4ed81965498749" prot="private" static="no" mutable="no">
|
|
<type><ref refid="cpp/container/vector" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::vector</ref>< <ref refid="classtf_1_1Pipeflow" kindref="compound">Pipeflow</ref> ></type>
|
|
<definition>std::vector<Pipeflow> tf::Pipeline< Ps >::_pipeflows</definition>
|
|
<argsstring></argsstring>
|
|
<name>_pipeflows</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="504" column="15" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="504" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1a10499ef31797d4db31243e6f73fb2ee8" prot="private" static="no" mutable="no">
|
|
<type><ref refid="cpp/container/queue" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::queue</ref>< <ref refid="cpp/utility/pair" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::pair</ref>< size_t, size_t > ></type>
|
|
<definition>std::queue<std::pair<size_t, size_t> > tf::Pipeline< Ps >::_ready_tokens</definition>
|
|
<argsstring></argsstring>
|
|
<name>_ready_tokens</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="512" column="14" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="512" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1ab19a3164e7584ce1d16ecbff975421a7" prot="private" static="no" mutable="no">
|
|
<type><ref refid="cpp/container/unordered_map" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::unordered_map</ref>< size_t, <ref refid="cpp/container/vector" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::vector</ref>< size_t > ></type>
|
|
<definition>std::unordered_map<size_t, std::vector<size_t> > tf::Pipeline< Ps >::_token_dependencies</definition>
|
|
<argsstring></argsstring>
|
|
<name>_token_dependencies</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="519" column="22" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="519" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1a7ff727cd8c130fc9b606c01dbfa12f9d" prot="private" static="no" mutable="no">
|
|
<type><ref refid="cpp/container/unordered_map" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::unordered_map</ref>< size_t, DeferredPipeflow ></type>
|
|
<definition>std::unordered_map<size_t, DeferredPipeflow> tf::Pipeline< Ps >::_deferred_tokens</definition>
|
|
<argsstring></argsstring>
|
|
<name>_deferred_tokens</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="527" column="22" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="527" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="classtf_1_1Pipeline_1aaee01340ac6e941a949931b7e478d83e" prot="private" static="no" mutable="no">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::Pipeline< Ps >::_longest_deferral</definition>
|
|
<argsstring></argsstring>
|
|
<name>_longest_deferral</name>
|
|
<initializer>= 0</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="536" column="10" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="536" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="public-func">
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1aad8735676e4f9fd8474ad1ac51b58f3e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type></type>
|
|
<definition>tf::Pipeline< Ps >::Pipeline</definition>
|
|
<argsstring>(size_t num_lines, Ps &&... ps)</argsstring>
|
|
<name>Pipeline</name>
|
|
<param>
|
|
<type>size_t</type>
|
|
<declname>num_lines</declname>
|
|
</param>
|
|
<param>
|
|
<type>Ps &&...</type>
|
|
<declname>ps</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>constructs a pipeline object </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><parameterlist kind="param"><parameteritem>
|
|
<parameternamelist>
|
|
<parametername>num_lines</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>the number of parallel lines </para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
<parameteritem>
|
|
<parameternamelist>
|
|
<parametername>ps</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>a list of pipes</para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
</parameterlist>
|
|
Constructs a pipeline of up to <computeroutput>num_lines</computeroutput> parallel lines to schedule tokens through the given linear chain of pipes. The first pipe must define a serial direction (<ref refid="namespacetf_1abb7a11e41fd457f69e7ff45d4c769564a7b804a28d6154ab8007287532037f1d0" kindref="member">tf::PipeType::SERIAL</ref>) or an exception will be thrown. </para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="435" column="3" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="550" bodyend="567"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1a879a54b37af5db33e5768e5b3c135ba6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type></type>
|
|
<definition>tf::Pipeline< Ps >::Pipeline</definition>
|
|
<argsstring>(size_t num_lines, std::tuple< Ps... > &&ps)</argsstring>
|
|
<name>Pipeline</name>
|
|
<param>
|
|
<type>size_t</type>
|
|
<declname>num_lines</declname>
|
|
</param>
|
|
<param>
|
|
<type><ref refid="cpp/utility/tuple" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::tuple</ref>< Ps... > &&</type>
|
|
<declname>ps</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>constructs a pipeline object </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><parameterlist kind="param"><parameteritem>
|
|
<parameternamelist>
|
|
<parametername>num_lines</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>the number of parallel lines </para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
<parameteritem>
|
|
<parameternamelist>
|
|
<parametername>ps</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>a tuple of pipes</para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
</parameterlist>
|
|
Constructs a pipeline of up to <computeroutput>num_lines</computeroutput> parallel lines to schedule tokens through the given linear chain of pipes. The first pipe must define a serial direction (<ref refid="namespacetf_1abb7a11e41fd457f69e7ff45d4c769564a7b804a28d6154ab8007287532037f1d0" kindref="member">tf::PipeType::SERIAL</ref>) or an exception will be thrown. </para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="448" column="3" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="571" bodyend="590"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1a79f066bacd6c1abd28c26d8196955e95" prot="public" static="no" const="yes" explicit="no" inline="no" noexcept="yes" virt="non-virtual">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::Pipeline< Ps >::num_lines</definition>
|
|
<argsstring>() const noexcept</argsstring>
|
|
<name>num_lines</name>
|
|
<briefdescription>
|
|
<para>queries the number of parallel lines </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>The function returns the number of parallel lines given by the user upon the construction of the pipeline. The number of lines represents the maximum parallelism this pipeline can achieve. </para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="458" column="10" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="601" bodyend="603"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1adfef0c60f8f8ace267d7cd8548457ff3" prot="public" static="no" constexpr="yes" const="yes" explicit="no" inline="no" noexcept="yes" virt="non-virtual">
|
|
<type>constexpr size_t</type>
|
|
<definition>constexpr size_t tf::Pipeline< Ps >::num_pipes</definition>
|
|
<argsstring>() const noexcept</argsstring>
|
|
<name>num_pipes</name>
|
|
<briefdescription>
|
|
<para>queries the number of pipes </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>The Function returns the number of pipes given by the user upon the construction of the pipeline. </para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="466" column="20" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="607" bodyend="609"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1a311d874b98de6f0def8a7d869e8d15bd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void tf::Pipeline< Ps >::reset</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>reset</name>
|
|
<briefdescription>
|
|
<para>resets the pipeline </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>Resetting the pipeline to the initial state. After resetting a pipeline, its token identifier will start from zero as if the pipeline was just constructed. </para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="475" column="8" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="625" bodyend="660"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1a89af6714b661ded59970cac4c73b3ef9" prot="public" static="no" const="yes" explicit="no" inline="no" noexcept="yes" virt="non-virtual">
|
|
<type>size_t</type>
|
|
<definition>size_t tf::Pipeline< Ps >::num_tokens</definition>
|
|
<argsstring>() const noexcept</argsstring>
|
|
<name>num_tokens</name>
|
|
<briefdescription>
|
|
<para>queries the number of generated tokens in the pipeline </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>The number represents the total scheduling tokens that has been generated by the pipeline so far. </para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="483" column="10" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="613" bodyend="615"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1a4320bdd8b8cf05c9aac1b9fa000e4a35" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type><ref refid="classtf_1_1Graph" kindref="compound">Graph</ref> &</type>
|
|
<definition>Graph & tf::Pipeline< Ps >::graph</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>graph</name>
|
|
<briefdescription>
|
|
<para>obtains the graph object associated with the pipeline construct </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>This method is primarily used as an opaque data structure for creating a module task of the this pipeline. </para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="491" column="9" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="619" bodyend="621"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="private-func">
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1a5c0604ba81fb2c8d0ba9c076df13ddda" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>size_t...</type>
|
|
<declname>I</declname>
|
|
<defname>I</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto tf::Pipeline< Ps >::_gen_meta</definition>
|
|
<argsstring>(std::tuple< Ps... > &&, std::index_sequence< I... >)</argsstring>
|
|
<name>_gen_meta</name>
|
|
<param>
|
|
<type><ref refid="cpp/utility/tuple" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::tuple</ref>< Ps... > &&</type>
|
|
<defname>ps</defname>
|
|
</param>
|
|
<param>
|
|
<type>std::index_sequence< I... ></type>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="539" column="8" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="595" bodyend="597"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1aa2e4a635ac4469754f2d922ea67151f9" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void tf::Pipeline< Ps >::_on_pipe</definition>
|
|
<argsstring>(Pipeflow &, Runtime &)</argsstring>
|
|
<name>_on_pipe</name>
|
|
<param>
|
|
<type><ref refid="classtf_1_1Pipeflow" kindref="compound">Pipeflow</ref> &</type>
|
|
<defname>pf</defname>
|
|
</param>
|
|
<param>
|
|
<type><ref refid="classtf_1_1Runtime" kindref="compound">Runtime</ref> &</type>
|
|
<defname>rt</defname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="541" column="8" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="664" bodyend="677"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1ad091bbd38c1538884aa83d488fdf40f2" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void tf::Pipeline< Ps >::_build</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>_build</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="542" column="8" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="798" bodyend="933"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1afb16e7472b979f81a8d997eae134e1c9" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void tf::Pipeline< Ps >::_check_dependents</definition>
|
|
<argsstring>(Pipeflow &)</argsstring>
|
|
<name>_check_dependents</name>
|
|
<param>
|
|
<type><ref refid="classtf_1_1Pipeflow" kindref="compound">Pipeflow</ref> &</type>
|
|
<defname>pf</defname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="543" column="8" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="686" bodyend="714"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1a2d90bf386da24e7913b021febbcb6809" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void tf::Pipeline< Ps >::_construct_deferred_tokens</definition>
|
|
<argsstring>(Pipeflow &)</argsstring>
|
|
<name>_construct_deferred_tokens</name>
|
|
<param>
|
|
<type><ref refid="classtf_1_1Pipeflow" kindref="compound">Pipeflow</ref> &</type>
|
|
<defname>pf</defname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="544" column="8" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="725" bodyend="742"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classtf_1_1Pipeline_1aa69993288e9ceefed489ff0c71ed1aca" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void tf::Pipeline< Ps >::_resolve_token_dependencies</definition>
|
|
<argsstring>(Pipeflow &)</argsstring>
|
|
<name>_resolve_token_dependencies</name>
|
|
<param>
|
|
<type><ref refid="classtf_1_1Pipeflow" kindref="compound">Pipeflow</ref> &</type>
|
|
<defname>pf</defname>
|
|
</param>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="545" column="8" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="756" bodyend="794"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
<para>class to create a pipeline scheduling framework </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><parameterlist kind="templateparam"><parameteritem>
|
|
<parameternamelist>
|
|
<parametername>Ps</parametername>
|
|
</parameternamelist>
|
|
<parameterdescription>
|
|
<para>pipe types</para>
|
|
</parameterdescription>
|
|
</parameteritem>
|
|
</parameterlist>
|
|
A pipeline is a composable graph object for users to create a <emphasis>pipeline scheduling framework</emphasis> using a module task in a taskflow. Unlike the conventional pipeline programming frameworks (e.g., Intel TBB), Taskflow's pipeline algorithm does not provide any data abstraction, which often restricts users from optimizing data layouts in their applications, but a flexible framework for users to customize their application data atop our pipeline scheduling. The following code creates a pipeline of four parallel lines to schedule tokens through three serial pipes:</para>
|
|
<para><programlisting filename=".cpp"><codeline><highlight class="normal"><ref refid="classtf_1_1Taskflow" kindref="compound">tf::Taskflow</ref><sp/>taskflow;</highlight></codeline>
|
|
<codeline><highlight class="normal"><ref refid="classtf_1_1Executor" kindref="compound">tf::Executor</ref><sp/>executor;</highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/><ref refid="classtf_1_1Pipeline_1a79f066bacd6c1abd28c26d8196955e95" kindref="member">num_lines</ref><sp/>=<sp/>4;</highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/><ref refid="classtf_1_1Pipeline_1adfef0c60f8f8ace267d7cd8548457ff3" kindref="member">num_pipes</ref><sp/>=<sp/>3;</highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight><highlight class="comment">//<sp/>create<sp/>a<sp/>custom<sp/>data<sp/>buffer</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"><ref refid="cpp/container/array" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::array<std::array<int, num_pipes></ref>,<sp/><ref refid="classtf_1_1Pipeline_1a79f066bacd6c1abd28c26d8196955e95" kindref="member">num_lines</ref>><sp/>buffer;</highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight><highlight class="comment">//<sp/>create<sp/>a<sp/>pipeline<sp/>graph<sp/>of<sp/>four<sp/>concurrent<sp/>lines<sp/>and<sp/>three<sp/>serial<sp/>pipes</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"><ref refid="classtf_1_1Pipeline" kindref="compound">tf::Pipeline</ref><sp/>pipeline(<ref refid="classtf_1_1Pipeline_1a79f066bacd6c1abd28c26d8196955e95" kindref="member">num_lines</ref>,</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/></highlight><highlight class="comment">//<sp/>first<sp/>pipe<sp/>must<sp/>define<sp/>a<sp/>serial<sp/>direction</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><ref refid="classtf_1_1Pipe" kindref="compound">tf::Pipe</ref>{<ref refid="namespacetf_1abb7a11e41fd457f69e7ff45d4c769564a7b804a28d6154ab8007287532037f1d0" kindref="member">tf::PipeType::SERIAL</ref>,<sp/>[&buffer](<ref refid="classtf_1_1Pipeflow" kindref="compound">tf::Pipeflow</ref>&<sp/>pf)<sp/>{</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>generate<sp/>only<sp/>5<sp/>scheduling<sp/>tokens</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal">(pf.token()<sp/>==<sp/>5)<sp/>{</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/>pf.stop();</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>save<sp/>the<sp/>token<sp/>id<sp/>into<sp/>the<sp/>buffer</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">else</highlight><highlight class="normal"><sp/>{</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/>buffer[pf.line()][pf.pipe()]<sp/>=<sp/>pf.token();</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/>}},</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><ref refid="classtf_1_1Pipe" kindref="compound">tf::Pipe</ref>{<ref refid="namespacetf_1abb7a11e41fd457f69e7ff45d4c769564a7b804a28d6154ab8007287532037f1d0" kindref="member">tf::PipeType::SERIAL</ref>,<sp/>[&buffer]<sp/>(<ref refid="classtf_1_1Pipeflow" kindref="compound">tf::Pipeflow</ref>&<sp/>pf)<sp/>{</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>propagate<sp/>the<sp/>previous<sp/>result<sp/>to<sp/>this<sp/>pipe<sp/>by<sp/>adding<sp/>one</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/>buffer[pf.line()][pf.pipe()]<sp/>=<sp/>buffer[pf.line()][pf.pipe()-1]<sp/>+<sp/>1;</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/>}},</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><ref refid="classtf_1_1Pipe" kindref="compound">tf::Pipe</ref>{<ref refid="namespacetf_1abb7a11e41fd457f69e7ff45d4c769564a7b804a28d6154ab8007287532037f1d0" kindref="member">tf::PipeType::SERIAL</ref>,<sp/>[&buffer](<ref refid="classtf_1_1Pipeflow" kindref="compound">tf::Pipeflow</ref>&<sp/>pf){</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>propagate<sp/>the<sp/>previous<sp/>result<sp/>to<sp/>this<sp/>pipe<sp/>by<sp/>adding<sp/>one</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/>buffer[pf.line()][pf.pipe()]<sp/>=<sp/>buffer[pf.line()][pf.pipe()-1]<sp/>+<sp/>1;</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/>}}</highlight></codeline>
|
|
<codeline><highlight class="normal">);</highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight><highlight class="comment">//<sp/>build<sp/>the<sp/>pipeline<sp/>graph<sp/>using<sp/>composition</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"><ref refid="classtf_1_1Task" kindref="compound">tf::Task</ref><sp/>init<sp/>=<sp/>taskflow.<ref refid="classtf_1_1FlowBuilder_1a60d7a666cab71ecfa3010b2efb0d6b57" kindref="member">emplace</ref>([](){<sp/><ref refid="cpp/io/basic_ostream" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::cout</ref><sp/><<<sp/></highlight><highlight class="stringliteral">"ready\n"</highlight><highlight class="normal">;<sp/>})</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>.name(</highlight><highlight class="stringliteral">"starting<sp/>pipeline"</highlight><highlight class="normal">);</highlight></codeline>
|
|
<codeline><highlight class="normal"><ref refid="classtf_1_1Task" kindref="compound">tf::Task</ref><sp/>task<sp/>=<sp/>taskflow.<ref refid="classtf_1_1FlowBuilder_1ac6f22228d4c2ea2e643c4b0d42c0e92a" kindref="member">composed_of</ref>(pipeline)</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>.<ref refid="classtf_1_1Task_1a08ada0425b490997b6ff7f310107e5e3" kindref="member">name</ref>(</highlight><highlight class="stringliteral">"pipeline"</highlight><highlight class="normal">);</highlight></codeline>
|
|
<codeline><highlight class="normal"><ref refid="classtf_1_1Task" kindref="compound">tf::Task</ref><sp/>stop<sp/>=<sp/>taskflow.<ref refid="classtf_1_1FlowBuilder_1a60d7a666cab71ecfa3010b2efb0d6b57" kindref="member">emplace</ref>([](){<sp/><ref refid="cpp/io/basic_ostream" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::cout</ref><sp/><<<sp/></highlight><highlight class="stringliteral">"stopped\n"</highlight><highlight class="normal">;<sp/>})</highlight></codeline>
|
|
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>.name(</highlight><highlight class="stringliteral">"pipeline<sp/>stopped"</highlight><highlight class="normal">);</highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight><highlight class="comment">//<sp/>create<sp/>task<sp/>dependency</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal">init.<ref refid="classtf_1_1Task_1a8c78c453295a553c1c016e4062da8588" kindref="member">precede</ref>(task);</highlight></codeline>
|
|
<codeline><highlight class="normal">task.<ref refid="classtf_1_1Task_1a8c78c453295a553c1c016e4062da8588" kindref="member">precede</ref>(stop);</highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal"></highlight><highlight class="comment">//<sp/>run<sp/>the<sp/>pipeline</highlight><highlight class="normal"></highlight></codeline>
|
|
<codeline><highlight class="normal">executor.<ref refid="classtf_1_1Executor_1a8d08f0cb79e7b3780087975d13368a96" kindref="member">run</ref>(taskflow).wait();</highlight></codeline>
|
|
</programlisting></para>
|
|
<para>The above example creates a pipeline graph that schedules five tokens over four parallel lines in a circular fashion, as depicted below:</para>
|
|
<para><programlisting filename=".shell-session"><codeline><highlight class="normal">o<sp/>-><sp/>o<sp/>-><sp/>o</highlight></codeline>
|
|
<codeline><highlight class="normal">|<sp/><sp/><sp/><sp/>|<sp/><sp/><sp/><sp/>|</highlight></codeline>
|
|
<codeline><highlight class="normal">v<sp/><sp/><sp/><sp/>v<sp/><sp/><sp/><sp/>v</highlight></codeline>
|
|
<codeline><highlight class="normal">o<sp/>-><sp/>o<sp/>-><sp/>o</highlight></codeline>
|
|
<codeline><highlight class="normal">|<sp/><sp/><sp/><sp/>|<sp/><sp/><sp/><sp/>|</highlight></codeline>
|
|
<codeline><highlight class="normal">v<sp/><sp/><sp/><sp/>v<sp/><sp/><sp/><sp/>v</highlight></codeline>
|
|
<codeline><highlight class="normal">o<sp/>-><sp/>o<sp/>-><sp/>o</highlight></codeline>
|
|
<codeline><highlight class="normal">|<sp/><sp/><sp/><sp/>|<sp/><sp/><sp/><sp/>|</highlight></codeline>
|
|
<codeline><highlight class="normal">v<sp/><sp/><sp/><sp/>v<sp/><sp/><sp/><sp/>v</highlight></codeline>
|
|
<codeline><highlight class="normal">o<sp/>-><sp/>o<sp/>-><sp/>o</highlight></codeline>
|
|
</programlisting></para>
|
|
<para>At each pipe stage, the program propagates the result to the next pipe by adding one to the result stored in a custom data storage, <computeroutput>buffer</computeroutput>. The pipeline scheduler will generate five scheduling tokens and then stop.</para>
|
|
<para>Internally, <ref refid="classtf_1_1Pipeline" kindref="compound">tf::Pipeline</ref> uses <ref refid="cpp/utility/tuple" kindref="compound" external="/home/thuang295/Code/taskflow/doxygen/cppreference-doxygen-web.tag.xml">std::tuple</ref> to store the given sequence of pipes. The definition of each pipe can be different, completely decided by the compiler to optimize the object layout. After a pipeline is constructed, it is not possible to change its pipes. If applications need to change these pipes, please use <ref refid="classtf_1_1ScalablePipeline" kindref="compound">tf::ScalablePipeline</ref>. </para>
|
|
</detaileddescription>
|
|
<location file="taskflow/algorithm/pipeline.hpp" line="404" column="1" bodyfile="taskflow/algorithm/pipeline.hpp" bodystart="404" bodyend="546"/>
|
|
<listofallmembers>
|
|
<member refid="classtf_1_1Pipeline_1ad091bbd38c1538884aa83d488fdf40f2" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_build</name></member>
|
|
<member refid="classtf_1_1Pipeline_1afb16e7472b979f81a8d997eae134e1c9" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_check_dependents</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a2d90bf386da24e7913b021febbcb6809" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_construct_deferred_tokens</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a7ff727cd8c130fc9b606c01dbfa12f9d" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_deferred_tokens</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a5c0604ba81fb2c8d0ba9c076df13ddda" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_gen_meta</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a1e3ad41a55de7fdc1f2ad40ee49a4d4a" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_graph</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a21eaa8e9904e9ebb9a1b1ea4a1e183de" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_lines</name></member>
|
|
<member refid="classtf_1_1Pipeline_1aaee01340ac6e941a949931b7e478d83e" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_longest_deferral</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a836ee5a9505f07fc032ea69563063378" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_meta</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a9d9fe0c2e30331b1f7e40d2dc3c5a76f" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_num_tokens</name></member>
|
|
<member refid="classtf_1_1Pipeline_1aa2e4a635ac4469754f2d922ea67151f9" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_on_pipe</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a8d0536148e5fdd373b4ed81965498749" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_pipeflows</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a442f95439871ed72fd67edab10fc77a0" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_pipes</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a10499ef31797d4db31243e6f73fb2ee8" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_ready_tokens</name></member>
|
|
<member refid="classtf_1_1Pipeline_1aa69993288e9ceefed489ff0c71ed1aca" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_resolve_token_dependencies</name></member>
|
|
<member refid="classtf_1_1Pipeline_1aba0c750fa328b21fcda5cb44801d6289" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_tasks</name></member>
|
|
<member refid="classtf_1_1Pipeline_1ab19a3164e7584ce1d16ecbff975421a7" prot="private" virt="non-virtual"><scope>tf::Pipeline</scope><name>_token_dependencies</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a4320bdd8b8cf05c9aac1b9fa000e4a35" prot="public" virt="non-virtual"><scope>tf::Pipeline</scope><name>graph</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a79f066bacd6c1abd28c26d8196955e95" prot="public" virt="non-virtual"><scope>tf::Pipeline</scope><name>num_lines</name></member>
|
|
<member refid="classtf_1_1Pipeline_1adfef0c60f8f8ace267d7cd8548457ff3" prot="public" virt="non-virtual"><scope>tf::Pipeline</scope><name>num_pipes</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a89af6714b661ded59970cac4c73b3ef9" prot="public" virt="non-virtual"><scope>tf::Pipeline</scope><name>num_tokens</name></member>
|
|
<member refid="classtf_1_1Pipeline_1aad8735676e4f9fd8474ad1ac51b58f3e" prot="public" virt="non-virtual"><scope>tf::Pipeline</scope><name>Pipeline</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a879a54b37af5db33e5768e5b3c135ba6" prot="public" virt="non-virtual"><scope>tf::Pipeline</scope><name>Pipeline</name></member>
|
|
<member refid="classtf_1_1Pipeline_1a311d874b98de6f0def8a7d869e8d15bd" prot="public" virt="non-virtual"><scope>tf::Pipeline</scope><name>reset</name></member>
|
|
</listofallmembers>
|
|
</compounddef>
|
|
</doxygen>
|