C++ sat_count_double(): Document vars param

OxiDD · Apr 30, 2024 · b8a2292 · b8a2292
1 parent 67f8838
commit b8a2292
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/bindings/cpp/include/oxidd/bcdd.hpp b/bindings/cpp/include/oxidd/bcdd.hpp
@@ -556,10 +556,15 @@ class bcdd_function {
 
   /// Count the number of satisfying assignments
   ///
+  /// This method assumes that the function's domain of has `vars` many
+  /// variables.
+  ///
   /// `this` must not be invalid (check via is_invalid()).
   ///
   /// Locking behavior: acquires the manager's lock for shared access.
   ///
+  /// @param  vars  Number of variables in the function's domain
+  ///
   /// @returns  Count of satisfying assignments
   [[nodiscard]] double sat_count_double(level_no_t vars) const noexcept {
     assert(_func._p);

diff --git a/bindings/cpp/include/oxidd/bdd.hpp b/bindings/cpp/include/oxidd/bdd.hpp
@@ -554,10 +554,15 @@ class bdd_function {
 
   /// Count the number of satisfying assignments
   ///
+  /// This method assumes that the function's domain of has `vars` many
+  /// variables.
+  ///
   /// `this` must not be invalid (check via is_invalid()).
   ///
   /// Locking behavior: acquires the manager's lock for shared access.
   ///
+  /// @param  vars  Number of variables in the function's domain
+  ///
   /// @returns  Count of satisfying assignments
   [[nodiscard]] double sat_count_double(level_no_t vars) const noexcept {
     assert(_func._p);

diff --git a/bindings/cpp/include/oxidd/zbdd.hpp b/bindings/cpp/include/oxidd/zbdd.hpp
@@ -592,10 +592,15 @@ class zbdd_function {
 
   /// Count the number of satisfying assignments
   ///
+  /// This method assumes that the function's domain of has `vars` many
+  /// variables.
+  ///
   /// `this` must not be invalid (check via is_invalid()).
   ///
   /// Locking behavior: acquires the manager's lock for shared access.
   ///
+  /// @param  vars  Number of variables in the function's domain
+  ///
   /// @returns  Count of satisfying assignments
   [[nodiscard]] double sat_count_double(level_no_t vars) const noexcept {
     assert(_func._p);