Detailed Description

template<typename L>
class gtsam::AlgebraicDecisionTree< L >

An algebraic decision tree fixes the range of a DecisionTree to double.

Just has some nice constructors and some syntactic sugar. TODO(dellaert): consider eliminating this class altogether?

Inheritance diagram for gtsam::AlgebraicDecisionTree< L >:

Public Member Functions
	AlgebraicDecisionTree (double leaf=1.0)
	AlgebraicDecisionTree (const typename Base::NodePtr root)
	Constructor which accepts root pointer.
	AlgebraicDecisionTree (const Base &add)
	AlgebraicDecisionTree (const L &label, double y1, double y2)
	Create a new leaf function splitting on a variable.
	AlgebraicDecisionTree (const typename Base::LabelC &labelC, double y1, double y2)
	Create a new leaf function splitting on a variable.
	AlgebraicDecisionTree (const std::vector< typename Base::LabelC > &labelCs, const std::vector< double > &ys)
	Create from keys with cardinalities and a vector table.
	AlgebraicDecisionTree (const std::vector< typename Base::LabelC > &labelCs, const std::string &table)
	Create from keys and string table.
template<typename Iterator>
	AlgebraicDecisionTree (Iterator begin, Iterator end, const L &label)
	Create a range of decision trees, splitting on a single variable.
template<typename M>
	AlgebraicDecisionTree (const AlgebraicDecisionTree< M > &other, const std::map< M, L > &map)
	Convert labels from type M to type L.
template<typename X, typename Func>
	AlgebraicDecisionTree (const DecisionTree< L, X > &other, Func f)
	Create from an arbitrary DecisionTree<L, X> by operating on it with a functional f.
AlgebraicDecisionTree	operator+ (const AlgebraicDecisionTree &g) const
	sum
AlgebraicDecisionTree	operator- () const
	negation
AlgebraicDecisionTree	operator- (const AlgebraicDecisionTree &g) const
	subtract
AlgebraicDecisionTree	operator* (const AlgebraicDecisionTree &g) const
	product
AlgebraicDecisionTree	operator/ (const AlgebraicDecisionTree &g) const
	division
double	sum () const
	Compute sum of all values.
AlgebraicDecisionTree	normalize () const
	Helper method to perform normalization such that all leaves in the tree sum to 1.
double	min () const
	Find the minimum values amongst all leaves.
double	max () const
	Find the maximum values amongst all leaves.
AlgebraicDecisionTree	sum (const L &label, size_t cardinality) const
	sum out variable
AlgebraicDecisionTree	sum (const typename Base::LabelC &labelC) const
	sum out variable
void	print (const std::string &s="", const typename Base::LabelFormatter &labelFormatter=&DefaultFormatter) const
	print method customized to value type double.
bool	equals (const AlgebraicDecisionTree &other, double tol=1e-9) const
	Equality method customized to value type double.
Public Member Functions inherited from gtsam::DecisionTree< L, double >
	DecisionTree ()
	Default constructor (for serialization).
	DecisionTree (const double &y)
	Create a constant.
	DecisionTree (const L &label, const double &y1, const double &y2)
	Create tree with 2 assignments y1, y2, splitting on variable label.
	DecisionTree (const LabelC &label, const double &y1, const double &y2)
	Allow Label+Cardinality for convenience.
	DecisionTree (const std::vector< LabelC > &labelCs, const std::vector< double > &ys)
	Create from keys and a corresponding vector of values.
	DecisionTree (const std::vector< LabelC > &labelCs, const std::string &table)
	Create from keys and string table.
	DecisionTree (Iterator begin, Iterator end, const L &label)
	Create DecisionTree from others.
	DecisionTree (const L &label, const DecisionTree &f0, const DecisionTree &f1)
	Create DecisionTree from two others.
	DecisionTree (const Unary &op, DecisionTree &&other) noexcept
	Move constructor for DecisionTree.
	DecisionTree (const DecisionTree< L, X > &other, Func Y_of_X)
	Convert from a different value type.
	DecisionTree (const DecisionTree< M, X > &other, const std::map< M, L > &map, Func Y_of_X)
	Convert from a different value type X to value type Y, also translate labels via map from type M to L.
void	print (const std::string &s, const LabelFormatter &labelFormatter, const ValueFormatter &valueFormatter) const
	GTSAM-style print.
