add docstring for makeBinaryOrdering

release/4.3a0
Varun Agrawal 2022-06-09 20:11:30 -04:00
parent 622ebdd13b
commit 09d512ae48
1 changed files with 4 additions and 1 deletions

View File

@ -173,7 +173,10 @@ inline HybridGaussianFactorGraph::shared_ptr makeSwitchingChain(
}
/**
* @brief
* @brief Return the ordering as a binary tree such that all parent nodes are
* above their children.
*
* This will result in a nested dissection Bayes tree after elimination.
*
* @param input The original ordering.
* @return std::pair<KeyVector, std::vector<int>>