spacecore-optimize 0.0.1__tar.gz

spacecore_optimize-0.0.1/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## [0.0.1] — 2026-10-18
+
+First release, carved out of SpaceCore 0.5.0, which keeps no optimization loops.
+
+- `minimize_scipy`, `line_search_scipy`: SciPy adapters handing over the covector
+  `X.riesz(F.grad(x))`.
+- `minimize_optax`, `OptaxResult`: a compiled optax loop on a JAX-backed domain, stopping
+  on the dual gradient norm.
+- Functionals: `least_squares`, `NegativeEntropyFunctional`, `KLDivergenceFunctional`,
+  `HuberFunctional`, `SpectralFunctional`, `spectralize`, `eigenvalue_space`,
+  `NuclearNormFunctional`, `RealifiedFunctional`, `realify`.
+- Proximal steps: `generalized_shrinkage`, `prox_l1`, `prox_l2sq`, `project_nonneg`.

spacecore_optimize-0.0.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_optimize-0.0.1/MANIFEST.in

@@ -0,0 +1,8 @@
+include CHANGELOG.md
+
+recursive-include docs *.rst *.py
+recursive-include tests *.py
+
+global-exclude *.py[cod]
+global-exclude __pycache__
+global-exclude .DS_Store

spacecore_optimize-0.0.1/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: spacecore-optimize
+Version: 0.0.1
+Summary: Optimization on top of SpaceCore: SciPy and optax adapters, and a catalogue of functionals and proximal steps.
+Author: Pavlo Pelikh
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://pavlo3p.github.io/spacecore-optimize/
+Project-URL: Source, https://github.com/Pavlo3P/spacecore-optimize
+Project-URL: SpaceCore, https://github.com/Pavlo3P/SpaceCore
+Project-URL: Changelog, https://github.com/Pavlo3P/spacecore-optimize/blob/main/CHANGELOG.md
+Keywords: optimization,proximal,scipy,optax,spacecore
+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: spacecore>=0.5.0
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: scipy>=1.17
+Provides-Extra: optax
+Requires-Dist: jax>=0.9.1; extra == "optax"
+Requires-Dist: optax>=0.2; extra == "optax"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=8.0; extra == "docs"
+Requires-Dist: pydata-sphinx-theme>=0.16; extra == "docs"
+Dynamic: license-file
+
+# spacecore-optimize
+
+Optimization on top of [SpaceCore](https://github.com/Pavlo3P/SpaceCore). SpaceCore supplies
+spaces, geometry, operators, functionals and proximal steps; this package hands them to
+external optimizers and adds a catalogue of common objectives.
+
+The one rule it enforces: an optimizer that works on flat coordinates gets the gradient as
+the covector `X.riesz(F.grad(x))`, not the Riesz gradient `F.grad(x)`. On a Euclidean space
+the two coincide; on a weighted or operator geometry only the covector is the derivative
+with respect to the coordinates SciPy and optax update.
+
+## Install
+
+```bash
+pip install spacecore-optimize            # SciPy adapters and functionals
+pip install "spacecore-optimize[optax]"   # plus minimize_optax (JAX backend)
+```
+
+Requires Python 3.11+ and SpaceCore 0.5.0+.
+
+## Example
+
+Least squares on a space with a weighted inner product:
+
+```python
+import numpy as np
+import spacecore as sc
+import spacecore_optimize as spo
+
+ctx = sc.Context(sc.NumpyOps(), dtype=np.float64)
+X = sc.DenseCoordinateSpace((3,), ctx, geometry=sc.WeightedInnerProduct(ctx.asarray([1.0, 4.0, 9.0])))
+Y = sc.DenseCoordinateSpace((5,), ctx)
+rng = np.random.default_rng(0)
+A = sc.DenseLinOp(ctx.asarray(rng.standard_normal((5, 3))), X, Y, ctx)
+b = ctx.asarray(rng.standard_normal(5))
+
+F = spo.least_squares(A, b)                 # 1/2 ||A x - b||^2
+result = spo.minimize_scipy(F, X.zeros())   # scipy.optimize.minimize, L-BFGS-B
+x = result.x_element                        # the minimizer, an element of X
+```
+
+## What is in it
+
+| Name | What it does |
+|---|---|
+| `minimize_scipy`, `line_search_scipy` | Run `scipy.optimize.minimize` / `line_search` on a SpaceCore `Functional`. |
+| `minimize_optax`, `OptaxResult` | A compiled optax loop on a JAX-backed domain, stopping on the dual gradient norm. |
+| `least_squares` | `scale * ‖A x − b‖²` as a quadratic form, optionally weighted. |
+| `NegativeEntropyFunctional`, `KLDivergenceFunctional`, `HuberFunctional` | Coordinate objectives whose gradients follow the domain geometry. |
+| `SpectralFunctional`, `spectralize`, `eigenvalue_space`, `NuclearNormFunctional` | Spectral functions on Jordan-algebra spaces such as Hermitian matrices. |
+| `RealifiedFunctional`, `realify` | A complex-domain functional seen on stacked real coordinates. |
+| `generalized_shrinkage`, `prox_l1`, `prox_l2sq`, `project_nonneg` | Closed-form proximal steps in diagonal geometry. |
+
+The norms covered by SpaceCore's own prox rules (`LpNormFunctional`,
+`SquaredL2NormFunctional`, `L1NormFunctional`) live in SpaceCore.
+
+## Documentation
+
+Published at https://pavlo3p.github.io/spacecore-optimize/. To build locally:
+
+```bash
+pip install -e ".[docs]"
+sphinx-build -W docs docs/_build/html
+```
+
+## License
+
+Apache-2.0.

spacecore_optimize-0.0.1/README.md

@@ -0,0 +1,68 @@
+# spacecore-optimize
+
+Optimization on top of [SpaceCore](https://github.com/Pavlo3P/SpaceCore). SpaceCore supplies
+spaces, geometry, operators, functionals and proximal steps; this package hands them to
+external optimizers and adds a catalogue of common objectives.
+
+The one rule it enforces: an optimizer that works on flat coordinates gets the gradient as
+the covector `X.riesz(F.grad(x))`, not the Riesz gradient `F.grad(x)`. On a Euclidean space
+the two coincide; on a weighted or operator geometry only the covector is the derivative
+with respect to the coordinates SciPy and optax update.
+
+## Install
+
+```bash
+pip install spacecore-optimize            # SciPy adapters and functionals
+pip install "spacecore-optimize[optax]"   # plus minimize_optax (JAX backend)
+```
+
+Requires Python 3.11+ and SpaceCore 0.5.0+.
+
+## Example
+
+Least squares on a space with a weighted inner product:
+
+```python
+import numpy as np
+import spacecore as sc
+import spacecore_optimize as spo
+
+ctx = sc.Context(sc.NumpyOps(), dtype=np.float64)
+X = sc.DenseCoordinateSpace((3,), ctx, geometry=sc.WeightedInnerProduct(ctx.asarray([1.0, 4.0, 9.0])))
+Y = sc.DenseCoordinateSpace((5,), ctx)
+rng = np.random.default_rng(0)
+A = sc.DenseLinOp(ctx.asarray(rng.standard_normal((5, 3))), X, Y, ctx)
+b = ctx.asarray(rng.standard_normal(5))
+
+F = spo.least_squares(A, b)                 # 1/2 ||A x - b||^2
+result = spo.minimize_scipy(F, X.zeros())   # scipy.optimize.minimize, L-BFGS-B
+x = result.x_element                        # the minimizer, an element of X
+```
+
+## What is in it
+
+| Name | What it does |
+|---|---|
+| `minimize_scipy`, `line_search_scipy` | Run `scipy.optimize.minimize` / `line_search` on a SpaceCore `Functional`. |
+| `minimize_optax`, `OptaxResult` | A compiled optax loop on a JAX-backed domain, stopping on the dual gradient norm. |
+| `least_squares` | `scale * ‖A x − b‖²` as a quadratic form, optionally weighted. |
+| `NegativeEntropyFunctional`, `KLDivergenceFunctional`, `HuberFunctional` | Coordinate objectives whose gradients follow the domain geometry. |
+| `SpectralFunctional`, `spectralize`, `eigenvalue_space`, `NuclearNormFunctional` | Spectral functions on Jordan-algebra spaces such as Hermitian matrices. |
+| `RealifiedFunctional`, `realify` | A complex-domain functional seen on stacked real coordinates. |
+| `generalized_shrinkage`, `prox_l1`, `prox_l2sq`, `project_nonneg` | Closed-form proximal steps in diagonal geometry. |
+
+The norms covered by SpaceCore's own prox rules (`LpNormFunctional`,
+`SquaredL2NormFunctional`, `L1NormFunctional`) live in SpaceCore.
+
+## Documentation
+
+Published at https://pavlo3p.github.io/spacecore-optimize/. To build locally:
+
+```bash
+pip install -e ".[docs]"
+sphinx-build -W docs docs/_build/html
+```
+
+## License
+
+Apache-2.0.

spacecore_optimize-0.0.1/docs/api.rst

@@ -0,0 +1,32 @@
+API
+===
+
+Optimizer adapters
+------------------
+
+.. autofunction:: spacecore_optimize.minimize_scipy
+.. autofunction:: spacecore_optimize.line_search_scipy
+.. autofunction:: spacecore_optimize.minimize_optax
+.. autoclass:: spacecore_optimize.OptaxResult
+
+Functionals
+-----------
+
+.. autofunction:: spacecore_optimize.least_squares
+.. autoclass:: spacecore_optimize.NegativeEntropyFunctional
+.. autoclass:: spacecore_optimize.KLDivergenceFunctional
+.. autoclass:: spacecore_optimize.HuberFunctional
+.. autoclass:: spacecore_optimize.SpectralFunctional
+.. autofunction:: spacecore_optimize.spectralize
+.. autofunction:: spacecore_optimize.eigenvalue_space
+.. autoclass:: spacecore_optimize.NuclearNormFunctional
+.. autoclass:: spacecore_optimize.RealifiedFunctional
+.. autofunction:: spacecore_optimize.realify
+
+Proximal steps
+--------------
+
+.. autofunction:: spacecore_optimize.generalized_shrinkage
+.. autofunction:: spacecore_optimize.prox_l1
+.. autofunction:: spacecore_optimize.prox_l2sq
+.. autofunction:: spacecore_optimize.project_nonneg

spacecore_optimize-0.0.1/docs/changelog.rst

@@ -0,0 +1,4 @@
+Changelog
+=========
+
+See `CHANGELOG.md <https://github.com/Pavlo3P/spacecore-optimize/blob/master/CHANGELOG.md>`_.

spacecore_optimize-0.0.1/docs/conf.py

@@ -0,0 +1,16 @@
+"""Sphinx configuration for spacecore-optimize."""
+
+import importlib.metadata
+
+project = "spacecore-optimize"
+author = "Pavlo Pelikh"
+release = importlib.metadata.version("spacecore-optimize")
+
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
+autodoc_mock_imports = ["jax", "optax"]
+autodoc_member_order = "bysource"
+autodoc_typehints = "description"
+napoleon_google_docstring = False
+
+html_theme = "pydata_sphinx_theme"
+exclude_patterns = ["_build"]

spacecore_optimize-0.0.1/docs/index.rst

@@ -0,0 +1,35 @@
+spacecore-optimize
+==================
+
+Optimization on top of `SpaceCore <https://github.com/Pavlo3P/SpaceCore>`_: adapters that
+hand a SpaceCore :class:`~spacecore.Functional` to SciPy or optax, and a catalogue of
+objectives and closed-form proximal steps.
+
+An optimizer that updates flat coordinates receives the covector ``X.riesz(F.grad(x))``;
+on a non-Euclidean geometry the Riesz gradient ``F.grad(x)`` is not the coordinate
+derivative.
+
+Install with ``pip install spacecore-optimize`` (add ``[optax]`` for
+:func:`~spacecore_optimize.minimize_optax`). Requires SpaceCore 0.5.0 or later.
+
+.. code-block:: python
+
+   import numpy as np
+   import spacecore as sc
+   import spacecore_optimize as spo
+
+   ctx = sc.Context(sc.NumpyOps(), dtype=np.float64)
+   X = sc.DenseCoordinateSpace((3,), ctx, geometry=sc.WeightedInnerProduct(ctx.asarray([1.0, 4.0, 9.0])))
+   Y = sc.DenseCoordinateSpace((5,), ctx)
+   rng = np.random.default_rng(0)
+   A = sc.DenseLinOp(ctx.asarray(rng.standard_normal((5, 3))), X, Y, ctx)
+   b = ctx.asarray(rng.standard_normal(5))
+
+   F = spo.least_squares(A, b)
+   x = spo.minimize_scipy(F, X.zeros()).x_element
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+   changelog

spacecore_optimize-0.0.1/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "spacecore-optimize"
+version = "0.0.1"
+description = "Optimization on top of SpaceCore: SciPy and optax adapters, and a catalogue of functionals and proximal steps."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Pavlo Pelikh" }]
+keywords = ["optimization", "proximal", "scipy", "optax", "spacecore"]
+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",
+]
+dependencies = [
+  "spacecore>=0.5.0",
+  "numpy>=2.0.0",
+  "scipy>=1.17",
+]
+
+[project.urls]
+Documentation = "https://pavlo3p.github.io/spacecore-optimize/"
+Source = "https://github.com/Pavlo3P/spacecore-optimize"
+SpaceCore = "https://github.com/Pavlo3P/SpaceCore"
+Changelog = "https://github.com/Pavlo3P/spacecore-optimize/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+# optax adapter (``minimize_optax``); needs a JAX backend.
+optax = ["jax>=0.9.1", "optax>=0.2"]
+dev = ["pytest>=8.0"]
+docs = ["sphinx>=8.0", "pydata-sphinx-theme>=0.16"]
+
+[tool.setuptools.packages.find]
+include = ["spacecore_optimize*"]
+
+[tool.setuptools.package-data]
+spacecore_optimize = ["py.typed"]
+
+[tool.pytest.ini_options]
+addopts = ["--doctest-modules"]
+testpaths = ["spacecore_optimize", "tests"]
+doctest_optionflags = ["NORMALIZE_WHITESPACE", "ELLIPSIS", "NUMBER"]

spacecore_optimize-0.0.1/setup.cfg

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

spacecore_optimize-0.0.1/spacecore_optimize/__init__.py

@@ -0,0 +1,53 @@
+"""Optimization on top of SpaceCore.
+
+External optimizer adapters, plus the functional catalogue in
+:mod:`spacecore_optimize.functionals` (re-exported here). The adapters are thin
+functions that drive a mature external optimizer from a SpaceCore
+:class:`~spacecore.Functional`. Each adapter evaluates the objective through
+``F.value``, converts the metric (Riesz) gradient ``F.grad`` to a coordinate
+gradient with ``X.riesz`` -- the central, geometry-aware handoff --
+and marshals between SpaceCore elements and the optimizer's representation. The
+external optimizer owns the loop, line search, and convergence.
+"""
+
+from __future__ import annotations
+
+from ._optax import OptaxResult, minimize_optax
+from ._scipy import line_search_scipy, minimize_scipy
+from .functionals import (
+    HuberFunctional,
+    KLDivergenceFunctional,
+    NegativeEntropyFunctional,
+    NuclearNormFunctional,
+    RealifiedFunctional,
+    SpectralFunctional,
+    eigenvalue_space,
+    generalized_shrinkage,
+    least_squares,
+    project_nonneg,
+    prox_l1,
+    prox_l2sq,
+    realify,
+    spectralize,
+)
+
+__all__ = [
+    "HuberFunctional",
+    "KLDivergenceFunctional",
+    "NegativeEntropyFunctional",
+    "NuclearNormFunctional",
+    "OptaxResult",
+    "RealifiedFunctional",
+    "SpectralFunctional",
+    "eigenvalue_space",
+    "generalized_shrinkage",
+    "least_squares",
+    "line_search_scipy",
+    "minimize_optax",
+    "minimize_scipy",
+    "project_nonneg",
+    "prox_l1",
+    "prox_l2sq",
+    "realify",
+    "spectralize",
+]

spacecore_optimize-0.0.1/spacecore_optimize/_common.py

@@ -0,0 +1,69 @@
+"""Shared marshalling helpers for the external-optimizer adapters.
+
+The adapters in this subpackage drive a mature external optimizer (SciPy, optax)
+from a SpaceCore :class:`~spacecore.Functional`. They share one central
+responsibility, stated here: a SpaceCore gradient ``F.grad(x)`` is a
+*metric* (Riesz) gradient, but external NumPy/JAX optimizers consume
+a *coordinate* gradient. The correct, geometry-aware handoff is
+``X.riesz(F.grad(x))`` -- the identity on a Euclidean space, and mandatory on a
+weighted/non-Euclidean one. :func:`coordinate_gradient` performs this conversion
+once, centrally. Beck, *First-Order Methods in Optimization*, Remark 3.32.
+"""
+from __future__ import annotations
+
+from typing import Any
+
+from spacecore import Functional
+from spacecore import InnerProductSpace
+
+
+def require_functional(F: Any, fname: str) -> Functional:
+    """Return ``F`` as a :class:`~spacecore.Functional` or raise a clear type error."""
+    if not isinstance(F, Functional):
+        raise TypeError(
+            f"{fname} requires a spacecore Functional, got {type(F).__name__}."
+        )
+    return F
+
+
+def domain_with_geometry(F: Functional, fname: str) -> InnerProductSpace:
+    """Return ``F.domain`` after checking it carries an inner-product geometry.
+
+    The metric-to-coordinate gradient handoff needs ``X.riesz``; a domain without
+    inner-product geometry has no Riesz map and no well-defined metric gradient
+    (the ``Functional`` contract), so the adapter refuses it rather than silently assuming Euclidean.
+    """
+    X = F.domain
+    if not isinstance(X, InnerProductSpace):
+        raise TypeError(
+            f"{fname} requires F.domain to be an InnerProductSpace so the metric "
+            f"gradient can be converted to a coordinate gradient with X.riesz; "
+            f"got {type(X).__name__}."
+        )
+    return X
+
+
+def coordinate_gradient(F: Functional, X: InnerProductSpace, x: Any) -> Any:
+    """Return the coordinate gradient ``F.differential(x)`` at ``x``.
+
+    This is the central conversion: an external coordinate-gradient consumer wants
+    the differential covector, which equals ``X.riesz(F.grad(x))``. Coordinate
+    functionals return it directly, without a Riesz-map round trip.
+    """
+    return F.differential(x)
+
+
+def require_real_field(X: InnerProductSpace, fname: str) -> None:
+    """Raise when ``X`` is over the complex field.
+
+    The SciPy adapters drive real-valued optimizers (``scipy.optimize`` works on
+    real coordinate vectors). A complex domain must be split into real and
+    imaginary coordinates by the caller; refusing here is more honest than
+    silently dropping the imaginary part during ``asarray``.
+    """
+    if X.field != "real":
+        raise ValueError(
+            f"{fname} drives a real-valued SciPy optimizer and cannot consume a "
+            f"complex domain ({type(X).__name__}, field={X.field!r}); split the "
+            f"problem into real and imaginary coordinates first."
+        )