bool	equals (const DecisionTree &other, const CompareFunc &compare=&DefaultCompare) const
virtual	~DecisionTree ()=default
	Make virtual.
bool	empty () const
	Check if tree is empty.
bool	operator== (const DecisionTree &q) const
	equality
const double &	operator() (const Assignment< L > &x) const
	evaluate
void	visit (Func f) const
	Visit all leaves in depth-first fashion.
void	visitLeaf (Func f) const
	Visit all leaves in depth-first fashion.
void	visitWith (Func f) const
	Visit all leaves in depth-first fashion.
size_t	nrLeaves () const
	Return the number of leaves in the tree.
X	fold (Func f, X x0) const
	Fold a binary function over the tree, returning accumulator.
std::set< L >	labels () const
	Retrieve all unique labels as a set.
DecisionTree	apply (const Unary &op) const
	apply Unary operation "op" to f
DecisionTree	apply (const UnaryAssignment &op) const
	Apply Unary operation "op" to f while also providing the corresponding assignment.
DecisionTree	apply (const DecisionTree &g, const Binary &op) const
	apply binary operation "op" to f and g
DecisionTree	choose (const L &label, size_t index) const
	create a new function where value(label)==index It's like "restrict" in Darwiche09book pg329, 330?
DecisionTree	restrict (const Assignment< L > &assignment) const
	Choose multiple values.
DecisionTree	combine (const L &label, size_t cardinality, const Binary &op) const
	combine subtrees on key with binary operation "op"
DecisionTree	combine (const LabelC &labelC, const Binary &op) const
	combine with LabelC for convenience
void	dot (std::ostream &os, const LabelFormatter &labelFormatter, const ValueFormatter &valueFormatter, bool showZero=true) const
	output to graphviz format, stream version
void	dot (const std::string &name, const LabelFormatter &labelFormatter, const ValueFormatter &valueFormatter, bool showZero=true) const
	output to graphviz format, open a file
std::string	dot (const LabelFormatter &labelFormatter, const ValueFormatter &valueFormatter, bool showZero=true) const
	output to graphviz format string
std::pair< DecisionTree< L, A >, DecisionTree< L, B > >	split (std::function< std::pair< A, B >(const double &)> AB_of_Y) const
	Convert into two trees with value types A and B.
	DecisionTree (const NodePtr &root)

Public Types
using	Base = DecisionTree<L, double>
Public Types inherited from gtsam::DecisionTree< L, double >
using	LabelFormatter
using	ValueFormatter
using	CompareFunc
using	Unary
	Handy typedefs for unary and binary function types.
using	UnaryAssignment
using	Binary
using	LabelC
	A label annotated with cardinality.
using	NodePtr
	---------------------— Node base class ------------------------—

Additional Inherited Members
static NodePtr	compose (Iterator begin, Iterator end, const L &label)
Public Attributes inherited from gtsam::DecisionTree< L, double >
NodePtr	root_
	A DecisionTree just contains the root. TODO(dellaert): make protected.
Static Protected Member Functions inherited from gtsam::DecisionTree< L, double >
static bool	DefaultCompare (const double &a, const double &b)
	Default method for comparison of two objects of type Y.
static NodePtr	build (It begin, It end, ValueIt beginY, ValueIt endY)
	Internal recursive function to create from keys, cardinalities, and Y values.
static NodePtr	create (It begin, It end, ValueIt beginY, ValueIt endY)
	Internal helper function to create a tree from keys, cardinalities, and Y values.
static NodePtr	convertFrom (const typename DecisionTree< L, X >::NodePtr &f, std::function< double(const X &)> Y_of_X)
	Convert from a DecisionTree<L, X> to DecisionTree<L, Y>.
static NodePtr	convertFrom (const typename DecisionTree< M, X >::NodePtr &f, std::function< L(const M &)> L_of_M, std::function< double(const X &)> Y_of_X)
	Convert from a DecisionTree<M, X> to DecisionTree<L, Y>.

Constructor & Destructor Documentation

◆ AlgebraicDecisionTree() [1/6]

template<typename L>

gtsam::AlgebraicDecisionTree< L >::AlgebraicDecisionTree	(	const typename Base::LabelC &	labelC,
		double	y1,
		double	y2 )

inline

Create a new leaf function splitting on a variable.

Parameters

labelC	The label with cardinality 2
y1	The value for the first key
y2	The value for the second key

Example:

