add documentation

This commit is contained in:
Maximilian Keßler 2023-11-04 19:01:43 +01:00
parent bdc5798eed
commit 46263b01a7
Signed by: max
GPG key ID: BCC5A619923C0BA5

View file

@ -4,6 +4,13 @@ using namespace ED;
namespace Edmonds { namespace Edmonds {
/**
* @return List of vertices of the x-r path, where r is the root of the
* special blossom forest component x belongs to.
*
* @note This assumes that the values of μ, φ and ρ represent a special
* blossom forest on the graph when this method is called.
* **/
std::vector<NodeId> path_to_forest_root(Graph const & graph, NodeId id) std::vector<NodeId> path_to_forest_root(Graph const & graph, NodeId id)
{ {
std::vector<NodeId> retval; std::vector<NodeId> retval;