From 0a51e26fb3d90883caab16e1c42e0d37df184321 Mon Sep 17 00:00:00 2001
From: thibault allenet <thibault.allenet@cea.fr>
Date: Wed, 2 Aug 2023 13:39:56 +0000
Subject: [PATCH] Match python API doc
---
python_binding/graphmatching/pybind_Match.cpp | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/python_binding/graphmatching/pybind_Match.cpp b/python_binding/graphmatching/pybind_Match.cpp
index c36ca381f..600d39208 100644
--- a/python_binding/graphmatching/pybind_Match.cpp
+++ b/python_binding/graphmatching/pybind_Match.cpp
@@ -16,10 +16,16 @@
namespace py = pybind11;
namespace Aidge {
void init_Match(py::module& m){
- py::class_<Match, std::shared_ptr<Match>>(m, "Match")
+ py::class_<Match, std::shared_ptr<Match>>(m, "Match", "Match class stores the matched patterns resulting from a graph matching query. A matched pattern is the combinaison of the graph pattern start nodes and the set of all the nodes in the matched pattern (including the start nodes)")
.def(py::init<>())
- .def("get_nb_match", &Match::getNbMatch)
- .def("get_start_nodes", &Match::getStartNodes)
- .def("get_match_nodes", &Match::getMatchNodes);
+ .def("get_nb_match", &Match::getNbMatch, R"mydelimiter(
+ The number of graph patterns matched
+ )mydelimiter")
+ .def("get_start_nodes", &Match::getStartNodes, R"mydelimiter(
+ All matched graph patterns start nodes
+ )mydelimiter")
+ .def("get_match_nodes", &Match::getMatchNodes, R"mydelimiter(
+ All matched graph patterns sets of matched nodes
+ )mydelimiter");
}
}
--
GitLab