computils 0.0.2__tar.gz → 0.0.3__tar.gz

{computils-0.0.2 → computils-0.0.3}/PKG-INFO

@@ -1,15 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: computils
-Version: 0.0.2
+Version: 0.0.3
 Summary: A package collecting functionality for various numerical computations (numerical differentiation, interpolation, optimization, sorting, parallelization).
-Author-email: Karim Moussa <research@k-moussa.com>
+Author-email: Karim Moussa <k.moussa.science@proton.me>
 Project-URL: Homepage, https://github.com/k-moussa/computils
+Project-URL: Repository, https://github.com/k-moussa/computils
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: scipy>=1.13.0
+Requires-Dist: numba>=0.59.1
+Requires-Dist: splines>=0.3.1
+Requires-Dist: psutil>=5.9.0
+Dynamic: license-file
 
 # computils
 A package collecting utilities and other convenient functionality for various numerical computations:

{computils-0.0.2 → computils-0.0.3}/pyproject.toml

@@ -1,24 +1,25 @@
 [build-system]
-requires = [
-"setuptools>=61.0",
-"numpy >= 1.26.4",
-"scipy >= 1.13.0",
-"numba >= 0.59.1",
-"splines >= 0.3.1",
-"psutil>=5.9.0",
-]
+requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "computils"
-version = "0.0.2"
+version = "0.0.3"
 authors = [
-  { name="Karim Moussa", email="research@k-moussa.com" },
+  { name="Karim Moussa", email="k.moussa.science@proton.me" },
 ]
 description = "A package collecting functionality for various numerical computations (numerical differentiation, interpolation, optimization, sorting, parallelization)."
 readme = "README.md"
 requires-python = ">=3.7"
 
+dependencies = [
+"numpy >= 1.26.4",
+"scipy >= 1.13.0",
+"numba >= 0.59.1",
+"splines >= 0.3.1",
+"psutil>=5.9.0",
+]
+
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: MIT License",
@@ -27,4 +28,9 @@ classifiers = [
 
 [project.urls]
 Homepage = "https://github.com/k-moussa/computils"
+Repository = "https://github.com/k-moussa/computils"
 # Issues = "https://github.com/pypa/sampleproject/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["computils*"]

{computils-0.0.2 → computils-0.0.3}/src/computils/globals.py

@@ -11,8 +11,8 @@ CUBE_ROOT_MACHINE_EPS: final = np.cbrt(MACHINE_EPS)  #:
 FOURTH_ROOT_MACHINE_EPS: final = np.power(MACHINE_EPS, 1/4)  #:
 
 Integer: final = Union[int, np.int8, np.int16, np.int32, np.int64, np.uint8, np.uint16, np.uint32, np.uint64]  #:
-Float: final = Union[float, np.float16, np.float32, np.float64, np.float128]  #:
-Complex: final = Union[complex, np.complex64, np.complex128, np.complex256]  #:
+Float: final = Union[float, np.float16, np.float32, np.float64]  #:
+Complex: final = Union[complex, np.complex64, np.complex128]  #:
 Scalar: final = Union[Integer, Float, Complex]  #:
 Bool: final = Union[bool, np.bool_]
 

{computils-0.0.2 → computils-0.0.3}/src/computils.egg-info/PKG-INFO

@@ -1,15 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: computils
-Version: 0.0.2
+Version: 0.0.3
 Summary: A package collecting functionality for various numerical computations (numerical differentiation, interpolation, optimization, sorting, parallelization).
-Author-email: Karim Moussa <research@k-moussa.com>
+Author-email: Karim Moussa <k.moussa.science@proton.me>
 Project-URL: Homepage, https://github.com/k-moussa/computils
+Project-URL: Repository, https://github.com/k-moussa/computils
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: scipy>=1.13.0
+Requires-Dist: numba>=0.59.1
+Requires-Dist: splines>=0.3.1
+Requires-Dist: psutil>=5.9.0
+Dynamic: license-file
 
 # computils
 A package collecting utilities and other convenient functionality for various numerical computations:

{computils-0.0.2 → computils-0.0.3}/src/computils.egg-info/SOURCES.txt

@@ -17,8 +17,5 @@ src/computils/type_utils.py
 src/computils.egg-info/PKG-INFO
 src/computils.egg-info/SOURCES.txt
 src/computils.egg-info/dependency_links.txt
-src/computils.egg-info/top_level.txt
-src/tests/matrix_computations_tests.py
-src/tests/numerical_derivatives_tests.py
-src/tests/parameter_transformation_tests.py
-src/tests/test_utils.py
+src/computils.egg-info/requires.txt
+src/computils.egg-info/top_level.txt

computils-0.0.3/src/computils.egg-info/requires.txt

@@ -0,0 +1,5 @@
+numpy>=1.26.4
+scipy>=1.13.0
+numba>=0.59.1
+splines>=0.3.1
+psutil>=5.9.0

{computils-0.0.2 → computils-0.0.3}/src/computils.egg-info/top_level.txt

@@ -1,2 +1 @@
 computils
-tests

computils-0.0.2/src/tests/matrix_computations_tests.py

@@ -1,25 +0,0 @@
-""" This module tests functionality related to matrix computations. """
-
-import unittest
-import numpy as np
-from numpy.linalg import inv
-from scipy.stats import wishart
-from test_utils import compute_max_abs_diff
-from computils import SEED128_1
-from computils.gaussian_elim_spp import compute_inverse_using_gauss_elim_spp
-
-
-class MatrixComputationsTests(unittest.TestCase):
-
-    def test_inverse_gauss_elim_spp(self):
-        rng = np.random.default_rng(SEED128_1)
-        n = 50
-        df = n + 1.0
-        scale_matrix = np.eye(n)
-
-        for i in range(100):
-            matrix = wishart.rvs(df=df, scale=scale_matrix, random_state=rng)
-            inverse_matrix = inv(matrix)
-            inverse_matrix_gespp = compute_inverse_using_gauss_elim_spp(matrix)
-            max_diff = compute_max_abs_diff(inverse_matrix, inverse_matrix_gespp)
-            self.assertAlmostEqual(0.0, max_diff, delta=10**-8)

computils-0.0.2/src/tests/numerical_derivatives_tests.py

@@ -1,129 +0,0 @@
-""" This module tests the computation of numerical derivatives. """
-
-import unittest
-import numpy as np
-from computils.finite_difference import compute_gradient, compute_jacobian, compute_hessian
-
-
-def func_r2_to_r3(x: np.ndarray, scaling_factor: float = 1.0) -> np.ndarray:
-    """ A test function f: R^2 -> R^3
-
-    :param x: a (2,) np array of argument values.
-    :param scaling_factor: real number (nonzero).
-    :return: a (3,) array containing the function values
-    """
-
-    function_values = np.zeros((3,))
-    function_values[0] = 2.0 * x[0]
-    function_values[1] = func_r2_to_r(x)
-    function_values[2] = -3.0 * x[1]
-    
-    return scaling_factor * function_values
-
-
-def analytical_jacobian_test_func_r2_to_r3(x: np.ndarray) -> np.ndarray:
-    """ Analytical Jacobian of the test function f: R^2 -> R^3
-
-    :param x: a (2,) np array of argument values.
-    :return: jacobian: a (3, 2) array of first-order derivatives.
-    """
-    
-    jacobian = np.zeros((3, 2))
-    jacobian[0, 0] = 2.0
-    jacobian[1, :] = analytical_gradient_test_func_r2_to_r(x).flatten()
-    jacobian[2, 1] = -3.0
-    return jacobian
-
-
-def func_r2_to_r(x: np.ndarray, scaling_factor: float = 1.0) -> float:
-    """ A test function f: R^2 -> R
-
-    :param x: a (2,) array of argument values.
-    :param scaling_factor: real number (nonzero).
-    :return: the function value (scalar).
-    """
-
-    return scaling_factor * (2.0 * x[0] ** 2 + 4.0 * x[1] ** 3 + 6.0 * x[0] * x[1])
-
-
-def analytical_gradient_test_func_r2_to_r(x: np.ndarray) -> np.ndarray:
-    """ Analytical gradient of the test function f: R^2 -> R
-
-    :param x: a (2,) array of argument values.
-    :return: gradient: a (2, 1) np array of first-order derivatives.
-    """
-
-    gradient = np.zeros((2, 1))
-    gradient[0, 0] = 4.0 * x[0] + 6.0 * x[1]
-    gradient[1, 0] = 12.0 * x[1] ** 2 + 6.0 * x[0]
-    return gradient
-
-
-def analytical_hessian_test_func_r2_to_r(x: np.ndarray) -> np.ndarray:
-    """ Analytical hessian of the test function f: R^2 -> R
-
-    :param x: a (2,) array of argument values.
-    :return: hessian: a (2, 1) np array of first-order derivatives.
-    """
-
-    hessian = np.zeros((2, 2))
-    hessian[0, 0] = 4.0
-    hessian[0, 1] = hessian[1, 0] = 6.0
-    hessian[1, 1] = 24.0 * x[1]
-    return hessian
-
-
-class FiniteDifferenceTests(unittest.TestCase):
-    @classmethod
-    def setUpClass(cls):
-        cls.x_values = [n * np.array([0.5, 1.0]) for n in range(-1, 10)]
-        cls.scaling_factor = 0.9
-
-    def test_gradient(self):
-        for x in self.x_values:
-            for include_args in (True, False):
-                analytical_gradient = analytical_gradient_test_func_r2_to_r(x)
-
-                if include_args:
-                    analytical_gradient *= self.scaling_factor
-                    numerical_gradient = compute_gradient(func_r2_to_r, x, args=(self.scaling_factor,))
-                else:
-                    numerical_gradient = compute_gradient(func_r2_to_r, x)
-
-                diffs = numerical_gradient - analytical_gradient
-                max_diff = np.amax(np.abs(diffs))
-                self.assertAlmostEqual(0.0, max_diff, delta=10**-8)
-
-    def test_jacobian(self):
-        for x in self.x_values:
-            for include_args in (True, False):
-                analytical_jacobian = analytical_jacobian_test_func_r2_to_r3(x)
-
-                if include_args:
-                    analytical_jacobian *= self.scaling_factor
-                    numerical_jacobian = compute_jacobian(func_r2_to_r3, x, args=(self.scaling_factor,))
-                else:
-                    numerical_jacobian = compute_jacobian(func_r2_to_r3, x)
-
-                diffs = numerical_jacobian - analytical_jacobian
-                max_diff = np.amax(np.abs(diffs))
-                self.assertAlmostEqual(0.0, max_diff, delta=10**-8)
-
-    def test_hessian(self):
-        for x in self.x_values:
-            for include_args in (True, False):
-                analytical_hessian = analytical_hessian_test_func_r2_to_r(x)
-
-                if include_args:
-                    analytical_hessian *= self.scaling_factor
-                    numerical_hessian = compute_hessian(func_r2_to_r, x, args=(self.scaling_factor,))
-                else:
-                    numerical_hessian = compute_hessian(func_r2_to_r, x)
-
-                diffs = numerical_hessian - analytical_hessian
-                max_diff = np.amax(np.abs(diffs))
-                self.assertAlmostEqual(0.0, max_diff, delta=10**-6)
-
-
-if __name__ == '__main__':
-    unittest.main()

computils-0.0.2/src/tests/parameter_transformation_tests.py

@@ -1,122 +0,0 @@
-""" This module implements tests for the parameter transformation functions. """
-
-import unittest
-import numpy as np
-import computils.parameter_transformations as pt
-
-
-class ParameterTransformationTests(unittest.TestCase):
-    def test_impose_lower_bound(self):
-        n_values = 100
-        lower_bounds = np.linspace(start=-10.0, stop=10.0, num=n_values)
-
-        for lower_bound in lower_bounds:
-            expected_value = 1.0 + lower_bound
-            actual_value = pt.impose_lower_bound(transformed_parameter=0.0, lower_bound=lower_bound)
-
-            self.assertAlmostEqual(expected_value, actual_value, delta=10 ** (-10))
-
-    def test_consistency_lower_bound_transformations(self):
-        """ Tests consistency of the lower bound transformations by checking whether their
-            composition yields the identity function. """
-
-        n_values = 100
-        lower_bounds = np.linspace(start=-10.0, stop=10.0, num=n_values)
-        transformed_values = np.linspace(start=-10.0, stop=10.0, num=n_values)
-
-        for lower_bound in lower_bounds:
-            for value in transformed_values:
-                actual_value = pt.inverse_impose_lower_bound(
-                    pt.impose_lower_bound(value, lower_bound), lower_bound)
-
-                self.assertAlmostEqual(value, actual_value, delta=10 ** (-10))
-
-    def test_impose_upper_bound(self):
-        n_values = 100
-        upper_bounds = np.linspace(start=-10.0, stop=10.0, num=n_values)
-
-        for upper_bound in upper_bounds:
-            expected_value = -1.0 + upper_bound
-            actual_value = pt.impose_upper_bound(transformed_parameter=0.0, upper_bound=upper_bound)
-
-            self.assertAlmostEqual(expected_value, actual_value, delta=10 ** (-10))
-
-    def test_consistency_upper_bound_transformations(self):
-        """ Tests consistency of the upper bound transformations by checking whether their
-            composition yields the identity function. """
-
-        n_values = 100
-        upper_bounds = np.linspace(start=-10.0, stop=10.0, num=n_values)
-        transformed_values = np.linspace(start=-10.0, stop=10.0, num=n_values)
-
-        for upper_bound in upper_bounds:
-            for value in transformed_values:
-                actual_value = pt.inverse_impose_upper_bound(
-                    pt.impose_upper_bound(value, upper_bound), upper_bound)
-
-                self.assertAlmostEqual(value, actual_value, delta=10 ** (-10))
-
-    def test_impose_bounds(self):
-        n_values = 100
-        lower_bounds = np.linspace(start=-10.0, stop=10.0, num=n_values)
-        upper_bounds = np.linspace(start=-10.0, stop=10.0, num=n_values)
-
-        for lower_bound in lower_bounds:
-            for upper_bound in upper_bounds:
-                expected_value = (lower_bound + upper_bound) / 2.0
-                actual_value = pt.impose_bounds(
-                    transformed_parameter=0.0, lower_bound=lower_bound, upper_bound=upper_bound)
-
-                self.assertAlmostEqual(expected_value, actual_value, delta=10 ** (-10))
-
-    def test_consistency_bounds_transformations(self):
-        """ Tests consistency of the double bound transformations by checking whether their
-            composition yields the identity function. """
-
-        n_values = 100
-        lower_bounds = np.linspace(start=-10.0, stop=10.0, num=n_values)
-        transformed_values = np.linspace(start=-10.0, stop=10.0, num=n_values)
-
-        for lower_bound in lower_bounds:
-            upper_bound = lower_bound + 1.0
-
-            for value in transformed_values:
-                actual_value = pt.inverse_impose_bounds(
-                    pt.impose_bounds(value, lower_bound, upper_bound), lower_bound, upper_bound)
-
-                self.assertAlmostEqual(value, actual_value, delta=10 ** (-10))
-
-    def test_impose_upper_bound_sum(self):
-        n_params = 3
-        transformed_params = np.zeros((n_params,))
-        n_values = 100
-        upper_bounds = np.linspace(start=-10.0, stop=10.0, num=n_values)
-
-        for upper_bound in upper_bounds:
-            expected_param_value = upper_bound / (n_params + 1.0)
-            actual_params = pt.impose_upper_bound_sum(transformed_params=transformed_params, upper_bound=upper_bound)
-
-            for param in actual_params:
-                self.assertAlmostEqual(expected_param_value, param, delta=10 ** (-10))
-
-    def test_consistency_upper_bound_sum_transformations(self):
-        """ Tests consistency of the upper bound sum transformations by checking whether their
-            composition yields the identity function. """
-
-        n_values = 100
-        upper_bounds = np.linspace(start=-10.0, stop=10.0, num=n_values)
-        transformed_values = np.random.normal(size=(n_values, 2))
-
-        for upper_bound in upper_bounds:
-            for i in range(n_values):
-                transformed_params = transformed_values[i]
-                result = pt.inverse_impose_upper_bound_sum(
-                    pt.impose_upper_bound_sum(transformed_params, upper_bound), upper_bound)
-
-                diffs = result - transformed_params
-                max_abs_diff = np.amax(np.abs(diffs))
-                self.assertAlmostEqual(0.0, max_abs_diff, delta=10 ** (-10))
-
-
-if __name__ == '__main__':
-    unittest.main()

computils-0.0.2/src/tests/test_utils.py

@@ -1,12 +0,0 @@
-"This module collects functionality for testing. "
-
-import numpy as np
-from computils import FloatOrArray
-
-
-def compute_max_abs_diff(expected: np.ndarray, actual: np.ndarray) -> float:
-    return float(np.amax(compute_abs_diff(expected, actual)))
-
-
-def compute_abs_diff(expected: FloatOrArray, actual: FloatOrArray) -> FloatOrArray:
-    return np.abs(actual - expected)