speed_check.py

"""oct2py speed check."""
# Copyright (c) oct2py developers.
# Distributed under the terms of the MIT License.


import time
import timeit

import numpy as np

from . import Oct2Py, get_log


class SpeedCheck:
    """Checks the speed penalty of the Python to Octave bridge.

    Uses timeit to test the raw execution of a Octave command,
    Then tests progressively larger array passing.

    """

    def __init__(self):
        """Create our Octave instance and initialize the data array"""
        self.octave = Oct2Py()
        self.array = []

    def raw_speed(self):
        """Run a fast Octave command and see how long it takes."""
        self.octave.eval("x = 1")

    def large_array_put(self):
        """Create a large matrix and load it into the octave session."""
        self.octave.push("x", self.array)

    def large_array_get(self):
        """Retrieve the large matrix from the octave session"""
        self.octave.pull("x")

    def run(self):
        """Perform the Oct2Py speed analysis.

        Uses timeit to test the raw execution of an Octave command,
        Then tests progressively larger array passing.

        """
        log = get_log()
        log.info("Oct2Py speed test")
        log.info("*" * 20)
        time.sleep(1)

        log.info("Raw speed: ")
        avg = timeit.timeit(self.raw_speed, number=10) / 10
        log.info(f"    {avg * 1e6:0.01f} usec per loop")
        sides = [1, 10, 100, 1000]
        runs = [10, 10, 10, 5]
        for (side, nruns) in zip(sides, runs):
            self.array = np.reshape(np.arange(side**2), (-1))  # type:ignore
            log.info(f"Put {side}x{side}: ")
            avg = timeit.timeit(self.large_array_put, number=nruns) / nruns
            log.info(f"    {avg * 1e3:0.01f} msec")

            log.info(f"Get {side}x{side}: ")
            avg = timeit.timeit(self.large_array_get, number=nruns) / nruns
            log.info(f"    {avg * 1e3:0.01f} msec")

        self.octave.exit()
        log.info("*" * 20)
        log.info("Test complete!")


def speed_check():
    """Checks the speed penalty of the Python to Octave bridge.

    Uses timeit to test the raw execution of a Octave command,
    Then tests progressively larger array passing.

    """
    test = SpeedCheck()
    test.run()


if __name__ == "__main__":
    speed_check()