fixup

PaNOSC-ViNYL · Apr 3, 2024 · b80a536 · b80a536
1 parent ce63a91
commit b80a536
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/libpyvinyl/BaseCalculator.py b/libpyvinyl/BaseCalculator.py
@@ -384,6 +384,11 @@ def __call__(self, parameters=None, **kwargs):
         return new
 
     def __hash__(self):
+        """Hashing capability for a Calculator
+        Parameters are removed when calculating the hash.
+        The hash of the parameters can be accessed by hash(calc.parameters).
+        This logic allows to decouple the changes in the calculator from changes in the values of the parameters
+        """
         a = dill.copy(self)
         a.init_parameters()
         return int.from_bytes(hashlib.sha256(dill.dumps(a)).digest(), "big")