Aqua::CalcServer::Reduction Class Reference

Reductions, like scans, prefix sums, maximum or minimum, etc... More...

#include <Reduction.hpp>

Inheritance diagram for Aqua::CalcServer::Reduction:

Collaboration diagram for Aqua::CalcServer::Reduction:

Public Member Functions
	Reduction (const std::string name, const std::string input_name, const std::string output_name, const std::string operation, const std::string null_val, bool once=false)
	Reduction definition.
	~Reduction ()
	Destructor.
void	setup ()
	Initialize the tool.
size_t	nSteps () const
	Number of steps needed.
cl_event	getUserEvent () const
	Get the user event generated by this tool to mark when is finished.
Public Member Functions inherited from Aqua::CalcServer::Tool
	Tool (const std::string tool_name, bool once=false)
virtual	~Tool ()
virtual void	execute ()
	Execute the tool measuring the elapsed time.
virtual Tool *	next_tool ()
Tool *	prev_tool () const
void	prev_tool (Tool *tool)
size_t	allocatedMemory () const
unsigned int	used_times () const
void	addElapsedTime (float elapsed_time)
	Add new data to the average and squared elapsed times.
float	elapsedTime (bool averaged=true) const
float	elapsedTimeVariance () const
float	elapsedTimeDeviation () const
virtual int	scope_modifier () const
std::vector< InputOutput::Variable * >	getInputDependencies () const
	Get the input depedencies of the tool.
std::vector< InputOutput::Variable * >	getOutputDependencies () const
	Get the output depedencies of the tool.
std::tuple< std::vector< InputOutput::Variable * >, std::vector< InputOutput::Variable * > >	getDependencies () const
	Get the depedencies of the tool.
cl_event	getEvent () const
	Get the tool event.
void	parent (Tool *tool)
	Set the tool parent.
Tool *	parent ()
	Get the tool parent.
Public Member Functions inherited from Aqua::CalcServer::Named
	Named (const std::string name)
	~Named ()
void	name (const std::string tool_name)
const std::string	name () const
	Get the name.
Public Member Functions inherited from Aqua::CalcServer::Profiler
	Profiler ()
	~Profiler ()
std::vector< Profile * >	substages () const
	Get the substages.

Protected Member Functions
cl_event	_execute (const std::vector< cl_event > events)
Protected Member Functions inherited from Aqua::CalcServer::Tool
int	id_in_pipeline () const
std::string	varPrefix () const
	Produce a variable name prefix.
void	next_tool (Tool *tool)
void	allocatedMemory (size_t mem_size)
virtual cl_event	_execute (const UNUSED_PARAM std::vector< cl_event > events)
void	setDependencies (std::vector< std::string > inputs, std::vector< std::string > outputs)
	Set the depedencies of the tool.
void	setDependencies (std::vector< InputOutput::Variable * > inputs, std::vector< InputOutput::Variable * > outputs)
	Set the depedencies of the tool.
void	setDependencies (std::vector< std::string > vars)
	Set the depedencies of the tool.
void	setInputDependencies (std::vector< std::string > vars)
	Set the reading depedencies of the tool.
void	setInputDependencies (std::vector< InputOutput::Variable * > vars)
	Set the reading depedencies of the tool.
void	setOutputDependencies (std::vector< std::string > vars)
	Set the writing depedencies of the tool.
void	setOutputDependencies (std::vector< InputOutput::Variable * > vars)
	Set the writing depedencies of the tool.
void	setDependencies (std::vector< InputOutput::Variable * > vars)
	Set the depedencies of the tool.
const std::vector< cl_event >	getEvents (dep_events which=dep_events::all) const
	Get the list of events that this tool shall wait for.
Protected Member Functions inherited from Aqua::CalcServer::Profiler
void	substages (std::vector< Profile * > instances)
	Set the tool substages.

Additional Inherited Members
Protected Types inherited from Aqua::CalcServer::Tool
enum	dep_events { in = 0x01 , out = 0x02 , all = 0x03 }
Static Protected Member Functions inherited from Aqua::CalcServer::Tool
static std::vector< cl_kernel >	compile (const std::string source, const std::vector< std::string > names, const std::string flags="")
	Compile an OpenCL source code and generate the corresponding kernel.
static cl_kernel	compile_kernel (const std::string source, const std::string kernel_name, const std::string flags="")
	Compile an OpenCL source code and generate the corresponding kernel.

Detailed Description

Reductions, like scans, prefix sums, maximum or minimum, etc...

See also

Reduction.cl

Note

Hardcoded versions of the files CalcServer/Reduction.cl.in and CalcServer/Reduction.hcl.in are internally included as a text array.

Warning

This tool will not work with ihoc array, since it might be reallocated

Constructor & Destructor Documentation

Reduction()

Aqua::CalcServer::Reduction::Reduction	(	const std::string	name,
		const std::string	input_name,
		const std::string	output_name,
		const std::string	operation,
		const std::string	null_val,
		bool	once = false )

Reduction definition.

Parameters

name	Tool name.
input_name	Variable to be reduced name.
output_name	Variable where the reduced value will be stored.
operation	The reduction operation. For instance: "c += b;" "c.x = (a.x < b.x) ? a.x : b.x; a.y = (a.y < b.y) ? a.y : b.y;"
null_val	The value considered as the null one, i.e. INFINITY for float min value reduction, or (vec2)(0.f,0.f) for a 2D vec sum reduction.
once	Run this tool just once. Useful to make initializations.

Note

Some helpers are available for null_val:

• VEC_ZERO: Zeroes vector.
• VEC_ONE: Ones vector, in 3D cases the last component will be zero.
• VEC_ALL_ONE: Equal to VEC_ONE, but in 3D cases the last component will be one as well.
• VEC_INFINITY: INFINITY components vector, in 3D cases the last component will be zero.
• VEC_ALL_INFINITY: Equal to VEC_INFINITY, but in 3D cases the last component will be INFINITY as well.
• VEC_NEG_INFINITY: -VEC_INFINITY
• VEC_ALL_NEG_INFINITY: -VEC_ALL_INFINITY.

Here is the call graph for this function:

~Reduction()

Aqua::CalcServer::Reduction::~Reduction

(

)

Destructor.

Member Function Documentation

_execute()

cl_event Aqua::CalcServer::Reduction::_execute ( const std::vector< cl_event > events )

protected

Execute the tool

Parameters

events

List of events that shall be waited before safe execution

Returns

OpenCL event to be waited before accesing the dependencies

Here is the call graph for this function:

getUserEvent()

cl_event Aqua::CalcServer::Reduction::getUserEvent ( ) const

inline

Get the user event generated by this tool to mark when is finished.

Returns

The event

Note

This event will be the same than Aqua::CalcServer::Tool::getEvent(), however we need it just in case the callback is executed before Aqua::CalcServer::Tool had time to store it (race condition)

nSteps()

size_t Aqua::CalcServer::Reduction::nSteps ( ) const

inline

Number of steps needed.

To reduce the array to just one variable several steps may be needed, depending on the number of work groups that should be launched at each pass.

Returns

Number of steps needed.

setup()

void Aqua::CalcServer::Reduction::setup ( )

virtual

Initialize the tool.

This method should be called after the constructor, such that it could report errors that the application may handle quitting in a safe way.

Reimplemented from Aqua::CalcServer::Tool.

Here is the call graph for this function:

---

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

• /home/pepe/SPH/Code/aquagpusph/aquagpusph/CalcServer/Reduction.hpp
• /home/pepe/SPH/Code/aquagpusph/aquagpusph/CalcServer/Reduction.cpp