tpie::pipelining::bits::pipe_base< child_t > Class Template Reference

Inherited by tpie::pipelining::bits::pipe_nonterm_base< child_t >, and tpie::pipelining::bits::pipe_term_base< child_t, fact_t >.

Public Member Functions
	pipe_base (pipe_base &other)=delete
	pipe_base (pipe_base &&other)=default
pipe_base &	operator= (pipe_base &other)=delete
pipe_base &	operator= (pipe_base &&other)=default
child_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...
child_t	name (const std::string &n, priority_type p=PRIORITY_USER)
	Set name for this node. More...
child_t	phase_name (const std::string &n, priority_type p=PRIORITY_USER)
	Set name for this phase. More...
child_t	add_to_set (node_set s)
	Get a refenerce to this node. More...
child_t	add_dependencies (node_set s)
	Add a depencency to a referenced node. More...
child_t	add_forwarding_dependencies (node_set s)
	Add a forwarding dependency to a referenced node. More...
child_t	breadcrumb (const std::string &n)
	Set a prefix for the name of this node. More...
child_t	forward_any (const std::string &key, any_noncopyable value)
template<typename T >
child_t	forward (const std::string &key, T value)

Protected Member Functions
child_t &	self ()
const child_t &	self () const

Detailed Description

template<typename child_t>
class tpie::pipelining::bits::pipe_base< child_t >

Definition at line 45 of file pipe_base.h.

Member Function Documentation

add_dependencies()

template<typename child_t >

child_t tpie::pipelining::bits::pipe_base< child_t >::add_dependencies ( node_set  s )

inline

Add a depencency to a referenced node.

See also

factory_base::ref

Definition at line 125 of file pipe_base.h.

                                         {
        self().factory.add_dependencies(s);
        return std::move(self());
    }

add_forwarding_dependencies()

template<typename child_t >

child_t tpie::pipelining::bits::pipe_base< child_t >::add_forwarding_dependencies ( node_set  s )

inline

Add a forwarding dependency to a referenced node.

See also

factory_base::ref

Definition at line 135 of file pipe_base.h.

                                                    {
        self().factory.add_forwarding_dependencies(s);
        return std::move(self());
    }

add_to_set()

template<typename child_t >

child_t tpie::pipelining::bits::pipe_base< child_t >::add_to_set ( node_set  s )

inline

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 115 of file pipe_base.h.

                                   {
        self().factory.add_to_set(s);
        return std::move(self());
    }

breadcrumb()

template<typename child_t >

child_t tpie::pipelining::bits::pipe_base< child_t >::breadcrumb ( const std::string &  n )

inline

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 147 of file pipe_base.h.

                                            {
        self().factory.push_breadcrumb(n);
        return std::move(self());
    }

memory() [1/2]

template<typename child_t >

double tpie::pipelining::bits::pipe_base< child_t >::memory ( ) const

inline

Get memory fraction for this node in the pipeline phase.

See also

memory(double)

factory_base::memory()

Definition at line 74 of file pipe_base.h.

                          {
        return self().factory.memory();
    }

memory() [2/2]

template<typename child_t >

child_t tpie::pipelining::bits::pipe_base< child_t >::memory ( double  amount )

inline

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 63 of file pipe_base.h.

                                  {
        self().factory.memory(amount);
        return std::move(self());
    }

name()

template<typename child_t >

child_t tpie::pipelining::bits::pipe_base< child_t >::name ( const std::string &  n, priority_type  p = PRIORITY_USER  )

inline

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 90 of file pipe_base.h.

                                                                       {
        self().factory.name(n, p);
        return std::move(self());
    }

Referenced by tpie::pipelining::serialization_sort(), tpie::pipelining::sort(), and tpie::pipelining::store_sort().

phase_name()

template<typename child_t >

child_t tpie::pipelining::bits::pipe_base< child_t >::phase_name ( const std::string &  n, priority_type  p = PRIORITY_USER  )

inline

Set name for this phase.

The maximal priority phase name given for a phase wins.

See also

factory_base::phase_name

Definition at line 102 of file pipe_base.h.

                                                                             {
        self().factory.phase_name(n, p);
        return std::move(self());
    }

---

The documentation for this class was generated from the following file:

• pipelining/pipe_base.h