Core computation of a node's function to data. More...

#include <operator.h>

Public Types
using	ArgTypes
	set argument types to those of the signature unless:
using	RetType = typename S::RetType
	return type of the operator
template<std::size_t N>
using	NthType = typename S::template NthType<N>
	utility for returning the type of the Nth argument
using	W = typename S::WeightType
	set weight type

Public Member Functions
	Operator ()=default
template<typename T = ArgTypes> requires (is_std_array_v<T> \|\| is_eigen_array_v<T>)
T	get_kids (const Dataset &d, TreeNode &tn, const W **weights=nullptr) const
	get a std::array or eigen array of kids
template<int I>
NthType< I >	get_kid (const Dataset &d, TreeNode &tn, const W **weights) const
	gets one kid for a tuple of kids
template<typename T, size_t ... Is> requires (is_tuple_v<T>)
T	get_kids_seq (const Dataset &d, TreeNode &tn, const W **weights, std::index_sequence< Is... >) const
	Makes and returns a tuple of child outputs.
template<typename T = ArgTypes> requires (is_tuple_v<T>)
T	get_kids (const Dataset &d, TreeNode &tn, const W **weights=nullptr) const
	get a std::tuple of kids. Used when child arguments are different types.
template<typename T = ArgTypes> requires ( is_std_array_v<T> \|\| is_tuple_v<T>)
RetType	apply (const T &inputs) const
	Apply node function in a functional style.
template<typename T = ArgTypes> requires ( is_eigen_array_v<T> && !is_std_array_v<T>)
RetType	apply (const T &inputs) const
	Apply the node function like a function.
template<typename T = ArgTypes, typename Scalar = RetType::Scalar>
RetType	eval (const Dataset &d, TreeNode &tn, const W **weights=nullptr) const
	evaluate the operator on the data. main entry point.
template<typename T = ArgTypes, typename Scalar = RetType::Scalar> requires is_in_v<NT, NodeType::OffsetSum>
RetType	eval (const Dataset &d, TreeNode &tn, const W **weights=nullptr) const

Static Public Attributes
static constexpr size_t	ArgCount = S::ArgCount
	stores the argument count of the operator
static constexpr auto	F
	wrapper function for the node function

Detailed Description

template<NodeType NT, typename S, bool Fit, typename E = void>
struct Brush::Operator< NT, S, Fit, E >

Core computation of a node's function to data.

Template Parameters

S	the signature of the node
NT	node type
Fit	true: fit, false: predict
E	used for node type specialization

Definition at line 90 of file operator.h.

Member Typedef Documentation

◆ ArgTypes

template<NodeType NT, typename S, bool Fit, typename E = void>

using Brush::Operator< NT, S, Fit, E >::ArgTypes

Initial value:

conditional_t<
       ((UnaryOp<NT> || NaryOp<NT>) && S::ArgCount > 1),
       Array<typename S::FirstArg::Scalar, -1, S::ArgCount>,
       typename S::ArgTypes>

set argument types to those of the signature unless:

a) the operator is unary and there are more than one arguments b) the operator is binary and associative

In the case of a) or b), arguments to the operator are stacked into an array and the operator is applied to that array

Definition at line 101 of file operator.h.

◆ NthType

template<NodeType NT, typename S, bool Fit, typename E = void>

template<std::size_t N>

using Brush::Operator< NT, S, Fit, E >::NthType = typename S::template NthType<N>

utility for returning the type of the Nth argument

Definition at line 114 of file operator.h.

◆ RetType

template<NodeType NT, typename S, bool Fit, typename E = void>

using Brush::Operator< NT, S, Fit, E >::RetType = typename S::RetType

return type of the operator

Definition at line 107 of file operator.h.

◆ W

template<NodeType NT, typename S, bool Fit, typename E = void>

using Brush::Operator< NT, S, Fit, E >::W = typename S::WeightType

set weight type

Definition at line 117 of file operator.h.

Constructor & Destructor Documentation

◆ Operator()

template<NodeType NT, typename S, bool Fit, typename E = void>

Brush::Operator< NT, S, Fit, E >::Operator ( )

default

Member Function Documentation

◆ apply() [1/2]

template<NodeType NT, typename S, bool Fit, typename E = void>

template<typename T = ArgTypes>
requires ( is_eigen_array_v<T> && !is_std_array_v<T>)

RetType Brush::Operator< NT, S, Fit, E >::apply ( const T & inputs ) const

inline

Apply the node function like a function.

Template Parameters

T	argument types

Parameters

inputs the child node outputs

Returns: return values applying F to the inputs

Definition at line 220 of file operator.h.

◆ apply() [2/2]

