Class representing a subexpression that acts like a variable. More...

#include <node.hpp>

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

Public Member Functions
	pseudo_variable_node (shared_leaf< T, SAFE_MATH > a)
	Construct a pseudo variable node.

virtual shared_leaf< T, SAFE_MATH >	reduce ()
	Reduction method.

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

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

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

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

virtual shared_leaf< T, SAFE_MATH >	get_power_base ()
	Get the base of a power.

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

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

virtual shared_leaf< T, SAFE_MATH >	remove_pseudo ()
	Remove pseudo variable nodes.

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

Public Member Functions inherited from graph::straight_node< T, SAFE_MATH >
	straight_node (shared_leaf< T, SAFE_MATH > a, const std::string s)
	Construct a straight node.

virtual backend::buffer< T >	evaluate ()
	Evaluate method.

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, int &avail_const_mem)
	Compile preamble.

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

shared_leaf< T, SAFE_MATH >	get_arg ()
	Get the argument.

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 > >	df (std::shared_ptr< leaf_node< T, SAFE_MATH > > x)=0
	Transform node to derivative.

virtual bool	is_match (std::shared_ptr< leaf_node< T, SAFE_MATH > > x)
	Querey 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.

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 void	endline (std::ostringstream &stream, const jit::register_usage &usage) const final
	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::straight_node< T, SAFE_MATH >
shared_leaf< T, SAFE_MATH >	arg
	Argument.

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

const size_t	complexity
	Graph complexity.

std::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::pseudo_variable_node< T, SAFE_MATH >

Class representing a subexpression that acts like a variable.

Pseudo variable nodes treat sub trees as if they were a variable. This ensures that the expression returns zero when taking a derivative with something that is not itself.

Template Parameters

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

Constructor & Destructor Documentation

◆ pseudo_variable_node()

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

graph::pseudo_variable_node< T, SAFE_MATH >::pseudo_variable_node ( shared_leaf< T, SAFE_MATH > a )

inline

Construct a pseudo variable node.

Parameters

[in] a Argument.

Member Function Documentation

◆ df()

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

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

inlinevirtual

Transform node to derivative.

Parameters

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

Returns: The derivative of the node.

◆ get_power_base()

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

virtual shared_leaf< T, SAFE_MATH > graph::pseudo_variable_node< T, SAFE_MATH >::get_power_base ( )

inlinevirtual

Get the base of a power.

Returns: The base of a power like node.

Reimplemented from 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::pseudo_variable_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::straight_node< T, SAFE_MATH >.

◆ has_pseudo()

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

virtual bool graph::pseudo_variable_node< T, SAFE_MATH >::has_pseudo ( ) const

inlinevirtual

Query if the node contains pseudo variables.

Returns: True if the node contains pseudo variables.

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

◆ is_all_variables()

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

virtual bool graph::pseudo_variable_node< 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::straight_node< T, SAFE_MATH >.

◆ is_power_like()

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

virtual bool graph::pseudo_variable_node< T, SAFE_MATH >::is_power_like ( ) const

inlinevirtual

Test if the node acts like a power of variable.

Returns: True.

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

◆ reduce()

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

virtual shared_leaf< T, SAFE_MATH > graph::pseudo_variable_node< T, SAFE_MATH >::reduce ( )

inlinevirtual

Reduction method.

For basic nodes, there's nothing to reduce.

Returns: A reduced representation of the node.

Implements graph::leaf_node< T, SAFE_MATH >.

◆ remove_pseudo()

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

virtual shared_leaf< T, SAFE_MATH > graph::pseudo_variable_node< T, SAFE_MATH >::remove_pseudo ( )

inlinevirtual

Remove pseudo variable nodes.

Returns: A tree without variable nodes.

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

◆ to_latex()

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

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

inlinevirtual

Convert the node to latex.

Implements graph::leaf_node< T, SAFE_MATH >.

◆ to_vizgraph()

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

virtual shared_leaf< T, SAFE_MATH > graph::pseudo_variable_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/node.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pseudo_variable_node()

Member Function Documentation

◆ df()

◆ get_power_base()

◆ get_power_exponent()

◆ has_pseudo()

◆ is_all_variables()

◆ is_power_like()

◆ reduce()

◆ remove_pseudo()

◆ to_latex()

◆ to_vizgraph()