Class representing a 1D accumulated array. More...

#include <piecewise.hpp>

Inheritance diagram for graph::atomic_accumulate_1D_node< T, SAFE_MATH >:

Public Member Functions
	atomic_accumulate_1D_node (shared_leaf< T, SAFE_MATH > var, shared_leaf< T, SAFE_MATH > index, shared_leaf< T, SAFE_MATH > x)
	Construct a 1D index.

virtual backend::buffer< T >	evaluate ()
	Evaluate the results of accumulate.

virtual shared_leaf< T, SAFE_MATH >	df (shared_leaf< T, SAFE_MATH > x)
	Transform node to derivative.

virtual shared_leaf< T, SAFE_MATH >	compile (std::ostringstream &stream, jit::register_map &registers, const jit::register_map &thread_mem, const jit::register_usage &usage)
	Compile the node.

virtual bool	is_match (shared_leaf< T, SAFE_MATH > x)
	Query if the nodes match.

virtual bool	is_arg_match (shared_leaf< T, SAFE_MATH > x)
	Query if the nodes arguments match.

virtual void	to_latex () const
	Convert the node to latex.

virtual shared_leaf< T, SAFE_MATH >	to_vizgraph (std::stringstream &stream, jit::register_map &registers)
	Convert the node to vizgraph.

virtual shared_leaf< T, SAFE_MATH >	get_power_exponent () const
	Get the exponent of a power.

Public Member Functions inherited from graph::triple_node< T, SAFE_MATH >
	triple_node (shared_leaf< T, SAFE_MATH > l, shared_leaf< T, SAFE_MATH > m, shared_leaf< T, SAFE_MATH > r, const std::string s)
	Reduces and assigns the left and right branches.

virtual void	compile_preamble (std::ostringstream &stream, jit::register_map &registers, jit::visiter_map &visited, jit::register_usage &usage, jit::texture1d_list &textures1d, jit::texture2d_list &textures2d, jit::preamble_map &pre_funcs, int &avail_const_mem)
	Compile preamble.

shared_leaf< T, SAFE_MATH >	get_middle () const
	Get the middle branch.

virtual bool	is_all_variables () const
	Test if node acts like a variable.

Public Member Functions inherited from graph::branch_node< T, SAFE_MATH >
	branch_node (shared_leaf< T, SAFE_MATH > l, shared_leaf< T, SAFE_MATH > r, const std::string s)
	Assigns the left and right branches.

	branch_node (shared_leaf< T, SAFE_MATH > l, shared_leaf< T, SAFE_MATH > r, const std::string s, const size_t count, const bool pseudo)
	Assigns the left and right branches.

shared_leaf< T, SAFE_MATH >	get_left () const
	Get the left branch.

shared_leaf< T, SAFE_MATH >	get_right () const
	Get the right branch.

Public Member Functions inherited from graph::leaf_node< T, SAFE_MATH >
	leaf_node (const std::string s, const size_t count, const bool pseudo)
	Construct a basic node.

virtual	~leaf_node ()
	Destructor.

virtual std::shared_ptr< leaf_node< T, SAFE_MATH > >	reduce ()
	Reduction method.

virtual std::shared_ptr< leaf_node< T, SAFE_MATH > >	df (std::shared_ptr< leaf_node< T, SAFE_MATH > > x)
	Transform node to derivative.

virtual bool	is_match (std::shared_ptr< leaf_node< T, SAFE_MATH > > x)
	Query if the nodes match.

bool	is_power_base_match (std::shared_ptr< leaf_node< T, SAFE_MATH > > x)
	Check if the base of the powers match.

virtual void	set (const T d)
	Set the value of variable data.

virtual void	set (const size_t index, const T d)
	Set the value of variable data.

virtual void	set (const std::vector< T > &d)
	Set the value of variable data.

virtual void	set (const backend::buffer< T > &d)
	Set the value of variable data.

virtual bool	is_constant () const
	Test if node is a constant.

virtual bool	has_constant_zero () const
	Test the constant node has a zero.

bool	is_normal ()
	Test if the result is normal.

virtual bool	is_power_like () const
	Test if the node acts like a power of variable.

virtual std::shared_ptr< leaf_node< T, SAFE_MATH > >	get_power_base ()
	Get the base of a power.

size_t	get_hash () const
	Get the hash for the node.

size_t	get_complexity () const
	Get the number of nodes in the subgraph.

virtual bool	has_pseudo () const
	Query if the node contains pseudo variables.

virtual std::shared_ptr< leaf_node< T, SAFE_MATH > >	remove_pseudo ()
	Remove pseudo variable nodes.

virtual void	endline (std::ostringstream &stream, const jit::register_usage &usage, const char end=';') const
	End a line in the kernel source.

Additional Inherited Members
Public Types inherited from graph::leaf_node< T, SAFE_MATH >
typedef T	base
	Type def to retrieve the backend type.

Static Public Attributes inherited from graph::leaf_node< T, SAFE_MATH >
static thread_local caches_t	caches
	A per thread instance of the cache structure.

Protected Attributes inherited from graph::triple_node< T, SAFE_MATH >
shared_leaf< T, SAFE_MATH >	middle
	Middle branch of the tree.

Protected Attributes inherited from graph::branch_node< T, SAFE_MATH >
shared_leaf< T, SAFE_MATH >	left
	Left branch of the tree.

shared_leaf< T, SAFE_MATH >	right
	Right branch of the tree.

Protected Attributes inherited from graph::leaf_node< T, SAFE_MATH >
const size_t	hash
	Hash for node.

const size_t	complexity
	Graph complexity.

std::unordered_map< size_t, std::shared_ptr< leaf_node< T, SAFE_MATH > > >	df_cache
	Cache derivative terms.

const bool	contains_pseudo
	Node contains pseudo variables.

Detailed Description

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

Class representing a 1D accumulated array.

This class is used to implement summation into an array. This uses atomic add to avoid race conditions when multiple threads try to accumulate.

Indicies are selected by

x_norm' = (x - xmin)/dx (1)

Template Parameters

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

Constructor & Destructor Documentation

◆ atomic_accumulate_1D_node()

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

graph::atomic_accumulate_1D_node< T, SAFE_MATH >::atomic_accumulate_1D_node	(	shared_leaf< T, SAFE_MATH >	var,
		shared_leaf< T, SAFE_MATH >	index,
		shared_leaf< T, SAFE_MATH >	x
	)

inline

Construct a 1D index.

Parameters

[in]	var	Array node to accumulate to.
[in]	index	Index into the array.
[in]	x	Argument to add the existing array value.

Member Function Documentation

◆ compile()

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

virtual shared_leaf< T, SAFE_MATH > graph::atomic_accumulate_1D_node< T, SAFE_MATH >::compile	(	std::ostringstream &	stream,
		jit::register_map &	registers,
		const jit::register_map &	thread_mem,
		const jit::register_usage &	usage
	)

inlinevirtual

Compile the node.

This node first evaluates the value of the argument then chooses the correct index of the variable.

x' = (x - xmin)/dx (1)

Note: Since this node accumulates, the right hand side is basically.

y[i] = atomic_add(y[i], x) (2)

Note: The atomic add varies depending on the backend.

Metal atomic_fetch_add_explicit
Cuda atomic_add
CPU std::atomic_fetch_add_explicit

Note: These functions only take atomic data types. This changes the type used the kernel argument.

Parameters

[in,out]	stream	String buffer stream.
[in,out]	registers	List of defined registers.
[in]	thread_mem	List of defined thread memory registers.
[in]	usage	List of register usage count.

Returns: The current node.

Implements graph::leaf_node< T, SAFE_MATH >.

◆ df()

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

virtual shared_leaf< T, SAFE_MATH > graph::atomic_accumulate_1D_node< T, SAFE_MATH >::df ( shared_leaf< T, SAFE_MATH > x )

inlinevirtual

Transform node to derivative.

This node is effectively.

y_i + x (1)

So its effective derivative is

∂y_i/∂z + ∂x/dz

Parameters

[in] x The variable to take the derivative to.

Returns: The derivative of the node.

◆ evaluate()

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

virtual backend::buffer< T > graph::atomic_accumulate_1D_node< T, SAFE_MATH >::evaluate ( )

inlinevirtual

Evaluate the results of accumulate.

Evaluate functions are only used by the reduction. So this node does not evaluate the argument. Instead this only returns the data as if it were a constant.

Returns: The evaluated value of the node.

Implements graph::leaf_node< T, SAFE_MATH >.

◆ get_power_exponent()

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

virtual shared_leaf< T, SAFE_MATH > graph::atomic_accumulate_1D_node< T, SAFE_MATH >::get_power_exponent ( ) const

inlinevirtual

Get the exponent of a power.

Returns: The exponent of a power like node.

Reimplemented from graph::branch_node< T, SAFE_MATH >.

◆ is_arg_match()

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

virtual bool graph::atomic_accumulate_1D_node< T, SAFE_MATH >::is_arg_match ( shared_leaf< T, SAFE_MATH > x )

inlinevirtual

Query if the nodes arguments match.

The argument of this node can be deferred so we need to check if the arguments are null.

Parameters

[in] x Other graph to check if it is a match.

Returns: True if the nodes are a match.

◆ is_match()

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

virtual bool graph::atomic_accumulate_1D_node< T, SAFE_MATH >::is_match ( shared_leaf< T, SAFE_MATH > x )

inlinevirtual

Query if the nodes match.

Assumes both arguments are either set or not set.

Parameters

[in] x Other graph to check if it is a match.

Returns: True if the nodes are a match.

◆ to_latex()

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

virtual void graph::atomic_accumulate_1D_node< T, SAFE_MATH >::to_latex ( ) const

inlinevirtual

Convert the node to latex.

Reimplemented from graph::leaf_node< T, SAFE_MATH >.

◆ to_vizgraph()

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

virtual shared_leaf< T, SAFE_MATH > graph::atomic_accumulate_1D_node< T, SAFE_MATH >::to_vizgraph	(	std::stringstream &	stream,
		jit::register_map &	registers
	)

inlinevirtual

Convert the node to vizgraph.

Parameters

[in,out]	stream	String buffer stream.
[in,out]	registers	List of defined registers.

Returns: The current node.

Implements graph::leaf_node< T, SAFE_MATH >.

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

graph_framework/piecewise.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ atomic_accumulate_1D_node()

Member Function Documentation

◆ compile()

◆ df()

◆ evaluate()

◆ get_power_exponent()

◆ is_arg_match()

◆ is_match()

◆ to_latex()

◆ to_vizgraph()