Add NumPy benchmarks

Author: kgryte

lib/node_modules/@stdlib/blas/ext/base/dsumpw/benchmark/python/numpy/benchmark.py

@@ -0,0 +1,122 @@
+#!/usr/bin/env python
+#
+# @license Apache-2.0
+#
+# Copyright (c) 2020 The Stdlib Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Benchmark numpy.sum."""
+
+from __future__ import print_function
+import timeit
+
+NAME = "sum"
+REPEATS = 3
+ITERATIONS = 1000000
+COUNT = [0]  # use a list to allow modification within nested scopes
+
+
+def print_version():
+    """Print the TAP version."""
+    print("TAP version 13")
+
+
+def print_summary(total, passing):
+    """Print the benchmark summary.
+
+    # Arguments
+
+    * `total`: total number of tests
+    * `passing`: number of passing tests
+
+    """
+    print("#")
+    print("1.." + str(total))  # TAP plan
+    print("# total " + str(total))
+    print("# pass  " + str(passing))
+    print("#")
+    print("# ok")
+
+
+def print_results(iterations, elapsed):
+    """Print benchmark results.
+
+    # Arguments
+
+    * `iterations`: number of iterations
+    * `elapsed`: elapsed time (in seconds)
+
+    # Examples
+
+    ``` python
+    python> print_results(100000, 0.131009101868)
+    ```
+    """
+    rate = iterations / elapsed
+
+    print("  ---")
+    print("  iterations: " + str(iterations))
+    print("  elapsed: " + str(elapsed))
+    print("  rate: " + str(rate))
+    print("  ...")
+
+
+def benchmark(name, setup, stmt, iterations):
+    """Run the benchmark and print benchmark results.
+
+    # Arguments
+
+    * `name`: benchmark name (suffix)
+    * `setup`: benchmark setup
+    * `stmt`: statement to benchmark
+    * `iterations`: number of iterations
+
+    # Examples
+
+    ``` python
+    python> benchmark("::random", "from random import random;", "y = random()", 1000000)
+    ```
+    """
+    t = timeit.Timer(stmt, setup=setup)
+
+    i = 0
+    while i < REPEATS:
+        print("# python::numpy::" + NAME + name)
+        COUNT[0] += 1
+        elapsed = t.timeit(number=iterations)
+        print_results(iterations, elapsed)
+        print("ok " + str(COUNT[0]) + " benchmark finished")
+        i += 1
+
+
+def main():
+    """Run the benchmarks."""
+    print_version()
+
+    iters = ITERATIONS
+    n = 10
+    while n < 1e7:
+        name = ":len="+str(n)
+        setup = "import numpy as np;"
+        setup += "x = np.random.random([1,"+str(n)+"]);"
+        stmt = "y = np.sum(x);"
+        benchmark(name, setup, stmt, iters)
+        n *= 10
+        iters /= 4
+
+    print_summary(COUNT[0], COUNT[0])
+
+
+if __name__ == "__main__":
+    main()