From 086aba2a69f5793933a4f4754f3d92256c8da165 Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Tue, 6 Feb 2024 12:32:23 +0100
Subject: [PATCH] Add documentation to TransitionMatrix comparison operator
---
src/include/TransitionMatrix.h | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/src/include/TransitionMatrix.h b/src/include/TransitionMatrix.h
index 853c3be8..9180faba 100644
--- a/src/include/TransitionMatrix.h
+++ b/src/include/TransitionMatrix.h
@@ -161,6 +161,17 @@ class TransitionMatrix {
* (default is "LEGACY").
*/
void write_binary(std::string file_name, std::string mode="LEGACY");
+
+ /*! \brief Test whether two instances of TransitionMatrix are equal.
+ *
+ * Transition matrixes can be the result of a calculation or of a file input operation,
+ * reading from a previously computed object. The `==` operator tests for the equivalence
+ * of two transition matrixes, returning `true` if they are equivalnet, `false` otherwise.
+ *
+ * \param other: `TransitionMatrix &` Reference to the instance to be compared with.
+ * \return result: `bool` True, if the two instances are equal, false otherwise.
+ */
+ bool operator ==(TransitionMatrix &other);
};
#endif
--
GitLab