A base class for all template tasks. More...

#include <tt.h>

Inheritance diagram for ttg::TTBase:

Public Member Functions
virtual	~TTBase ()=default

virtual void	invoke ()

bool	set_trace_instance (bool value)

bool	tracing () const

template<typename T , typename... Ts>
void	trace (const T &t, const Ts &...ts)
	Like ttg::trace(), but only produces tracing output if `this->tracing()==true`

bool	set_lazy_pull_instance (bool value)

bool	is_lazy_pull ()

std::optional< std::reference_wrapper< const TTBase > >	ttg () const

const TTBase *	ttg_ptr () const

bool	is_ttg () const

void	set_name (const std::string &name)
	Sets the name of this operation.

const std::string &	get_name () const
	Gets the name of this operation.

std::string	get_class_name () const
	Gets the demangled class name (uses RTTI)

const std::vector< TerminalBase * > &	get_inputs () const
	Returns the vector of input terminals.

const std::vector< TerminalBase * > &	get_outputs () const
	Returns the vector of output terminals.

virtual ttg::World	get_world () const =0

ttg::TerminalBase *	in (size_t i)
	Returns a pointer to the i'th input terminal.

ttg::TerminalBase *	out (size_t i)
	Returns a pointer to the i'th output terminal.

template<std::size_t i>
ttg::TerminalBase *	in ()
	Returns a pointer to the i'th input terminal ... to make API consistent with TT.

template<std::size_t i>
ttg::TerminalBase *	out ()
	Returns a pointer to the i'th output terminal ... to make API consistent with TT.

auto	get_instance_id () const

virtual void	fence ()=0

virtual void	release ()

virtual void	make_executable ()=0
	Marks this executable.

bool	is_executable () const

Static Public Member Functions
static bool	set_trace_all (bool value)

static bool	set_lazy_pull (bool value)

static const std::vector< TerminalBase * > *	get_outputs_tls_ptr ()
	Returns this thread's pointer to the vector of output terminals.

Protected Member Functions
void	set_input (size_t i, TerminalBase *t)

void	set_output (size_t i, TerminalBase *t)

template<bool out, typename terminalT , std::size_t i, typename setfuncT >
void	register_terminal (terminalT &term, const std::string &name, const setfuncT setfunc)

template<bool out, std::size_t... IS, typename terminalsT , typename namesT , typename setfuncT >
void	register_terminals (std::index_sequence< IS... >, terminalsT &terms, const namesT &names, const setfuncT setfunc)

template<typename terminalsT , typename namesT >
void	register_input_terminals (terminalsT &terms, const namesT &names)

template<typename terminalsT , typename namesT >
void	register_output_terminals (terminalsT &terms, const namesT &names)

template<std::size_t... IS, typename terminalsT , typename setfuncT >
void	set_terminals (std::index_sequence< IS... >, terminalsT &terms, const setfuncT setfunc)

template<typename terminalsT , typename setfuncT >
void	set_terminals (const terminalsT &terms, const setfuncT setfunc)

	TTBase (TTBase &&other)

TTBase &	operator= (TTBase &&other)

	TTBase (const std::string &name, size_t numins, size_t numouts)

void	set_outputs_tls_ptr ()

void	set_outputs_tls_ptr (const std::vector< TerminalBase * > *ptr)

Static Protected Member Functions
static const std::vector< TerminalBase * > *&	outputs_tls_ptr_accessor ()

Friends
template<typename input_terminalsT , typename output_terminalsT >
class	TTG

Detailed Description

A base class for all template tasks.

Definition at line 31 of file tt.h.

Constructor & Destructor Documentation

◆ TTBase() [1/2]

ttg::TTBase::TTBase ( TTBase && other )

inlineprotected

Definition at line 116 of file tt.h.

Here is the caller graph for this function:

◆ TTBase() [2/2]

ttg::TTBase::TTBase	(	const std::string &	name,
		size_t	numins,
		size_t	numouts
	)

inlineprotected

Definition at line 134 of file tt.h.

◆ ~TTBase()

virtual ttg::TTBase::~TTBase ( )

virtualdefault

Member Function Documentation

◆ fence()

virtual void ttg::TTBase::fence ( )

pure virtual

Waits for the entire TTG that contains this object to be completed (collective); if not contained by a TTG this is a no-op

Implemented in ttg_madness::TT< keyT, output_terminalsT, derivedT, input_valueTs, Space >, ttg::TTG< input_terminalsT, output_terminalsT >, and ttg::SinkTT< keyT, input_valueT >.

◆ get_class_name()

std::string ttg::TTBase::get_class_name ( ) const

inline

Gets the demangled class name (uses RTTI)

Definition at line 221 of file tt.h.

Here is the caller graph for this function:

◆ get_inputs()

const std::vector< TerminalBase * > & ttg::TTBase::get_inputs ( ) const

inline

Returns the vector of input terminals.

Definition at line 224 of file tt.h.

Here is the caller graph for this function:

◆ get_instance_id()

auto ttg::TTBase::get_instance_id ( ) const

inline

Definition at line 259 of file tt.h.

Here is the caller graph for this function:

◆ get_name()

const std::string & ttg::TTBase::get_name ( ) const

inline

Gets the name of this operation.

Definition at line 218 of file tt.h.

Here is the caller graph for this function:

◆ get_outputs()

const std::vector< TerminalBase * > & ttg::TTBase::get_outputs ( ) const

inline

Returns the vector of output terminals.

Definition at line 227 of file tt.h.

Here is the caller graph for this function:

◆ get_outputs_tls_ptr()

static const std::vector< TerminalBase * > * ttg::TTBase::get_outputs_tls_ptr ( )

inlinestatic

Returns this thread's pointer to the vector of output terminals.

Definition at line 230 of file tt.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_world()

virtual ttg::World ttg::TTBase::get_world ( ) const

pure virtual

Returns: World in which this lives

Implemented in ttg_madness::TT< keyT, output_terminalsT, derivedT, input_valueTs, Space >, ttg_parsec::TT< int, std::tuple< Out< int, Value >, Out< int, Value >, Out< int, Value > >, BinaryTreeBroadcast< Value, int >, ttg::typelist< Value > >, ttg_parsec::TT< int, std::tuple< Out< int, Value >, Out< int, Value >, Out< int, Value >, Out< OutKey, Value > >, BinaryTreeReduce< Value, BinaryOp, OutKey >, ttg::typelist< Value, Value, Value > >, ttg_parsec::TT< keyT, output_terminalsT, derivedT, input_valueTs, Space >, ttg::TTG< input_terminalsT, output_terminalsT >, and ttg::SinkTT< keyT, input_valueT >.

◆ in() [1/2]

template<std::size_t i>

ttg::TerminalBase * ttg::TTBase::in ( )

inline

Returns a pointer to the i'th input terminal ... to make API consistent with TT.

Definition at line 249 of file tt.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ in() [2/2]

ttg::TerminalBase * ttg::TTBase::in ( size_t i )

inline

Returns a pointer to the i'th input terminal.

Definition at line 236 of file tt.h.

Here is the caller graph for this function:

◆ invoke()

virtual void ttg::TTBase::invoke ( )

inlinevirtual

Use this to create a task that takes no data "manually"

Warning: calls ttg::abort() if the derived class TT did not override this; only makes sense to override this if the derived TT uses void for key or data

Reimplemented in ttg_madness::TT< keyT, output_terminalsT, derivedT, input_valueTs, Space >, ttg_parsec::TT< int, std::tuple< Out< int, Value >, Out< int, Value >, Out< int, Value > >, BinaryTreeBroadcast< Value, int >, ttg::typelist< Value > >, ttg_parsec::TT< int, std::tuple< Out< int, Value >, Out< int, Value >, Out< int, Value >, Out< OutKey, Value > >, BinaryTreeReduce< Value, BinaryOp, OutKey >, ttg::typelist< Value, Value, Value > >, ttg_parsec::TT< keyT, output_terminalsT, derivedT, input_valueTs, Space >, ttg_madness::TT< keyT, output_terminalsT, derivedT, input_valueTs, Space >, ttg_parsec::TT< int, std::tuple< Out< int, Value >, Out< int, Value >, Out< int, Value > >, BinaryTreeBroadcast< Value, int >, ttg::typelist< Value > >, ttg_parsec::TT< int, std::tuple< Out< int, Value >, Out< int, Value >, Out< int, Value >, Out< OutKey, Value > >, BinaryTreeReduce< Value, BinaryOp, OutKey >, ttg::typelist< Value, Value, Value > >, and ttg_parsec::TT< keyT, output_terminalsT, derivedT, input_valueTs, Space >.

Definition at line 150 of file tt.h.

Here is the call graph for this function:

◆ is_executable()

bool ttg::TTBase::is_executable ( ) const

inline

Queries if this ready to execute

Returns: true is this object is executable

Definition at line 272 of file tt.h.

◆ is_lazy_pull()

bool ttg::TTBase::is_lazy_pull ( )

inline

Definition at line 200 of file tt.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_ttg()

bool ttg::TTBase::is_ttg ( ) const

inline

Definition at line 210 of file tt.h.

Here is the caller graph for this function:

◆ make_executable()

void ttg::TTBase::make_executable ( )

inlinepure virtual

Marks this executable.

Implemented in ttg_madness::TT< keyT, output_terminalsT, derivedT, input_valueTs, Space >, ttg_parsec::TT< int, std::tuple< Out< int, Value >, Out< int, Value >, Out< int, Value > >, BinaryTreeBroadcast< Value, int >, ttg::typelist< Value > >, ttg_parsec::TT< int, std::tuple< Out< int, Value >, Out< int, Value >, Out< int, Value >, Out< OutKey, Value > >, BinaryTreeReduce< Value, BinaryOp, OutKey >, ttg::typelist< Value, Value, Value > >, ttg_parsec::TT< keyT, output_terminalsT, derivedT, input_valueTs, Space >, ttg::TTG< input_terminalsT, output_terminalsT >, and ttg::SinkTT< keyT, input_valueT >.

Definition at line 287 of file tt.h.

Here is the caller graph for this function:

◆ operator=()

TTBase & ttg::TTBase::operator= ( TTBase && other )

inlineprotected

Definition at line 124 of file tt.h.

◆ out() [1/2]

template<std::size_t i>

ttg::TerminalBase * ttg::TTBase::out ( )

inline

Returns a pointer to the i'th output terminal ... to make API consistent with TT.

Definition at line 255 of file tt.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ out() [2/2]

ttg::TerminalBase * ttg::TTBase::out ( size_t i )

inline

Returns a pointer to the i'th output terminal.

Definition at line 242 of file tt.h.

Here is the caller graph for this function:

◆ outputs_tls_ptr_accessor()

static const std::vector< TerminalBase * > *& ttg::TTBase::outputs_tls_ptr_accessor ( )

inlinestaticprotected

Definition at line 137 of file tt.h.

Here is the caller graph for this function:

◆ register_input_terminals()

template<typename terminalsT , typename namesT >

void ttg::TTBase::register_input_terminals	(	terminalsT &	terms,
		const namesT &	names
	)

inlineprotected

Definition at line 85 of file tt.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ register_output_terminals()

template<typename terminalsT , typename namesT >

void ttg::TTBase::register_output_terminals	(	terminalsT &	terms,
		const namesT &	names
	)

inlineprotected

Definition at line 92 of file tt.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ register_terminal()

template<bool out, typename terminalT , std::size_t i, typename setfuncT >

void ttg::TTBase::register_terminal	(	terminalT &	term,
		const std::string &	name,
		const setfuncT	setfunc
	)

inlineprotected

Definition at line 65 of file tt.h.

Here is the call graph for this function:

◆ register_terminals()

template<bool out, std::size_t... IS, typename terminalsT , typename namesT , typename setfuncT >

void ttg::TTBase::register_terminals	(	std::index_sequence< IS... >	,
		terminalsT &	terms,
		const namesT &	names,
		const setfuncT	setfunc
	)

inlineprotected

Definition at line 75 of file tt.h.

◆ release()

virtual void ttg::TTBase::release ( )

inlinevirtual

Reimplemented in ttg_parsec::TT< int, std::tuple< Out< int, Value >, Out< int, Value >, Out< int, Value > >, BinaryTreeBroadcast< Value, int >, ttg::typelist< Value > >, ttg_parsec::TT< int, std::tuple< Out< int, Value >, Out< int, Value >, Out< int, Value >, Out< OutKey, Value > >, BinaryTreeReduce< Value, BinaryOp, OutKey >, ttg::typelist< Value, Value, Value > >, and ttg_parsec::TT< keyT, output_terminalsT, derivedT, input_valueTs, Space >.

Definition at line 265 of file tt.h.

◆ set_input()

void ttg::TTBase::set_input	(	size_t	i,
		TerminalBase *	t
	)

inlineprotected

Definition at line 54 of file tt.h.

Here is the caller graph for this function:

◆ set_lazy_pull()

static bool ttg::TTBase::set_lazy_pull ( bool value )

inlinestatic

