spacecore 0.1.1__tar.gz

spacecore-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

spacecore-0.1.1/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: spacecore
+Version: 0.1.1
+Summary: Backend-agnostic vector spaces and linear operators.
+Author: Pavlo Pelikh
+License-Expression: Apache-2.0
+Keywords: linear-algebra,jax,numpy,operators,spaces
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: scipy>=1.17
+Provides-Extra: jax
+Requires-Dist: jax>=0.9.1; extra == "jax"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# SpaceCore
+
+SpaceCore is a lightweight backend-agnostic library for working with vector spaces and linear operators.
+
+It provides a small set of abstractions for:
+
+- backend-aware numerical operations
+- contexts carrying backend and dtype information
+- structured vector spaces
+- structured linear operators
+- conversion between compatible contexts
+
+## Installation
+
+Base install:
+
+```bash
+pip install spacecore
+````
+
+With JAX support:
+
+```bash
+pip install "spacecore[jax]"
+```
+
+* `spacecore[jax]`: installs optional JAX support.
+* GPU users should install the appropriate CUDA-enabled JAX build first, following the official JAX installation guide.
+
+## Main concepts
+
+### `Context`
+
+A `Context` specifies how objects are represented, in particular:
+
+* backend (`NumPy`, `JAX`, etc.)
+* dtype
+* validation/conversion behavior
+
+### `Space`
+
+A `Space` describes the structure of objects space, for example:
+
+* `VectorSpace` - Euclidean space
+* `HermitianSpace` - space of Hermitian (symmetric) matrices 
+* `ProductSpace` - Cartesian product of spaces
+
+### `LinOp`
+
+A `LinOp` represents a linear operator between spaces, for example:
+
+* `DenseLinOp` - linear operator represented by dense matrix
+* `SparseLinOp` - linear operator represented by sparse matrix
+* `BlockDiagonalLinOp` - linear operator from $X_1 \times \dots \times X_k$ to $Y_1 \times \dots \times Y_k$
+* `StackedLinOp` - linear operator from $X$ to $Y_1 \times \dots \times Y_k$
+* `SumToSingleLinOp` - linear operator from $X_1 \times \dots \times X_k$ to $Y$
+
+## Minimal example
+
+```python
+import numpy as np
+import spacecore as sc
+
+sc.set_context('numpy', dtype='float64')
+
+X = sc.VectorSpace((3,))
+Y = sc.VectorSpace((2,))
+
+A = np.array(
+    [[1.0, 2.0, 3.0],
+     [0.0, 1.0, 0.0]]
+)
+linop = sc.DenseLinOp(
+    A,
+    dom=X,
+    cod=Y,
+)
+
+x = X.ctx.asarray([1.0, 0.0, -1.0])
+y = linop.apply(x)
+
+print(y)
+```
+
+## Status
+
+SpaceCore is currently experimental and under active development.
+The public API may still evolve.
+
+## Tutorials
+
+See the `tutorials/` directory for usage examples and design guidance.
+
+## License
+
+Apache License 2.0

spacecore-0.1.1/README.md

@@ -0,0 +1,96 @@
+# SpaceCore
+
+SpaceCore is a lightweight backend-agnostic library for working with vector spaces and linear operators.
+
+It provides a small set of abstractions for:
+
+- backend-aware numerical operations
+- contexts carrying backend and dtype information
+- structured vector spaces
+- structured linear operators
+- conversion between compatible contexts
+
+## Installation
+
+Base install:
+
+```bash
+pip install spacecore
+````
+
+With JAX support:
+
+```bash
+pip install "spacecore[jax]"
+```
+
+* `spacecore[jax]`: installs optional JAX support.
+* GPU users should install the appropriate CUDA-enabled JAX build first, following the official JAX installation guide.
+
+## Main concepts
+
+### `Context`
+
+A `Context` specifies how objects are represented, in particular:
+
+* backend (`NumPy`, `JAX`, etc.)
+* dtype
+* validation/conversion behavior
+
+### `Space`
+
+A `Space` describes the structure of objects space, for example:
+
+* `VectorSpace` - Euclidean space
+* `HermitianSpace` - space of Hermitian (symmetric) matrices 
+* `ProductSpace` - Cartesian product of spaces
+
+### `LinOp`
+
+A `LinOp` represents a linear operator between spaces, for example:
+
+* `DenseLinOp` - linear operator represented by dense matrix
+* `SparseLinOp` - linear operator represented by sparse matrix
+* `BlockDiagonalLinOp` - linear operator from $X_1 \times \dots \times X_k$ to $Y_1 \times \dots \times Y_k$
+* `StackedLinOp` - linear operator from $X$ to $Y_1 \times \dots \times Y_k$
+* `SumToSingleLinOp` - linear operator from $X_1 \times \dots \times X_k$ to $Y$
+
+## Minimal example
+
+```python
+import numpy as np
+import spacecore as sc
+
+sc.set_context('numpy', dtype='float64')
+
+X = sc.VectorSpace((3,))
+Y = sc.VectorSpace((2,))
+
+A = np.array(
+    [[1.0, 2.0, 3.0],
+     [0.0, 1.0, 0.0]]
+)
+linop = sc.DenseLinOp(
+    A,
+    dom=X,
+    cod=Y,
+)
+
+x = X.ctx.asarray([1.0, 0.0, -1.0])
+y = linop.apply(x)
+
+print(y)
+```
+
+## Status
+
+SpaceCore is currently experimental and under active development.
+The public API may still evolve.
+
+## Tutorials
+
+See the `tutorials/` directory for usage examples and design guidance.
+
+## License
+
+Apache License 2.0

