aboutsummaryrefslogtreecommitdiff
path: root/beliefs/utils/math_helper.py
diff options
context:
space:
mode:
authorCathy Yeh <cathy@driver.xyz>2017-12-13 18:47:32 -0800
committerCathy Yeh <cathy@driver.xyz>2017-12-14 15:39:52 -0800
commit7053fefc6f9e43b1e252d1f551401a7a70b52e93 (patch)
tree2b232454fbc71f4acc877cbf03f61565bae88b98 /beliefs/utils/math_helper.py
parent10f5c49ea6767f54d59f88eb4064bb4959d14c6b (diff)
downloadbeliefs-7053fefc6f9e43b1e252d1f551401a7a70b52e93.tar.gz
beliefs-7053fefc6f9e43b1e252d1f551401a7a70b52e93.tar.bz2
beliefs-7053fefc6f9e43b1e252d1f551401a7a70b52e93.zip
cleanup print statements, stale comments, minor TODOs
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: