Class representing a N branch node. More...

#include <node.hpp>

Inheritance diagram for graph::n_branch_node< N, T, SAFE_MATH >:

Public Member Functions
	n_branch_node (std::array< shared_leaf< T, SAFE_MATH >, N > branches, const std::string s)
	Reduces and assigns the 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_arg (const size_t index) const
	Get the Nth arg.

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

virtual std::shared_ptr< leaf_node< T, SAFE_MATH > >	get_power_exponent () const
	Get the exponent of a power.

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 backend::buffer< T >	evaluate ()=0
	Evaluate method.

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 std::shared_ptr< leaf_node< T, SAFE_MATH > >	compile (std::ostringstream &stream, jit::register_map &registers, const jit::register_map &thread_mem, const jit::register_usage &usage)=0
	Compile the node.

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 void	to_latex () const
	Convert the node to latex.

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

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.

Protected Member Functions
bool	any_has_pseudo (std::array< shared_leaf< T, SAFE_MATH >, N > &branches)
	Check if any sub-node has a pseudo variable.

size_t	total_complexity (std::array< shared_leaf< T, SAFE_MATH >, N > &branches)
	Check if any sub-node has a pseudo variable.

Protected Attributes
std::array< shared_leaf< T, SAFE_MATH >, N >	branches
	Branches 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.

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.

Detailed Description

template<size_t N, jit::float_scalar T, bool SAFE_MATH = false>
class graph::n_branch_node< N, T, SAFE_MATH >

Class representing a N branch node.

Template Parameters

N	Number of branches of the node.
T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

This ensures that the base leaf type has the common type between the two template arguments.

Constructor & Destructor Documentation

◆ n_branch_node()

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

graph::n_branch_node< N, T, SAFE_MATH >::n_branch_node	(	std::array< shared_leaf< T, SAFE_MATH >, N >	branches,
		const std::string	s
	)

inline

Reduces and assigns the branches.

Parameters

[in]	branches	Array of branches.
[in]	s	Node string to hash.

Member Function Documentation

◆ any_has_pseudo()

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

bool graph::n_branch_node< N, T, SAFE_MATH >::any_has_pseudo ( std::array< shared_leaf< T, SAFE_MATH >, N > & branches )

inlineprotected

Check if any sub-node has a pseudo variable.

Parameters

[in] branches Array of branches.

Returns: True if any branch contains pseudo.

◆ compile_preamble()

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

virtual void graph::n_branch_node< N, T, SAFE_MATH >::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
	)

inlinevirtual

Compile preamble.

Parameters

[in,out]	stream	String buffer stream.
[in,out]	registers	List of defined registers.
[in,out]	visited	List of visited nodes.
[in,out]	usage	List of register usage count.
[in,out]	textures1d	List of 1D textures.
[in,out]	textures2d	List of 2D textures.
[in,out]	pre_funcs	Set of preamble functions.
[in,out]	avail_const_mem	Available constant memory.

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

Reimplemented in graph::apply_u_node< T >, and graph::apply_xi_node< T >.

◆ get_arg()

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

shared_leaf< T, SAFE_MATH > graph::n_branch_node< N, T, SAFE_MATH >::get_arg ( const size_t index ) const

inline

Get the Nth arg.

Parameters

[in] index The argument index.

Returns: The argument at the index.

◆ get_power_exponent()

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

virtual std::shared_ptr< leaf_node< T, SAFE_MATH > > graph::n_branch_node< N, T, SAFE_MATH >::get_power_exponent ( ) const

inlinevirtual

Get the exponent of a power.

Returns: Returns a power of one.

Implements graph::leaf_node< T, SAFE_MATH >.

◆ is_all_variables()

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

virtual bool graph::n_branch_node< N, T, SAFE_MATH >::is_all_variables ( ) const

inlinevirtual

Test if node acts like a variable.

Returns: True if the node acts like a variable.

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

◆ total_complexity()

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

size_t graph::n_branch_node< N, T, SAFE_MATH >::total_complexity ( std::array< shared_leaf< T, SAFE_MATH >, N > & branches )

inlineprotected

Check if any sub-node has a pseudo variable.

Parameters

[in] branches Array of branches.

Returns: True if any branch contains pseudo.

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

graph_framework/node.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ n_branch_node()

Member Function Documentation

◆ any_has_pseudo()

◆ compile_preamble()

◆ get_arg()

◆ get_power_exponent()

◆ is_all_variables()

◆ total_complexity()