std::pair<string, size_t> A {"a", 2};

AlgebraicDecisionTree<string> a(A, 0.6, 0.4);

gtsam::AlgebraicDecisionTree

An algebraic decision tree fixes the range of a DecisionTree to double.

Definition AlgebraicDecisionTree.h:41

◆ AlgebraicDecisionTree() [2/6]

template<typename L>

gtsam::AlgebraicDecisionTree< L >::AlgebraicDecisionTree	(	const std::vector< typename Base::LabelC > &	labelCs,
		const std::vector< double > &	ys )

inline

Create from keys with cardinalities and a vector table.

Parameters

labelCs	The keys, with cardinalities, given as pairs
ys	The vector table

Example with three keys, A, B, and C, with cardinalities 2, 3, and 2, respectively, and a vector table of size 12:

DiscreteKey A(0, 2), B(1, 3), C(2, 2);
const vector<double> cpt{
  1.0 / 3, 2.0 / 3, 3.0 / 7, 4.0 / 7, 5.0 / 11, 6.0 / 11,  //
  1.0 / 9, 8.0 / 9, 3.0 / 6, 3.0 / 6, 5.0 / 10, 5.0 / 10};
AlgebraicDecisionTree<Key> expected(A & B & C, cpt);

The table is given in the following order: A=0, B=0, C=0 A=0, B=0, C=1 ... A=1, B=1, C=1 Hence, the first line in the table is for A==0, and the second for A==1. In each line, the first two entries are for B==0, the next two for B==1, and the last two for B==2. Each pair is for a C value of 0 and 1.

◆ AlgebraicDecisionTree() [3/6]

template<typename L>

gtsam::AlgebraicDecisionTree< L >::AlgebraicDecisionTree	(	const std::vector< typename Base::LabelC > &	labelCs,
		const std::string &	table )

inline

Create from keys and string table.

Parameters

labelCs	The keys, with cardinalities, given as pairs
table	The string table, given as a string of doubles.

Note: Table needs to be in same order as the vector table in the other constructor.

◆ AlgebraicDecisionTree() [4/6]

template<typename L>

template<typename Iterator>

gtsam::AlgebraicDecisionTree< L >::AlgebraicDecisionTree	(	Iterator	begin,
		Iterator	end,
		const L &	label )

inline

Create a range of decision trees, splitting on a single variable.

Parameters

begin	Iterator to beginning of a range of decision trees
end	Iterator to end of a range of decision trees
label	The label to split on

◆ AlgebraicDecisionTree() [5/6]

template<typename L>

template<typename M>

gtsam::AlgebraicDecisionTree< L >::AlgebraicDecisionTree	(	const AlgebraicDecisionTree< M > &	other,
		const std::map< M, L > &	map )

inline

Convert labels from type M to type L.

Parameters

other	The AlgebraicDecisionTree with label type M to convert.
map	Map from label type M to label type L.

◆ AlgebraicDecisionTree() [6/6]

template<typename L>

template<typename X, typename Func>

gtsam::AlgebraicDecisionTree< L >::AlgebraicDecisionTree	(	const DecisionTree< L, X > &	other,
		Func	f )

inline

Create from an arbitrary DecisionTree<L, X> by operating on it with a functional f.

Template Parameters

X	The type of the leaf of the original DecisionTree
Func	Type signature of functional f.

Parameters

other	The original DecisionTree from which the AlgbraicDecisionTree is constructed.
f	Functional used to operate on the leaves of the input DecisionTree.

Member Function Documentation

◆ normalize()

template<typename L>

AlgebraicDecisionTree gtsam::AlgebraicDecisionTree< L >::normalize ( ) const

inline

Helper method to perform normalization such that all leaves in the tree sum to 1.

Returns: AlgebraicDecisionTree

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

/tmp/gtsam-4.3.0-doxygen.rsXPUS/source/gtsam/discrete/AlgebraicDecisionTree.h

Detailed Description

Public Member Functions

Public Types

Additional Inherited Members

Constructor & Destructor Documentation

◆ AlgebraicDecisionTree() [1/6]

◆ AlgebraicDecisionTree() [2/6]

◆ AlgebraicDecisionTree() [3/6]

◆ AlgebraicDecisionTree() [4/6]

◆ AlgebraicDecisionTree() [5/6]

◆ AlgebraicDecisionTree() [6/6]

Member Function Documentation

◆ normalize()