TPIE

2362a60
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
tpie::pipelining::pipe_end< fact_t > Class Template Reference

Inherits tpie::pipelining::bits::pipe_term_base< pipe_end< fact_t >, fact_t >.

Public Types

typedef fact_t factory_type
 
typedef fact_t::constructed_type constructed_type
 

Public Member Functions

template<typename... T_ARGS>
 pipe_end (T_ARGS &&...t)
 Forwards the arguments given to the constructor of the factory. More...
 
constructed_type construct ()
 
pipe_end< fact_t > memory (double amount)
 Set memory fraction for this node in the pipeline phase. More...
 
double memory () const
 Get memory fraction for this node in the pipeline phase. More...
 
pipe_end< fact_t > name (const std::string &n, priority_type p=PRIORITY_USER)
 Set name for this node. More...
 
pipe_end< fact_t > phase_name (const std::string &n, priority_type p=PRIORITY_USER)
 Set name for this phase. More...
 
pipe_end< fact_t > add_to_set (node_set s)
 Get a refenerce to this node. More...
 
pipe_end< fact_t > add_dependencies (node_set s)
 Add a depencency to a referenced node. More...
 
pipe_end< fact_t > add_forwarding_dependencies (node_set s)
 Add a forwarding dependency to a referenced node. More...
 
pipe_end< fact_t > breadcrumb (const std::string &n)
 Set a prefix for the name of this node. More...
 
pipe_end< fact_t > forward_any (const std::string &key, any_noncopyable value)
 
pipe_end< fact_t > forward (const std::string &key, T value)
 

Public Attributes

fact_t factory
 

Protected Member Functions

pipe_end< fact_t > & self ()
 
const pipe_end< fact_t > & self () const
 

Detailed Description

template<typename fact_t>
class tpie::pipelining::pipe_end< fact_t >

Definition at line 210 of file pipe_base.h.

Constructor & Destructor Documentation

template<typename fact_t>
template<typename... T_ARGS>
tpie::pipelining::pipe_end< fact_t >::pipe_end ( T_ARGS &&...  t)
inline

Forwards the arguments given to the constructor of the factory.

The implementation either usesvariadic templates.

Template Parameters
Argsthe variadic number of types of constructor parameters.
Parameters
argsthe variadic number of arguments to pass to the constructor of the factory

Definition at line 224 of file pipe_base.h.

224 : factory(std::forward<T_ARGS>(t)...) {}

Member Function Documentation

pipe_end< fact_t > tpie::pipelining::bits::pipe_base< pipe_end< fact_t > >::add_dependencies ( node_set  s)
inlineinherited

Add a depencency to a referenced node.

See also
factory_base::ref

Definition at line 127 of file pipe_base.h.

127  {
128  self().factory.add_dependencies(s);
129  return std::move(self());
130  }
pipe_end< fact_t > tpie::pipelining::bits::pipe_base< pipe_end< fact_t > >::add_forwarding_dependencies ( node_set  s)
inlineinherited

Add a forwarding dependency to a referenced node.

See also
factory_base::ref

Definition at line 137 of file pipe_base.h.

137  {
138  self().factory.add_forwarding_dependencies(s);
139  return std::move(self());
140  }
pipe_end< fact_t > tpie::pipelining::bits::pipe_base< pipe_end< fact_t > >::add_to_set ( node_set  s)
inlineinherited

Get a refenerce to this node.

This reference can be used to call add_dependency on another node

See also
factory_base::ref

Definition at line 117 of file pipe_base.h.

117  {
118  self().factory.add_to_set(s);
119  return std::move(self());
120  }
pipe_end< fact_t > tpie::pipelining::bits::pipe_base< pipe_end< fact_t > >::breadcrumb ( const std::string &  n)
inlineinherited

Set a prefix for the name of this node.

The name is used in the GraphViz plot generated by pipeline::plot.

See also
factory_base::push_breadcrumb

Definition at line 149 of file pipe_base.h.

149  {
150  self().factory.push_breadcrumb(n);
151  return std::move(self());
152  }
pipe_end< fact_t > tpie::pipelining::bits::pipe_base< pipe_end< fact_t > >::memory ( double  amount)
inlineinherited

Set memory fraction for this node in the pipeline phase.

In the absence of minimum and maximum memory requirements set by node implementations, the memory assigned to the node will be proportional to the amount parameter which sets the memory priority of this node in relation to the rest of the phase.

See also
factory_base::memory(double)

Definition at line 65 of file pipe_base.h.

65  {
66  self().factory.memory(amount);
67  return std::move(self());
68  }
double tpie::pipelining::bits::pipe_base< pipe_end< fact_t > >::memory ( ) const
inlineinherited

Get memory fraction for this node in the pipeline phase.

See also
memory(double)
factory_base::memory()

Definition at line 76 of file pipe_base.h.

76  {
77  return self().factory.memory();
78  }
pipe_end< fact_t > tpie::pipelining::bits::pipe_base< pipe_end< fact_t > >::name ( const std::string &  n,
priority_type  p = PRIORITY_USER 
)
inlineinherited

Set name for this node.

The name is used in the GraphViz plot generated by pipeline::plot.

The name priority given in the second argument should indicate how important this node is for the current phase, and is used in naming the progress indicator for this phase. The node with the highest priority name gets to name the entire phase.

See also
factory_base::name

Definition at line 92 of file pipe_base.h.

92  {
93  self().factory.name(n, p);
94  return std::move(self());
95  }
pipe_end< fact_t > tpie::pipelining::bits::pipe_base< pipe_end< fact_t > >::phase_name ( const std::string &  n,
priority_type  p = PRIORITY_USER 
)
inlineinherited

Set name for this phase.

The maximal priority phase name given for a phase wins.

See also
factory_base::phase_name

Definition at line 104 of file pipe_base.h.

104  {
105  self().factory.phase_name(n, p);
106  return std::move(self());
107  }
The documentation for this class was generated from the following file: