Refactor imports from math

adtzlr · Feb 28, 2024 · 35d172f · 35d172f
1 parent 97e00e3
commit 35d172f
Show file tree

Hide file tree

Showing 14 changed files with 58 additions and 127 deletions.
diff --git a/src/tensortrax/__about__.py b/src/tensortrax/__about__.py
@@ -2,4 +2,4 @@
 tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
 """
 
-__version__ = "0.17.1"
+__version__ = "0.18.0"
diff --git a/src/tensortrax/_evaluate.py b/src/tensortrax/_evaluate.py
@@ -1,11 +1,5 @@
-r"""
- _
-| |                          ████████╗██████╗  █████╗ ██╗  ██╗
-| |_ ___ _ __  ___  ___  _ __╚══██╔══╝██╔══██╗██╔══██╗╚██╗██╔╝
-| __/ _ \ '_ \/ __|/ _ \| '__|  ██║   ██████╔╝███████║ ╚███╔╝
-| ||  __/ | | \__ \ (_) | |     ██║   ██╔══██╗██╔══██║ ██╔██╗
- \__\___|_| |_|___/\___/|_|     ██║   ██║  ██║██║  ██║██╔╝ ██╗
-                                ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝
+"""
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
 """
 
 from copy import copy
@@ -15,7 +9,7 @@
 from joblib import Parallel, cpu_count, delayed
 
 from ._tensor import Tensor, Δδ, broadcast_to, f, δ
-from .math._special import from_triu_1d, from_triu_2d, triu_1d
+from .math.special import from_triu_1d, from_triu_2d, triu_1d
 
 
 def take(fun, item=0):

diff --git a/src/tensortrax/_helpers.py b/src/tensortrax/_helpers.py
@@ -1,11 +1,5 @@
-r"""
- _
-| |                          ████████╗██████╗  █████╗ ██╗  ██╗
-| |_ ___ _ __  ___  ___  _ __╚══██╔══╝██╔══██╗██╔══██╗╚██╗██╔╝
-| __/ _ \ '_ \/ __|/ _ \| '__|  ██║   ██████╔╝███████║ ╚███╔╝
-| ||  __/ | | \__ \ (_) | |     ██║   ██╔══██╗██╔══██║ ██╔██╗
- \__\___|_| |_|___/\___/|_|     ██║   ██║  ██║██║  ██║██╔╝ ██╗
-                                ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝
+"""
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
 """
 
 

diff --git a/src/tensortrax/_tensor.py b/src/tensortrax/_tensor.py
@@ -1,11 +1,5 @@
-r"""
- _
-| |                          ████████╗██████╗  █████╗ ██╗  ██╗
-| |_ ___ _ __  ___  ___  _ __╚══██╔══╝██╔══██╗██╔══██╗╚██╗██╔╝
-| __/ _ \ '_ \/ __|/ _ \| '__|  ██║   ██████╔╝███████║ ╚███╔╝
-| ||  __/ | | \__ \ (_) | |     ██║   ██╔══██╗██╔══██║ ██╔██╗
- \__\___|_| |_|___/\___/|_|     ██║   ██║  ██║██║  ██║██╔╝ ██╗
-                                ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝
+"""
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
 """
 
 from copy import deepcopy

diff --git a/src/tensortrax/math/__init__.py b/src/tensortrax/math/__init__.py
@@ -1,17 +1,10 @@
-r"""
- _
-| |                          ████████╗██████╗  █████╗ ██╗  ██╗
-| |_ ___ _ __  ___  ___  _ __╚══██╔══╝██╔══██╗██╔══██╗╚██╗██╔╝
-| __/ _ \ '_ \/ __|/ _ \| '__|  ██║   ██████╔╝███████║ ╚███╔╝
-| ||  __/ | | \__ \ (_) | |     ██║   ██╔══██╗██╔══██║ ██╔██╗
- \__\___|_| |_|___/\___/|_|     ██║   ██║  ██║██║  ██║██╔╝ ██╗
-                                ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝
+"""
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
 """
 
 from .._tensor import broadcast_to, dual2real, ravel, reshape, squeeze
-from . import _linalg as linalg
 from . import _math_array as base
-from . import _special as special
+from . import linalg, special
 from ._math_tensor import (
     abs,
     array,

diff --git a/src/tensortrax/math/_linalg/__init__.py b/src/tensortrax/math/_linalg/__init__.py
diff --git a/src/tensortrax/math/_math_array.py b/src/tensortrax/math/_math_array.py
@@ -1,13 +1,6 @@
-r"""
- _
-| |                          ████████╗██████╗  █████╗ ██╗  ██╗
-| |_ ___ _ __  ___  ___  _ __╚══██╔══╝██╔══██╗██╔══██╗╚██╗██╔╝
-| __/ _ \ '_ \/ __|/ _ \| '__|  ██║   ██████╔╝███████║ ╚███╔╝
-| ||  __/ | | \__ \ (_) | |     ██║   ██╔══██╗██╔══██║ ██╔██╗
- \__\___|_| |_|___/\___/|_|     ██║   ██║  ██║██║  ██║██╔╝ ██╗
-                                ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝
 """
-
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
+"""
 import numpy as np
 
 from .._tensor import Tensor, f

