updated docs to better describe nrAssignments

release/4.3a0
Varun Agrawal 2023-03-29 18:40:53 -04:00
parent 6aa7d667f3
commit 1818695664
1 changed files with 20 additions and 0 deletions

View File

@ -303,6 +303,26 @@ namespace gtsam {
* @brief Return the number of total leaf assignments. * @brief Return the number of total leaf assignments.
* This includes counts removed from implicit pruning hence, * This includes counts removed from implicit pruning hence,
* it will always be >= nrLeaves(). * it will always be >= nrLeaves().
*
* E.g. we have a decision tree as below, where each node has 2 branches:
*
* Choice(m1)
* 0 Choice(m0)
* 0 0 Leaf 0.0
* 0 1 Leaf 0.0
* 1 Choice(m0)
* 1 0 Leaf 1.0
* 1 1 Leaf 2.0
*
* In the unpruned form, the tree will have 4 assignments, 2 for each key, and 4 leaves.
*
* In the pruned form, the number of assignments is still 4 but the number of leaves is now 3, as below:
*
* Choice(m1)
* 0 Leaf 0.0
* 1 Choice(m0)
* 1 0 Leaf 1.0
* 1 1 Leaf 2.0
* *
* @return size_t * @return size_t
*/ */