Graph Framework
Loading...
Searching...
No Matches
graph::straight_node< T, SAFE_MATH > Class Template Reference

Class representing a straight node. More...

#include <node.hpp>

Inheritance diagram for graph::straight_node< T, SAFE_MATH >:
graph::leaf_node< T, SAFE_MATH > graph::cosine_node< T, SAFE_MATH > graph::erfi_node< T, SAFE_MATH > graph::exp_node< T, SAFE_MATH > graph::log_node< T, SAFE_MATH > graph::piecewise_1D_node< T, SAFE_MATH > graph::pseudo_variable_node< T, SAFE_MATH > graph::random_node< T, SAFE_MATH > graph::sine_node< T, SAFE_MATH > graph::sqrt_node< T, SAFE_MATH >

Public Member Functions

 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_MATHcompile (std::ostringstream &stream, jit::register_map &registers, jit::register_map &indices, const jit::register_usage &usage)
 Compile the node.
 
shared_leaf< T, SAFE_MATHget_arg ()
 Get the argument.
 
virtual bool is_all_variables () const
 Test if node acts like a variable.
 
virtual shared_leaf< T, SAFE_MATHget_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 std::shared_ptr< leaf_nodereduce ()=0
 Reduction method.
 
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 void to_latex () const =0
 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 final
 End a line in the kernel source.
 

Protected Attributes

shared_leaf< T, SAFE_MATHarg
 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.
 

Additional Inherited Members

- Public Types inherited from graph::leaf_node< T, SAFE_MATH >
typedefbase
 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<jit::float_scalar T, bool SAFE_MATH = false>
class graph::straight_node< T, SAFE_MATH >

Class representing a straight node.

Template Parameters
TBase type of the calculation.
SAFE_MATHUse Safe Math operations.

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

Constructor & Destructor Documentation

◆ straight_node()

template<jit::float_scalar T, bool SAFE_MATH = false>
graph::straight_node< T, SAFE_MATH >::straight_node ( shared_leaf< T, SAFE_MATH a,
const std::string  s 
)
inline

Construct a straight node.

Parameters
[in]aArgument.
[in]sNode string to hash.

Member Function Documentation

◆ compile()

template<jit::float_scalar T, bool SAFE_MATH = false>
virtual shared_leaf< T, SAFE_MATH > graph::straight_node< T, SAFE_MATH >::compile ( std::ostringstream &  stream,
jit::register_map registers,
jit::register_map indices,
const jit::register_usage usage 
)
inlinevirtual

Compile the node.

Parameters
[in,out]streamString buffer stream.
[in,out]registersList of defined registers.
[in,out]indicesList of defined indices.
[in]usageList of register usage count.
Returns
The current node.

Implements graph::leaf_node< T, SAFE_MATH >.

Reimplemented in graph::sqrt_node< T, SAFE_MATH >, graph::exp_node< T, SAFE_MATH >, graph::log_node< T, SAFE_MATH >, graph::erfi_node< T, SAFE_MATH >, graph::piecewise_1D_node< T, SAFE_MATH >, graph::random_node< T, SAFE_MATH >, graph::sine_node< T, SAFE_MATH >, and graph::cosine_node< T, SAFE_MATH >.

◆ compile_preamble()

template<jit::float_scalar T, bool SAFE_MATH = false>
virtual void graph::straight_node< 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,
int avail_const_mem 
)
inlinevirtual

Compile preamble.

Parameters
[in,out]streamString buffer stream.
[in,out]registersList of defined registers.
[in,out]visitedList of visited nodes.
[in,out]usageList of register usage count.
[in,out]textures1dList of 1D textures.
[in,out]textures2dList of 2D textures.
[in,out]avail_const_memAvailable constant memory.

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

Reimplemented in graph::piecewise_1D_node< T, SAFE_MATH >, and graph::random_node< T, SAFE_MATH >.

◆ evaluate()

◆ get_power_exponent()

template<jit::float_scalar T, bool SAFE_MATH = false>
virtual shared_leaf< T, SAFE_MATH > graph::straight_node< T, SAFE_MATH >::get_power_exponent ( ) const
inlinevirtual

◆ is_all_variables()

template<jit::float_scalar T, bool SAFE_MATH = false>
virtual bool graph::straight_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.

Implements graph::leaf_node< T, SAFE_MATH >.

Reimplemented in graph::pseudo_variable_node< T, SAFE_MATH >, graph::piecewise_1D_node< T, SAFE_MATH >, and graph::random_node< T, SAFE_MATH >.


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