diff --git a/src/tensortrax/math/_math_tensor.py b/src/tensortrax/math/_math_tensor.py
@@ -1,13 +1,6 @@
-r"""
- _
-| |                          ████████╗██████╗  █████╗ ██╗  ██╗
-| |_ ___ _ __  ___  ___  _ __╚══██╔══╝██╔══██╗██╔══██╗╚██╗██╔╝
-| __/ _ \ '_ \/ __|/ _ \| '__|  ██║   ██████╔╝███████║ ╚███╔╝
-| ||  __/ | | \__ \ (_) | |     ██║   ██╔══██╗██╔══██║ ██╔██╗
- \__\___|_| |_|___/\___/|_|     ██║   ██║  ██║██║  ██║██╔╝ ██╗
-                                ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝
 """
-
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
+"""
 import numpy as np
 
 from .._tensor import Tensor, Δ, Δδ, broadcast_to, einsum, f, matmul, δ

diff --git a/src/tensortrax/math/_special/__init__.py b/src/tensortrax/math/_special/__init__.py
diff --git a/src/tensortrax/math/linalg/__init__.py b/src/tensortrax/math/linalg/__init__.py
@@ -0,0 +1,10 @@
+"""
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
+"""
+
+from ._linalg_array import det as _det
+from ._linalg_array import inv as _inv
+from ._linalg_array import pinv as _pinv
+from ._linalg_tensor import det, eigh, eigvalsh, expm, inv, pinv
+
+__all__ = ["_det", "_inv", "_pinv", "det", "eigh", "eigvalsh", "expm", "inv", "pinv"]
diff --git a/src/tensortrax/math/_linalg/_linalg_array.py → src/tensortrax/math/linalg/_linalg_array.py b/src/tensortrax/math/_linalg/_linalg_array.py → src/tensortrax/math/linalg/_linalg_array.py
@@ -1,11 +1,5 @@
-r"""
- _
-| |                          ████████╗██████╗  █████╗ ██╗  ██╗
-| |_ ___ _ __  ___  ___  _ __╚══██╔══╝██╔══██╗██╔══██╗╚██╗██╔╝
-| __/ _ \ '_ \/ __|/ _ \| '__|  ██║   ██████╔╝███████║ ╚███╔╝
-| ||  __/ | | \__ \ (_) | |     ██║   ██╔══██╗██╔══██║ ██╔██╗
- \__\___|_| |_|___/\___/|_|     ██║   ██║  ██║██║  ██║██╔╝ ██╗
-                                ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝
+"""
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
 """
 
 import numpy as np

diff --git a/...tensortrax/math/_linalg/_linalg_tensor.py → src/tensortrax/math/linalg/_linalg_tensor.py b/...tensortrax/math/_linalg/_linalg_tensor.py → src/tensortrax/math/linalg/_linalg_tensor.py
@@ -1,19 +1,13 @@
-r"""
- _
-| |                          ████████╗██████╗  █████╗ ██╗  ██╗
-| |_ ___ _ __  ___  ___  _ __╚══██╔══╝██╔══██╗██╔══██╗╚██╗██╔╝
-| __/ _ \ '_ \/ __|/ _ \| '__|  ██║   ██████╔╝███████║ ╚███╔╝
-| ||  __/ | | \__ \ (_) | |     ██║   ██╔══██╗██╔══██║ ██╔██╗
- \__\___|_| |_|___/\___/|_|     ██║   ██║  ██║██║  ██║██╔╝ ██╗
-                                ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝
+"""
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
 """
 
 
 import numpy as np
 
 from ..._tensor import Tensor, Δ, Δδ, einsum, f, matmul, δ
 from .._math_tensor import exp, sum, transpose
-from .._special._special_tensor import ddot
+from ..special._special_tensor import ddot
 from . import _linalg_array as linalg
 
 dot = matmul

diff --git a/src/tensortrax/math/special/__init__.py b/src/tensortrax/math/special/__init__.py
@@ -0,0 +1,25 @@
+"""
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
+"""
+
+from ._special_tensor import (
+    ddot,
+    dev,
+    from_triu_1d,
+    from_triu_2d,
+    sym,
+    tresca,
+    triu_1d,
+    von_mises,
+)
+
+__all__ = [
+    "ddot",
+    "dev",
+    "from_triu_1d",
+    "from_triu_2d",
+    "sym",
+    "tresca",
+    "triu_1d",
+    "von_mises",
+]
diff --git a/...nsortrax/math/_special/_special_tensor.py → ...ensortrax/math/special/_special_tensor.py b/...nsortrax/math/_special/_special_tensor.py → ...ensortrax/math/special/_special_tensor.py
@@ -1,19 +1,13 @@
-r"""
- _
-| |                          ████████╗██████╗  █████╗ ██╗  ██╗
-| |_ ___ _ __  ___  ___  _ __╚══██╔══╝██╔══██╗██╔══██╗╚██╗██╔╝
-| __/ _ \ '_ \/ __|/ _ \| '__|  ██║   ██████╔╝███████║ ╚███╔╝
-| ||  __/ | | \__ \ (_) | |     ██║   ██╔══██╗██╔══██║ ██╔██╗
- \__\___|_| |_|___/\___/|_|     ██║   ██║  ██║██║  ██║██╔╝ ██╗
-                                ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝
+"""
+tensorTRAX: Math on (Hyper-Dual) Tensors with Trailing Axes.
 """
 
 import numpy as np
 
 from ..._tensor import Tensor
 from .. import _math_array as array
-from .._linalg import _linalg_tensor as linalg
 from .._math_tensor import einsum, sqrt, trace, transpose
+from ..linalg import _linalg_tensor as linalg
 
 
 def ddot(A, B):