template<NodeType NT, typename S, bool Fit, typename E = void>

template<typename T = ArgTypes>
requires ( is_std_array_v<T> || is_tuple_v<T>)

RetType Brush::Operator< NT, S, Fit, E >::apply ( const T & inputs ) const

inline

Apply node function in a functional style.

Template Parameters

T	argument types

Parameters

inputs the child node outputs

Returns: return values applying F to the inputs

Definition at line 210 of file operator.h.

Here is the caller graph for this function:

◆ eval() [1/2]

template<NodeType NT, typename S, bool Fit, typename E = void>

template<typename T = ArgTypes, typename Scalar = RetType::Scalar>
requires is_in_v<NT, NodeType::OffsetSum>

RetType Brush::Operator< NT, S, Fit, E >::eval	(	const Dataset &	d,
		TreeNode &	tn,
		const W **	weights = nullptr ) const

inline

Definition at line 254 of file operator.h.

Here is the call graph for this function:

◆ eval() [2/2]

template<NodeType NT, typename S, bool Fit, typename E = void>

template<typename T = ArgTypes, typename Scalar = RetType::Scalar>

RetType Brush::Operator< NT, S, Fit, E >::eval	(	const Dataset &	d,
		TreeNode &	tn,
		const W **	weights = nullptr ) const

inline

evaluate the operator on the data. main entry point.

Template Parameters

T	argument types
Scalar	the underlying scalar type of the return type

Parameters

d	dataset
tn	tree node
weights	option pointer to a weight array, used in place of node weight

Returns: output values from applying operator function

Definition at line 233 of file operator.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_kid()

template<NodeType NT, typename S, bool Fit, typename E = void>

template<int I>

NthType< I > Brush::Operator< NT, S, Fit, E >::get_kid	(	const Dataset &	d,
		TreeNode &	tn,
		const W **	weights ) const

inline

gets one kid for a tuple of kids

Definition at line 163 of file operator.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_kids() [1/2]

template<NodeType NT, typename S, bool Fit, typename E = void>

template<typename T = ArgTypes>
requires (is_tuple_v<T>)

T Brush::Operator< NT, S, Fit, E >::get_kids	(	const Dataset &	d,
		TreeNode &	tn,
		const W **	weights = nullptr ) const

inline

get a std::tuple of kids. Used when child arguments are different types.

Template Parameters

T	argument types

Parameters

d	the dataset
tn	the tree node
weights	option pointer to a weight array, used in place of node weight

Returns: a tuple of the child arguments

Definition at line 198 of file operator.h.

◆ get_kids() [2/2]

template<NodeType NT, typename S, bool Fit, typename E = void>

template<typename T = ArgTypes>
requires (is_std_array_v<T> || is_eigen_array_v<T>)

T Brush::Operator< NT, S, Fit, E >::get_kids	(	const Dataset &	d,
		TreeNode &	tn,
		const W **	weights = nullptr ) const

inline

get a std::array or eigen array of kids

Definition at line 131 of file operator.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_kids_seq()

template<NodeType NT, typename S, bool Fit, typename E = void>

template<typename T, size_t ... Is>
requires (is_tuple_v<T>)

T Brush::Operator< NT, S, Fit, E >::get_kids_seq	(	const Dataset &	d,
		TreeNode &	tn,
		const W **	weights,
		std::index_sequence< Is... >	) const

inline

Makes and returns a tuple of child outputs.

Template Parameters

T	a tuple
Is	integer sequence

Parameters

d	dataset
tn	a tree node

Returns: a tuple with elements corresponding to each child node

Definition at line 186 of file operator.h.

Here is the call graph for this function:

Member Data Documentation

◆ ArgCount

template<NodeType NT, typename S, bool Fit, typename E = void>

size_t Brush::Operator< NT, S, Fit, E >::ArgCount = S::ArgCount

staticconstexpr

stores the argument count of the operator

Definition at line 110 of file operator.h.

◆ F

template<NodeType NT, typename S, bool Fit, typename E = void>

auto Brush::Operator< NT, S, Fit, E >::F

staticconstexpr

Initial value:

                        = [](const auto& ...args) { 
    Function<NT> f; 
    return f(args...); 
}

wrapper function for the node function

Definition at line 120 of file operator.h.

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

operator.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ ArgTypes

◆ NthType

◆ RetType

◆ W

Constructor & Destructor Documentation

◆ Operator()

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ eval() [1/2]

◆ eval() [2/2]

◆ get_kid()

◆ get_kids() [1/2]

◆ get_kids() [2/2]

◆ get_kids_seq()

Member Data Documentation

◆ ArgCount

◆ F