Rename accumulators

Author: henryiii

README.md

@@ -93,10 +93,10 @@ counts = hist.view()
     * `bh.storage.Mean()`: Accepts a sample and computes the mean of the samples (profile). (`.view` not yet supported)
     * `bh.storage.WeightedMean()`: Accepts a sample and a weight. It computes the weighted mean of the samples. (`.view` not yet supported)
 * Accumulators
-    * `bh.accumulator.sum`: High accuracy sum (Neumaier) - used by the sum method when summing a numerical histogram
-    * `bh.accumulator.weighted_sum`: Tracks a weighted sum and variance
-    * `bh.accumulator.weighted_mean`: Tracks a weighted sum, mean, and variance (West's incremental algorithm)
-    * `bh.accumulator.mean`: Running count, mean, and variance (Welfords's incremental algorithm)
+    * `bh.accumulator.Sum`: High accuracy sum (Neumaier) - used by the sum method when summing a numerical histogram
+    * `bh.accumulator.WeightedSum`: Tracks a weighted sum and variance
+    * `bh.accumulator.Mean`: Running count, mean, and variance (Welfords's incremental algorithm)
+    * `bh.accumulator.WeightedMean`: Tracks a weighted sum, mean, and variance (West's incremental algorithm)
 * Histogram operations
     * `h.fill(arr, ..., weight=...)` Fill with N arrays or single values
     * `h.rank`: The number of dimensions

boost_histogram/accumulators.py

@@ -2,4 +2,9 @@
 
 del absolute_import, division, print_function
 
-from ._core.accumulators import sum, mean, weighted_sum, weighted_mean
+from ._core.accumulators import (
+    sum as Sum,
+    mean as Mean,
+    weighted_sum as WeightedSum,
+    weighted_mean as WeightedMean,
+)

boost_histogram/cpp/accumulators.py

@@ -2,4 +2,9 @@
 
 del absolute_import, division, print_function
 
-from ..accumulators import sum, mean, weighted_sum, weighted_mean
+from ..accumulators import (
+    Sum as sum,
+    Mean as mean,
+    WeightedSum as weighted_sum,
+    WeightedMean as weighted_mean,
+)

tests/test_accumulators.py

@@ -6,7 +6,7 @@
 
 
 def test_weighted_sum():
-    a = bh.accumulators.weighted_sum(1.5, 2.5)
+    a = bh.accumulators.WeightedSum(1.5, 2.5)
 
     assert a.value == 1.5
     assert a.variance == 2.5
@@ -19,61 +19,61 @@ def test_weighted_sum():
     vals = [1, 2, 3]
     vari = [4, 5, 6]
 
-    a = bh.accumulators.weighted_sum()
+    a = bh.accumulators.WeightedSum()
     for val, var in zip(vals, vari):
-        a += bh.accumulators.weighted_sum(val, variance=var)
+        a += bh.accumulators.WeightedSum(val, variance=var)
 
     assert a.value == 6
     assert a.variance == 15
 
-    a2 = bh.accumulators.weighted_sum().fill(vals, variance=vari)
+    a2 = bh.accumulators.WeightedSum().fill(vals, variance=vari)
     assert a == a2
 
-    assert a == bh.accumulators.weighted_sum(6, 15)
+    assert a == bh.accumulators.WeightedSum(6, 15)
 
 
 def test_sum():
     vals = [1, 2, 3]
-    a = bh.accumulators.sum()
+    a = bh.accumulators.Sum()
     for val in vals:
         a += val
 
     assert a.value == 6
 
-    a2 = bh.accumulators.sum().fill(vals)
+    a2 = bh.accumulators.Sum().fill(vals)
     assert a == a2
 
-    assert a == bh.accumulators.sum(6)
+    assert a == bh.accumulators.Sum(6)
 
 
 def test_weighted_mean():
     vals = [4, 1]
     weights = [1, 2]
-    a = bh.accumulators.weighted_mean()
+    a = bh.accumulators.WeightedMean()
     for v, w in zip(vals, weights):
         a(v, weight=w)
 
     assert a.sum_of_weights == 3.0
     assert a.variance == 4.5
     assert a.value == 2.0
 
-    a2 = bh.accumulators.weighted_mean().fill(vals, weight=weights)
+    a2 = bh.accumulators.WeightedMean().fill(vals, weight=weights)
     assert a == a2
 
-    assert a == bh.accumulators.weighted_mean(3, 5, 2, 4.5)
+    assert a == bh.accumulators.WeightedMean(3, 5, 2, 4.5)
 
 
 def test_mean():
     vals = [1, 2, 3]
-    a = bh.accumulators.mean()
+    a = bh.accumulators.Mean()
     for val in vals:
         a(val)
 
     assert a.count == 3
     assert a.value == 2
     assert a.variance == 1
 
-    a2 = bh.accumulators.mean().fill([1, 2, 3])
+    a2 = bh.accumulators.Mean().fill([1, 2, 3])
     assert a == a2
 
-    assert a == bh.accumulators.mean(3, 2, 1)
+    assert a == bh.accumulators.Mean(3, 2, 1)

tests/test_pickle.py

@@ -18,10 +18,10 @@
 )
 
 accumulators = (
-    (bh.accumulators.sum, (12,)),
-    (bh.accumulators.weighted_sum, (1.5, 2.5)),
-    (bh.accumulators.mean, (5, 1.5, 2.5)),
-    (bh.accumulators.weighted_mean, (1.5, 2.5, 3.5, 4.5)),
+    (bh.accumulators.Sum, (12,)),
+    (bh.accumulators.WeightedSum, (1.5, 2.5)),
+    (bh.accumulators.Mean, (5, 1.5, 2.5)),
+    (bh.accumulators.WeightedMean, (1.5, 2.5, 3.5, 4.5)),
 )
 
 storages = (

tests/test_public_hist.py

@@ -695,10 +695,10 @@ def ar(*args):
     a.fill(v, weight=w)
     a.fill((0, 1), weight=(2, 3))
 
-    assert a[bh.underflow] == bh.accumulators.weighted_sum(2, 4)
-    assert a[0] == bh.accumulators.weighted_sum(5, 13)
-    assert a[1] == bh.accumulators.weighted_sum(7, 25)
-    assert a[2] == bh.accumulators.weighted_sum(5, 25)
+    assert a[bh.underflow] == bh.accumulators.WeightedSum(2, 4)
+    assert a[0] == bh.accumulators.WeightedSum(5, 13)
+    assert a[1] == bh.accumulators.WeightedSum(7, 25)
+    assert a[2] == bh.accumulators.WeightedSum(5, 25)
 
     assert a[bh.underflow].value == 2
     assert a[0].value == 5