Definition at line 165 of file tt.h.

Here is the call graph for this function:

◆ set_lazy_pull_instance()

bool ttg::TTBase::set_lazy_pull_instance ( bool value )

inline

Definition at line 195 of file tt.h.

◆ set_name()

void ttg::TTBase::set_name ( const std::string & name )

inline

Sets the name of this operation.

Definition at line 215 of file tt.h.

◆ set_output()

void ttg::TTBase::set_output	(	size_t	i,
		TerminalBase *	t
	)

inlineprotected

Definition at line 59 of file tt.h.

Here is the caller graph for this function:

◆ set_outputs_tls_ptr() [1/2]

void ttg::TTBase::set_outputs_tls_ptr ( )

inlineprotected

Definition at line 141 of file tt.h.

Here is the call graph for this function:

◆ set_outputs_tls_ptr() [2/2]

void ttg::TTBase::set_outputs_tls_ptr ( const std::vector< TerminalBase * > * ptr )

inlineprotected

Definition at line 142 of file tt.h.

Here is the call graph for this function:

◆ set_terminals() [1/2]

template<typename terminalsT , typename setfuncT >

void ttg::TTBase::set_terminals	(	const terminalsT &	terms,
		const setfuncT	setfunc
	)

inlineprotected

Definition at line 106 of file tt.h.

Here is the call graph for this function:

◆ set_terminals() [2/2]

template<std::size_t... IS, typename terminalsT , typename setfuncT >

void ttg::TTBase::set_terminals	(	std::index_sequence< IS... >	,
		terminalsT &	terms,
		const setfuncT	setfunc
	)

inlineprotected

Definition at line 99 of file tt.h.

Here is the caller graph for this function:

◆ set_trace_all()

static bool ttg::TTBase::set_trace_all ( bool value )

inlinestatic

Sets trace for all operations to value and returns previous setting. This has no effect unless trace_enabled()==true

Definition at line 157 of file tt.h.

Here is the call graph for this function:

◆ set_trace_instance()

bool ttg::TTBase::set_trace_instance ( bool value )

inline

Sets trace for just this instance to value and returns previous setting This has no effect unless trace_enabled()==true

Definition at line 172 of file tt.h.

Here is the call graph for this function:

◆ trace()

template<typename T , typename... Ts>

void ttg::TTBase::trace	(	const T &	t,
		const Ts &...	ts
	)

inline

Like ttg::trace(), but only produces tracing output if this->tracing()==true

Definition at line 187 of file tt.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tracing()

bool ttg::TTBase::tracing ( ) const

inline

Returns: false if trace_enabled()==false, else true if tracing set for either this instance or all instances

Definition at line 178 of file tt.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ttg()

std::optional< std::reference_wrapper< const TTBase > > ttg::TTBase::ttg ( ) const

inline

Definition at line 202 of file tt.h.

◆ ttg_ptr()

const TTBase * ttg::TTBase::ttg_ptr ( ) const

inline

Definition at line 206 of file tt.h.

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ TTG

template<typename input_terminalsT , typename output_terminalsT >

friend class TTG

friend

Definition at line 41 of file tt.h.

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

ttg/ttg/base/tt.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TTBase() [1/2]

◆ TTBase() [2/2]

◆ ~TTBase()

Member Function Documentation

◆ fence()

◆ get_class_name()

◆ get_inputs()

◆ get_instance_id()

◆ get_name()

◆ get_outputs()

◆ get_outputs_tls_ptr()

◆ get_world()

◆ in() [1/2]

◆ in() [2/2]

◆ invoke()

◆ is_executable()

◆ is_lazy_pull()

◆ is_ttg()

◆ make_executable()

◆ operator=()

◆ out() [1/2]

◆ out() [2/2]

◆ outputs_tls_ptr_accessor()

◆ register_input_terminals()

◆ register_output_terminals()

◆ register_terminal()

◆ register_terminals()

◆ release()

◆ set_input()

◆ set_lazy_pull()

◆ set_lazy_pull_instance()

◆ set_name()

◆ set_output()

◆ set_outputs_tls_ptr() [1/2]

◆ set_outputs_tls_ptr() [2/2]

◆ set_terminals() [1/2]

◆ set_terminals() [2/2]

◆ set_trace_all()

◆ set_trace_instance()

◆ trace()

◆ tracing()

◆ ttg()

◆ ttg_ptr()

Friends And Related Symbol Documentation

◆ TTG