spacecore-0.1.1/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "spacecore"
+version = "0.1.1"
+description = "Backend-agnostic vector spaces and linear operators."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+  { name = "Pavlo Pelikh" }
+]
+dependencies = [
+  "numpy>=2.0.0",
+  "scipy>=1.17",
+]
+
+keywords = [
+  "linear-algebra",
+  "jax",
+  "numpy",
+  "operators",
+  "spaces",
+]
+
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Science/Research",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Scientific/Engineering :: Mathematics",
+]
+
+[project.optional-dependencies]
+jax = [
+  "jax>=0.9.1",
+]
+dev = [
+  "pytest>=8.0",
+    "ruff>=0.6",
+]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["spacecore*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint.per-file-ignores]
+"tutorials/*.ipynb" = ["E741"]
+"tests/*.py" = ["E701"]

spacecore-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

spacecore-0.1.1/spacecore/__init__.py

@@ -0,0 +1,46 @@
+__version__ = "0.1.1"
+
+
+from .backend import Context, BackendOps, JaxOps, NumpyOps, jax_pytree_class
+from .linop import DenseLinOp, SparseLinOp, BlockDiagonalLinOp, SumToSingleLinOp, StackedLinOp
+from .space import VectorSpace, HermitianSpace, Space, ProductSpace
+from .types import DenseArray, SparseArray, ArrayLike
+
+from ._contextual.manager import (
+    set_context, get_context,
+    register_ops,
+    set_resolution_policy, set_dtype_resolution_policy,
+    get_resolution_policy, get_dtype_resolution_policy
+)
+
+__all__ = [
+    "Context",
+
+    "BackendOps",
+    "JaxOps",
+    "jax_pytree_class",
+    "NumpyOps",
+
+    "DenseLinOp",
+    "SparseLinOp",
+    "BlockDiagonalLinOp",
+    "SumToSingleLinOp",
+    "StackedLinOp",
+
+    "VectorSpace",
+    "HermitianSpace",
+    "ProductSpace",
+    "Space",
+
+    "DenseArray",
+    "SparseArray",
+    "ArrayLike",
+
+    "set_context",
+    "get_context",
+    "register_ops",
+    "set_resolution_policy",
+    "set_dtype_resolution_policy",
+    "get_resolution_policy",
+    "get_dtype_resolution_policy",
+]

spacecore-0.1.1/spacecore/_contextual/__init__.py

@@ -0,0 +1,10 @@
+from .bound import ContextBound as ContextBound
+from .manager import (
+    ctx_manager as ctx_manager,
+    set_context as set_context,
+    register_ops as register_ops,
+    set_resolution_policy as set_resolution_policy,
+    set_dtype_resolution_policy as set_dtype_resolution_policy,
+    get_resolution_policy as get_resolution_policy,
+    get_dtype_resolution_policy as get_dtype_resolution_policy,
+)

spacecore-0.1.1/spacecore/_contextual/bound.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from abc import ABC
+from typing import Self
+
+from ..backend import Context, BackendOps, BackendFamily
+from ..types import DType
+from .manager import ctx_manager
+
+class ContextBound(ABC):
+    def __init__(self, ctx: Context | str | None = None):
+        ctx = ctx_manager.normalize_context(ctx)
+        self._ctx = ctx
+
+    @property
+    def ops(self) -> BackendOps:
+        return self.ctx.ops
+
+    @property
+    def dtype(self) -> DType:
+        return self.ctx.dtype
+
+    @property
+    def ctx(self) -> Context:
+        return self._ctx
+
+    def _convert(self, new_ctx: Context) -> Self:
+        raise NotImplementedError()
+
+    def convert(self, new_ctx: Context | BackendFamily | str | None = None) -> Self:
+        _, new_ctx = ctx_manager.enforce_convert_policy(self, new_ctx)
+        return self._convert(new_ctx)