aboutsummaryrefslogtreecommitdiff
path: root/beliefs/utils/math_helper.py
diff options
context:
space:
mode:
Diffstat (limited to 'beliefs/utils/math_helper.py')
-rw-r--r--beliefs/utils/math_helper.py14
1 files changed, 10 insertions, 4 deletions
diff --git a/beliefs/utils/math_helper.py b/beliefs/utils/math_helper.py
index a25ea68..12325e1 100644
--- a/beliefs/utils/math_helper.py
+++ b/beliefs/utils/math_helper.py
@@ -1,10 +1,16 @@
-"""Random math utils."""
+"""Math utils"""
def is_kronecker_delta(vector):
- """Returns True if vector is a kronecker delta vector, False otherwise.
- Specific evidence ('YES' or 'NO') is a kronecker delta vector, whereas
- virtual evidence ('MAYBE') is not.
+ """
+ Check if vector is a kronecker delta.
+
+ Args:
+ vector: iterable of numbers
+ Returns:
+ bool, True if vector is a kronecker delta vector, False otherwise.
+ In belief propagation, specific evidence (variable is directly observed)
+ is a kronecker delta vector, but virtual evidence is not.
"""
count = 0
for x in vector: