docs/classtf_1_1Pipe.html
| | Taskflow: A General-purpose Task-parallel Programming System |
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Friends | List of all members
tf::Pipe< C > Class Template Reference
class to create a pipe object for a pipeline stage More...
#include <taskflow/algorithm/pipeline.hpp>
|
|
| using | callable_t = C |
| | alias of the callable type
|
| |
|
|
| | Pipe ()=default |
| | default constructor
|
| |
| | Pipe (PipeType d, C &&callable) |
| | constructs the pipe object
|
| |
| PipeType | type () const |
| | queries the type of the pipe
|
| |
| void | type (PipeType type) |
| | assigns a new type to the pipe
|
| |
| template<typename U> |
| void | callable (U &&callable) |
| | assigns a new callable to the pipe
|
| |
|
| | template<typename... Ps> | | class | Pipeline | | | | template<typename P> | | class | ScalablePipeline | | |
template<typename C = std::function<void(tf::Pipeflow&)>>
class tf::Pipe< C >
class to create a pipe object for a pipeline stage
Template Parameters
| C | callable type |
A pipe represents a stage of a pipeline. A pipe can be either parallel direction or serial direction (specified by tf::PipeType) and is coupled with a callable to invoke by the pipeline scheduler. The callable must take a referenced tf::Pipeflow object in the first argument:
Pipe{PipeType::SERIAL, {}}
Pipe()=default
default constructor
class to create a pipeflow object used by the pipe callable
Definition pipeline.hpp:43
@ SERIAL
serial type
Definition pipeline.hpp:117
The pipeflow object is used to query the statistics of a scheduling token in the pipeline, such as pipe, line, and token numbers.
template<typename C = std::function<void(tf::Pipeflow&)>>
|
| tf::Pipe< C >::Pipe | ( | PipeType | d, | | | | C && | callable ) |
| inline |
constructs the pipe object
Parameters
| d | pipe type (tf::PipeType) | | callable | callable type |
The constructor constructs a pipe with the given direction (tf::PipeType::SERIAL or tf::PipeType::PARALLEL) and the given callable. The callable must take a referenced tf::Pipeflow object in the first argument.
Pipe{PipeType::SERIAL, {}}
When creating a pipeline, the direction of the first pipe must be serial (tf::PipeType::SERIAL).
template<typename C = std::function<void(tf::Pipeflow&)>>
template<typename U>
|
| void tf::Pipe< C >::callable | ( | U && | callable | ) | |
| inline |
assigns a new callable to the pipe
Template Parameters
| U | callable type |
Parameters
| callable | a callable object constructible from std::function<void(tf::Pipeflow&)> |
Assigns a new callable to the pipe with universal forwarding.
template<typename C = std::function<void(tf::Pipeflow&)>>
|
| PipeType tf::Pipe< C >::type | ( | | ) | const |
| inline |
queries the type of the pipe
Returns the type of the callable.
template<typename C = std::function<void(tf::Pipeflow&)>>
|
| void tf::Pipe< C >::type | ( | PipeType | type | ) | |
| inline |
assigns a new type to the pipe
Parameters
| type | a tf::PipeType variable |
The documentation for this class was generated from the following file:
taskflow/algorithm/pipeline.hpp
Maintained by Dr. Tsung-Wei Huang — Generated by 1.13.1