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

A or node. More...

#include <logical.hpp>

Inheritance diagram for graph::or_node< T, SAFE_MATH >:
graph::no_derivative< T, SAFE_MATH, BASE_NODE, N > graph::leaf_node< T, SAFE_MATH >

Public Member Functions

 or_node (shared_leaf< T, SAFE_MATH > l, shared_leaf< T, SAFE_MATH > r)
 Construct a or node.
 
virtual backend::buffer< T > evaluate ()
 Evaluate the results of less than equal.
 
virtual shared_leaf< T, SAFE_MATH > reduce ()
 Reduce or node.
 
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 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.
 
- Public Member Functions inherited from graph::no_derivative< T, SAFE_MATH, BASE_NODE, N >
template<typename S = bool>
requires (has_no_derivative<S>::value)
std::shared_ptr< leaf_node< T, SAFE_MATH > > df (std::shared_ptr< leaf_node< T, SAFE_MATH > > x)
 Transform node to derivative.
 
 no_derivative (const std::string s)
 Constructor for base leaf nodes base classes.
 
 no_derivative (shared_leaf< T, SAFE_MATH > arg, const std::string s)
 Constructor for straight node base classes.
 
 no_derivative (shared_leaf< T, SAFE_MATH > l, shared_leaf< T, SAFE_MATH > r, const std::string s)
 Constructor for base branch nodes base classes.
 
 no_derivative (shared_leaf< T, SAFE_MATH > l, shared_leaf< T, SAFE_MATH > m, shared_leaf< T, SAFE_MATH > r, const std::string s)
 Constructor for base triple nodes base classes.
 
 no_derivative (std::array< shared_leaf< T, SAFE_MATH >, N > b, const std::string s)
 Constructor for base n branch nodes base classes.
 
- 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 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.
 
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_all_variables () const
 Test if all the sub-nodes terminate in variables.
 
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.
 
virtual std::shared_ptr< leaf_node< T, SAFE_MATH > > get_power_exponent () const =0
 Get the exponent 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::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<std::floating_point T, bool SAFE_MATH = false>
class graph::or_node< T, SAFE_MATH >

A or node.

Note use templates here to defer this so it can use the operator functions.

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

Constructor & Destructor Documentation

◆ or_node()

template<std::floating_point T, bool SAFE_MATH = false>
graph::or_node< T, SAFE_MATH >::or_node ( shared_leaf< T, SAFE_MATH >  l,
shared_leaf< T, SAFE_MATH >  r 
)
inline

Construct a or node.

Parameters
[in]lLeft branch.
[in]rRight branch.

Member Function Documentation

◆ compile()

template<std::floating_point T, bool SAFE_MATH = false>
virtual shared_leaf< T, SAFE_MATH > graph::or_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.

Parameters
[in,out]streamString buffer stream.
[in,out]registersList of defined registers.
[in]thread_memList of defined thread memory registers.
[in]usageList of register usage count.

Implements graph::leaf_node< T, SAFE_MATH >.

◆ evaluate()

template<std::floating_point T, bool SAFE_MATH = false>
virtual backend::buffer< T > graph::or_node< T, SAFE_MATH >::evaluate ( )
inlinevirtual

Evaluate the results of less than equal.

result = l || r

Returns
The value of l || r.

Implements graph::leaf_node< T, SAFE_MATH >.

◆ is_match()

template<std::floating_point T, bool SAFE_MATH = false>
virtual bool graph::or_node< T, SAFE_MATH >::is_match ( shared_leaf< T, SAFE_MATH >  x)
inlinevirtual

Query if the nodes match.

Parameters
[in]xOther graph to check if it is a match.
Returns
True if the nodes are a match.

◆ reduce()

template<std::floating_point T, bool SAFE_MATH = false>
virtual shared_leaf< T, SAFE_MATH > graph::or_node< T, SAFE_MATH >::reduce ( )
inlinevirtual

Reduce or node.

Returns
A reduced less than equal node.

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

◆ to_latex()

template<std::floating_point T, bool SAFE_MATH = false>
virtual void graph::or_node< T, SAFE_MATH >::to_latex ( ) const
inlinevirtual

Convert the node to latex.

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

◆ to_vizgraph()

template<std::floating_point T, bool SAFE_MATH = false>
virtual shared_leaf< T, SAFE_MATH > graph::or_node< T, SAFE_MATH >::to_vizgraph ( std::stringstream &  stream,
jit::register_map &  registers 
)
inlinevirtual

Convert the node to vizgraph.

Parameters
[in,out]streamString buffer stream.
[in,out]registersList 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: