array-api-shape-check 0.1.0__tar.gz → 0.1.2__tar.gz

{array_api_shape_check-0.1.0/src/array_api_shape_check.egg-info → array_api_shape_check-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: array-api-shape-check
-Version: 0.1.0
+Version: 0.1.2
 Summary: Check shapes of input arrays easily
 Author-email: 34j <34j.95a2p@simplelogin.com>
 License-Expression: MIT
@@ -82,7 +82,7 @@ Install this via pip (or your favourite package manager):
 >>> info.all
 ((i:1->3, j:4), (*k:(5,), *l:(6, 7)), (*l:(1, 7)->(6, 7), i:3))
 >>> info.unique
-(i:3, j:4, *k:(5,), *l:(6, 7))
+{'i': i:3, 'j': j:4, 'k': *k:(5,), 'l': *l:(6, 7)}
 ```
 
 Internally `check_shapes()` calls `parse_variable_ndim()`, which determines the number of dimensions for variable subscripts by least squares. If this is successful, checks if each subscript is consistent, then finnaly raises error for all inconsistencies at once.
@@ -107,13 +107,7 @@ Not enough information to determine variable subscript ndims:
 >>> import pytest
 >>> from array_api_shape_check import InconsistentNdimErrorMultipleSolutions, InconsistentNdimErrorNoSolutions, InconsistentShapeError
 >>> with pytest.raises(InconsistentNdimErrorMultipleSolutions, match="number of variables"):
-...     check_shapes(
-...         "*i*j",
-...         (
-...             1,
-...             1,
-...         ),
-...     )
+...     check_shapes("*i*j", (1, 1))
 >>> with pytest.raises(InconsistentNdimErrorMultipleSolutions, match="rank"):
 ...     check_shapes("*i*j,*i*j", (1, 1), (1, 1))
 ```

{array_api_shape_check-0.1.0 → array_api_shape_check-0.1.2}/README.md

@@ -54,7 +54,7 @@ Install this via pip (or your favourite package manager):
 >>> info.all
 ((i:1->3, j:4), (*k:(5,), *l:(6, 7)), (*l:(1, 7)->(6, 7), i:3))
 >>> info.unique
-(i:3, j:4, *k:(5,), *l:(6, 7))
+{'i': i:3, 'j': j:4, 'k': *k:(5,), 'l': *l:(6, 7)}
 ```
 
 Internally `check_shapes()` calls `parse_variable_ndim()`, which determines the number of dimensions for variable subscripts by least squares. If this is successful, checks if each subscript is consistent, then finnaly raises error for all inconsistencies at once.
@@ -79,13 +79,7 @@ Not enough information to determine variable subscript ndims:
 >>> import pytest
 >>> from array_api_shape_check import InconsistentNdimErrorMultipleSolutions, InconsistentNdimErrorNoSolutions, InconsistentShapeError
 >>> with pytest.raises(InconsistentNdimErrorMultipleSolutions, match="number of variables"):
-...     check_shapes(
-...         "*i*j",
-...         (
-...             1,
-...             1,
-...         ),
-...     )
+...     check_shapes("*i*j", (1, 1))
 >>> with pytest.raises(InconsistentNdimErrorMultipleSolutions, match="rank"):
 ...     check_shapes("*i*j,*i*j", (1, 1), (1, 1))
 ```

{array_api_shape_check-0.1.0 → array_api_shape_check-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "setuptools>=77.0.3" ]
 
 [project]
 name = "array-api-shape-check"
-version = "0.1.0"
+version = "0.1.2"
 description = "Check shapes of input arrays easily"
 readme = "README.md"
 license = "MIT"

{array_api_shape_check-0.1.0 → array_api_shape_check-0.1.2}/src/array_api_shape_check/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.0"
+__version__ = "0.1.2"
 from ._main import (
     InconsistentNdimError,
     InconsistentNdimErrorMultipleSolutions,

{array_api_shape_check-0.1.0 → array_api_shape_check-0.1.2}/src/array_api_shape_check/_main.py

@@ -23,7 +23,7 @@ class SubscriptInfoFromSubcriptItem:
 @attrs.frozen(kw_only=True)
 class SubscriptInfoFromSubcript:
     all: tuple[tuple[SubscriptInfoFromSubcriptItem, ...], ...]
-    unique: tuple[SubscriptInfoFromSubcriptItem, ...]
+    unique: dict[str, SubscriptInfoFromSubcriptItem]
 
 
 @attrs.frozen(kw_only=True)
@@ -70,7 +70,7 @@ class SubscriptInfoFromShapeItem(SubscriptInfoFromShapeItemUnchecked):
 class SubscriptInfoFromShape:
     all: tuple[tuple[SubscriptInfoFromShapeItem, ...], ...]
     """The subscript info grouped by order, then by operand"""
-    unique: tuple[SubscriptInfoFromShapeItemUnique, ...]
+    unique: dict[str, SubscriptInfoFromShapeItemUnique]
     """The unique subscripts,
     ignoring order and shapes not broadcasted,
     sorted lexicographically by name"""
@@ -157,8 +157,11 @@ def parse_subscripts(subscripts: str, /) -> SubscriptInfoFromSubcript:
 
     Examples
     --------
-    >>> parse_subscripts("ij,*k*l,*li")
-    SubscriptInfoFromSubcript(all=((i, j), (*k, *l), (*l, i)), unique=(i, j, *k, *l))
+    >>> info = parse_subscripts("ij,*k*l,*li")
+    >>> info.all
+    ((i, j), (*k, *l), (*l, i))
+    >>> info.unique
+    {'i': i, 'j': j, 'k': *k, 'l': *l}
 
     """
     # If . other than ...
@@ -181,9 +184,9 @@ def parse_subscripts(subscripts: str, /) -> SubscriptInfoFromSubcript:
                 is_variable = False
         info_all += (info_array,)
 
-    info_unique: set[SubscriptInfoFromSubcriptItem] = {
-        x for info_array in info_all for x in info_array
-    }
+    info_unique = tuple(
+        sorted({x for info_array in info_all for x in info_array}, key=lambda x: x.name)
+    )
     # raise if there are subscripts with same name but different is_variable
     names = set()
     for info in info_unique:
@@ -193,9 +196,7 @@ def parse_subscripts(subscripts: str, /) -> SubscriptInfoFromSubcript:
             )
         names.add(info.name)
 
-    return SubscriptInfoFromSubcript(
-        all=info_all, unique=tuple(sorted(info_unique, key=lambda x: x.name))
-    )
+    return SubscriptInfoFromSubcript(all=info_all, unique={item.name: item for item in info_unique})
 
 
 def parse_variable_ndim(subscripts: str, ndims: Sequence[int], /) -> dict[str, int]:
@@ -253,7 +254,9 @@ def parse_variable_ndim(subscripts: str, ndims: Sequence[int], /) -> dict[str, i
         )
 
     # decide dimensions by solving linear equations
-    info_variable_unique = [subscript for subscript in info.unique if subscript.is_variable]
+    info_variable_unique = [
+        subscript for subscript in info.unique.values() if subscript.is_variable
+    ]
     if len(info_variable_unique) > len(info.all):
         raise InconsistentNdimErrorMultipleSolutions("number of variables")
     rhs = np.asarray(ndims, dtype=int)
@@ -363,19 +366,30 @@ def check_shapes(
     >>> info.all
     ((i:1->3, j:4), (*k:(5,), *l:(6, 7)), (*l:(1, 7)->(6, 7), i:3))
     >>> info.unique
-    (i:3, j:4, *k:(5,), *l:(6, 7))
+    {'i': i:3, 'j': j:4, 'k': *k:(5,), 'l': *l:(6, 7)}
+
+    Internally `check_shapes()` calls `parse_variable_ndim()`,
+    which determines the number of dimensions for variable subscripts by least squares.
+    If this is successful, checks if each subscript is consistent,
+    then finnaly raises error for all inconsistencies at once.
+
+    Diving into the details of the first item:
+
+    >>> item = info.all[0][0]
+    >>> item.name  # the name of the subscript
+    'i'
+    >>> item.is_variable  # whether the subscript is variable (starts with "*")
+    False
+    >>> item.shape_current  # the current shape of the subscript
+    (1,)
+    >>> item.shape_broadcasted  # the broadcasted shape of the subscript
+    (3,)
 
     Not enough information to determine variable subscript ndims:
 
     >>> import pytest
     >>> with pytest.raises(InconsistentNdimErrorMultipleSolutions, match="number of variables"):
-    ...     check_shapes(
-    ...         "*i*j",
-    ...         (
-    ...             1,
-    ...             1,
-    ...         ),
-    ...     )
+    ...     check_shapes("*i*j", (1, 1))
     >>> with pytest.raises(InconsistentNdimErrorMultipleSolutions, match="rank"):
     ...     check_shapes("*i*j,*i*j", (1, 1), (1, 1))
 
@@ -437,7 +451,8 @@ def check_shapes(
         for item in info_array
     }
     result = SubscriptInfoFromShape(
-        all=info_all_new, unique=tuple(sorted(info_unique, key=lambda x: x.name))
+        all=info_all_new,
+        unique={item.name: item for item in sorted(info_unique, key=lambda x: x.name)},
     )
 
     if errors:

{array_api_shape_check-0.1.0 → array_api_shape_check-0.1.2/src/array_api_shape_check.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: array-api-shape-check
-Version: 0.1.0
+Version: 0.1.2
 Summary: Check shapes of input arrays easily
 Author-email: 34j <34j.95a2p@simplelogin.com>
 License-Expression: MIT
@@ -82,7 +82,7 @@ Install this via pip (or your favourite package manager):
 >>> info.all
 ((i:1->3, j:4), (*k:(5,), *l:(6, 7)), (*l:(1, 7)->(6, 7), i:3))
 >>> info.unique
-(i:3, j:4, *k:(5,), *l:(6, 7))
+{'i': i:3, 'j': j:4, 'k': *k:(5,), 'l': *l:(6, 7)}
 ```
 
 Internally `check_shapes()` calls `parse_variable_ndim()`, which determines the number of dimensions for variable subscripts by least squares. If this is successful, checks if each subscript is consistent, then finnaly raises error for all inconsistencies at once.
@@ -107,13 +107,7 @@ Not enough information to determine variable subscript ndims:
 >>> import pytest
 >>> from array_api_shape_check import InconsistentNdimErrorMultipleSolutions, InconsistentNdimErrorNoSolutions, InconsistentShapeError
 >>> with pytest.raises(InconsistentNdimErrorMultipleSolutions, match="number of variables"):
-...     check_shapes(
-...         "*i*j",
-...         (
-...             1,
-...             1,
-...         ),
-...     )
+...     check_shapes("*i*j", (1, 1))
 >>> with pytest.raises(InconsistentNdimErrorMultipleSolutions, match="rank"):
 ...     check_shapes("*i*j,*i*j", (1, 1), (1, 1))
 ```