workflow::manager< T, SAFE_MATH > Class Template Reference

Class representing a workflow manager. More...

#include <workflow.hpp>

Public Member Functions
	manager (const size_t index)
	Workflow manager constructor.
void	add_preitem (graph::input_nodes< T, SAFE_MATH > in, graph::output_nodes< T, SAFE_MATH > out, graph::map_nodes< T, SAFE_MATH > maps, graph::shared_random_state< T, SAFE_MATH > state, const std::string name, const size_t size)
	Add a pre workflow item.
void	add_item (graph::input_nodes< T, SAFE_MATH > in, graph::output_nodes< T, SAFE_MATH > out, graph::map_nodes< T, SAFE_MATH > maps, graph::shared_random_state< T, SAFE_MATH > state, const std::string name, const size_t size)
	Add a workflow item.
void	add_converge_item (graph::input_nodes< T, SAFE_MATH > in, graph::output_nodes< T, SAFE_MATH > out, graph::map_nodes< T, SAFE_MATH > maps, graph::shared_random_state< T, SAFE_MATH > state, const std::string name, const size_t size, const T tol=1.0E-30, const size_t max_iter=1000)
	Add a converge item.
void	compile ()
	Compile the workflow items.
void	pre_run ()
	Run pre work items.
void	run ()
	Run work items.
void	wait ()
	Wait for GPU queue to finish.
void	copy_to_device (graph::shared_leaf< T, SAFE_MATH > &node, T *destination)
	Copy buffer contents to the device.
void	copy_to_host (graph::shared_leaf< T, SAFE_MATH > &node, T *destination)
	Copy contexts of buffer to host.
void	print (const size_t index, const graph::output_nodes< T, SAFE_MATH > &nodes)
	Print results.
T	check_value (const size_t index, const graph::shared_leaf< T, SAFE_MATH > &node)
	Check the value.
jit::context< T, SAFE_MATH > &	get_context ()
	Get the jit context.

Detailed Description

template<jit::float_scalar T, bool SAFE_MATH = false>
class workflow::manager< T, SAFE_MATH >

Class representing a workflow manager.

Template Parameters

T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

Constructor & Destructor Documentation

manager()

template<jit::float_scalar T, bool SAFE_MATH = false>

workflow::manager< T, SAFE_MATH >::manager ( const size_t  index )

inline

Workflow manager constructor.

For GPU devices, this select the device number to run on. For CPU devices this parameter is ignored.

Note

It is possible to create multiple workflow managers for the same GPU device and may have performance benefits todo so.

Parameters

[in]

index

Device index.

Member Function Documentation

add_converge_item()

template<jit::float_scalar T, bool SAFE_MATH = false>

void workflow::manager< T, SAFE_MATH >::add_converge_item ( graph::input_nodes< T, SAFE_MATH >  in, graph::output_nodes< T, SAFE_MATH >  out, graph::map_nodes< T, SAFE_MATH >  maps, graph::shared_random_state< T, SAFE_MATH >  state, const std::string  name, const size_t  size, const T  tol = 1.0E-30, const size_t  max_iter = 1000  )

inline

Add a converge item.

Parameters

[in]	in	Input variables.
[in]	out	Output nodes.
[in]	maps	Setter maps.
[in]	state	Random state node.
[in]	name	Name of the work item.
[in]	size	Size of the work item.
[in]	tol	Tolerance to converge the function to.
[in]	max_iter	Maximum number of iterations before giving up.

add_item()

template<jit::float_scalar T, bool SAFE_MATH = false>

void workflow::manager< T, SAFE_MATH >::add_item ( graph::input_nodes< T, SAFE_MATH >  in, graph::output_nodes< T, SAFE_MATH >  out, graph::map_nodes< T, SAFE_MATH >  maps, graph::shared_random_state< T, SAFE_MATH >  state, const std::string  name, const size_t  size  )

inline

Add a workflow item.

Parameters

[in]	in	Input variables.
[in]	out	Output nodes.
[in]	maps	Setter maps.
[in]	state	Random state node.
[in]	name	Name of the work item.
[in]	size	Size of the work item.

add_preitem()

template<jit::float_scalar T, bool SAFE_MATH = false>

void workflow::manager< T, SAFE_MATH >::add_preitem ( graph::input_nodes< T, SAFE_MATH >  in, graph::output_nodes< T, SAFE_MATH >  out, graph::map_nodes< T, SAFE_MATH >  maps, graph::shared_random_state< T, SAFE_MATH >  state, const std::string  name, const size_t  size  )

inline

Add a pre workflow item.

Parameters

[in]	in	Input variables.
[in]	out	Output nodes.
[in]	maps	Setter maps.
[in]	state	Random state node.
[in]	name	Name of the work item.
[in]	size	Size of the work item.

check_value()

template<jit::float_scalar T, bool SAFE_MATH = false>

T workflow::manager< T, SAFE_MATH >::check_value ( const size_t  index, const graph::shared_leaf< T, SAFE_MATH > &  node  )

inline

Check the value.

Parameters

[in]	index	Particle index to check value for.
[in]	node	Node to check the value for.

Returns

The value at the index.

copy_to_device()

template<jit::float_scalar T, bool SAFE_MATH = false>

void workflow::manager< T, SAFE_MATH >::copy_to_device ( graph::shared_leaf< T, SAFE_MATH > &  node, T *  destination  )

inline

Copy buffer contents to the device.

Parameters

[in]	node	Node to copy buffer to.
[in]	destination	Host side buffer to copy from.

copy_to_host()

template<jit::float_scalar T, bool SAFE_MATH = false>

void workflow::manager< T, SAFE_MATH >::copy_to_host ( graph::shared_leaf< T, SAFE_MATH > &  node, T *  destination  )

inline

Copy contexts of buffer to host.

Parameters

[in]	node	Node to copy buffer from.
[in,out]	destination	Host side buffer to copy to.

get_context()

template<jit::float_scalar T, bool SAFE_MATH = false>

jit::context< T, SAFE_MATH > & workflow::manager< T, SAFE_MATH >::get_context ( )

inline

Get the jit context.

Returns

The jit context.

print()

template<jit::float_scalar T, bool SAFE_MATH = false>

void workflow::manager< T, SAFE_MATH >::print ( const size_t  index, const graph::output_nodes< T, SAFE_MATH > &  nodes  )

inline

Print results.

Parameters

[in]	index	Particle index to print.
[in]	nodes	Nodes to output.

---

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

• graph_framework/workflow.hpp