solvor 0.3.1__tar.gz

solvor-0.3.1/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run linter
+        run: uv run ruff check src/
+
+      - name: Run tests
+        run: uv run pytest tests/ -v

solvor-0.3.1/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload dist
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

solvor-0.3.1/.gitignore

@@ -0,0 +1,14 @@
+# Python
+__pycache__/
+*.egg-info/
+dist/
+.venv/
+.cl*/*
+
+# Tools
+.python-version
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+.coverage
+uv.lock

solvor-0.3.1/CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing to Solvor
+
+Thanks for your interest in contributing to Solvor!
+
+## Development Setup
+
+```bash
+# Clone the repo
+git clone https://github.com/StevenBtw/solvor.git
+cd solvor
+
+# Install with dev dependencies
+uv sync --extra dev
+
+# Run tests
+uv run pytest
+
+# Run linter
+uv run ruff check src/
+```
+
+## Code Style
+
+Follow the project's style:
+
+- **Pure Python** - no external dependencies
+- **snake_case** everywhere
+- **Type hints** on public APIs, skip for internal helpers
+- **Keyword-only** for optional parameters (use `*`)
+- **Minimal comments** - explain *why*, not *what*
+- **Sets for membership** - O(1) lookup, not lists
+- **Immutable state** - solutions passed between iterations should be immutable; working structures can mutate
+
+## Terminology
+
+Use consistent naming across all solvers:
+
+| Term | Usage |
+|------|-------|
+| `solution` | Current candidate being evaluated |
+| `best_solution` | Best found so far |
+| `objective` | Value being optimized |
+| `objective_fn` | Function computing objective |
+| `neighbors` | Adjacent solutions (metaheuristics) |
+| `minimize` | Boolean flag (default `True`) |
+
+## Adding a New Solver
+
+1. Create `src/solvor/<solver_name>.py`
+2. Import shared types: `from solvor.types import Status, Result`
+3. Export `Status`, `Result`, and main solver function in `__all__`
+4. Add exports to `src/solvor/__init__.py`
+5. Add tests to `tests/test_solvers.py`
+6. Update `README.md` with usage examples
+
+## Testing
+
+All solvers must have tests covering:
+- Basic functionality
+- Edge cases (empty input, infeasible, etc.)
+- Minimize and maximize modes
+
+```bash
+uv run pytest tests/ -v
+```
+
+## Pull Requests
+
+1. Fork the repo
+2. Create a feature branch
+3. Make your changes
+4. Run tests and linter
+5. Submit a PR with a clear description
+
+## Philosophy
+
+1. Working > perfect
+2. Readable > clever
+3. Simple > general
+4. Fast, but understandable

solvor-0.3.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.

solvor-0.3.1/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.4
+Name: solvor
+Version: 0.3.1
+Summary: Pure Python optimization solvers. No dependencies, no nonsense.
+Project-URL: Repository, https://github.com/StevenBtw/solvor
+Author: Steven Bytheway
+License: MIT
+License-File: LICENSE
+Keywords: linear-programming,metaheuristics,operations-research,optimization,sat,solver
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.14
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0.2; extra == 'dev'
+Requires-Dist: ruff>=0.14.9; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Solvor
+
+![Python 3.14+](https://img.shields.io/badge/python-3.14+-blue.svg)
+![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)
+
+Pure Python optimization solvers. No dependencies, no nonsense.
+
+## What's in the box?
+
+| Category | Solvers | Use Case |
+|----------|---------|----------|
+| **Linear/Integer** | `solve_lp`, `solve_milp` | Resource allocation, scheduling |
+| **Constraint** | `solve_sat`, `Model` | Sudoku, configuration, puzzles |
+| **Local Search** | `anneal`, `tabu_search` | TSP, combinatorial optimization |
+| **Population** | `evolve` | When you want nature to do the work |
+| **Continuous** | `gradient_descent`, `momentum`, `adam` | ML, curve fitting |
+| **Black-box** | `bayesian_opt` | Hyperparameter tuning, expensive functions |
+| **Graph** | `max_flow`, `min_cost_flow`, `solve_assignment` | Matching, transportation |
+
+---
+
+## Quickstart
+
+```bash
+uv add solvor
+```
+
+```python
+from solvor import solve_lp, solve_tsp, anneal, Model
+
+# Linear Programming
+result = solve_lp(c=[1, 2], A=[[1, 1], [2, 1]], b=[4, 5])
+print(result.solution)  # optimal x
+
+# TSP with tabu search
+distances = [[0, 10, 15], [10, 0, 20], [15, 20, 0]]
+result = solve_tsp(distances)
+print(result.solution)  # best tour found
+
+# Constraint satisfaction
+m = Model()
+x = m.int_var(1, 9, 'x')
+y = m.int_var(1, 9, 'y')
+m.add(m.all_different([x, y]))
+m.add(m.sum_eq([x, y], 10))
+result = m.solve()
+print(result.solution)  # {'x': 3, 'y': 7}
+```
+
+---
+
+## Solvers
+
+<details>
+<summary><strong>Linear & Integer Programming</strong></summary>
+
+### solve_lp
+Two-phase simplex for linear programming.
+
+```python
+# minimize 2x + 3y subject to x + y >= 4, x <= 3
+result = solve_lp(
+    c=[2, 3],
+    A=[[-1, -1], [1, 0]],  # constraints as Ax <= b
+    b=[-4, 3]
+)
+```
+
+### solve_milp
+Branch and bound for mixed-integer problems.
+
+```python
+# same as above, but x must be integer
+result = solve_milp(c=[2, 3], A=[[-1, -1], [1, 0]], b=[-4, 3], integers=[0])
+```
+
+</details>
+
+<details>
+<summary><strong>Constraint Programming</strong></summary>
+
+### solve_sat
+DPLL with unit propagation and clause learning.
+
+```python
+# (x1 OR x2) AND (NOT x1 OR x3) AND (NOT x2 OR NOT x3)
+result = solve_sat([[1, 2], [-1, 3], [-2, -3]])
+print(result.solution)  # {1: True, 2: False, 3: True}
+```
+
+### Model (CP-SAT)
+Constraint programming via SAT encoding.
+
+```python
+m = Model()
+cells = [[m.int_var(1, 9, f'c{i}{j}') for j in range(9)] for i in range(9)]
+
+# All different in each row
+for row in cells:
+    m.add(m.all_different(row))
+
+result = m.solve()
+```
+
+</details>
+
+<details>
+<summary><strong>Metaheuristics</strong></summary>
+
+### anneal
+Simulated annealing - accepts worse solutions probabilistically.
+
+```python
+result = anneal(
+    initial=initial_solution,
+    objective_fn=cost_function,
+    neighbors=random_neighbor,
+    temperature=1000,
+    cooling=0.9995
+)
+```
+
+### tabu_search
+Maintains a "tabu list" of recent moves to escape local optima.
+
+```python
+result = tabu_search(
+    initial=initial_solution,
+    objective_fn=cost_function,
+    neighbors=get_neighbors,  # returns [(move, solution), ...]
+    cooldown=10
+)
+```
+
+### evolve
+Genetic algorithm with selection, crossover, mutation.
+
+```python
+result = evolve(
+    objective_fn=fitness,
+    population=initial_pop,
+    crossover=my_crossover,
+    mutate=my_mutate,
+    max_gen=100
+)
+```
+
+</details>
+
+<details>
+<summary><strong>Continuous Optimization</strong></summary>
+
+### gradient_descent / momentum / adam
+First-order methods for differentiable functions.
+
+```python
+def grad_fn(x):
+    return [2 * x[0], 2 * x[1]]  # gradient of x^2 + y^2
+
+result = adam(grad_fn, x0=[5.0, 5.0])
+print(result.solution)  # [~0, ~0]
+```
+
+### bayesian_opt
+Gaussian process surrogate for expensive black-box functions.
+
+```python
+def expensive_fn(x):
+    # imagine this takes 10 minutes to evaluate
+    return (x[0] - 0.3)**2 + (x[1] - 0.7)**2
+
+result = bayesian_opt(expensive_fn, bounds=[(0, 1), (0, 1)], max_iter=30)
+```
+
+</details>
+
+<details>
+<summary><strong>Network Flow</strong></summary>
+
+### max_flow
+Ford-Fulkerson with BFS (Edmonds-Karp).
+
+```python
+graph = {
+    's': [('a', 10, 0), ('b', 5, 0)],
+    'a': [('b', 15, 0), ('t', 10, 0)],
+    'b': [('t', 10, 0)],
+    't': []
+}
+result = max_flow(graph, 's', 't')
+print(result.objective)  # total flow
+print(result.solution)   # edge flows dict
+```
+
+### min_cost_flow / solve_assignment
+Successive shortest paths for minimum cost flow.
+
+```python
+# Assignment problem: 3 workers, 3 tasks
+costs = [
+    [10, 5, 13],
+    [3, 9, 18],
+    [10, 6, 12]
+]
+result = solve_assignment(costs)
+# result.solution[i] = task assigned to worker i
+# result.objective = total cost
+```
+
+</details>
+
+---
+
+## Result Format
+
+All solvers return a consistent `Result` namedtuple:
+
+```python
+Result(
+    solution,     # best solution found
+    objective,    # objective value
+    iterations,   # solver iterations (pivots, generations, etc.)
+    evaluations,  # function evaluations
+    status        # OPTIMAL, FEASIBLE, INFEASIBLE, UNBOUNDED, MAX_ITER
+)
+```
+
+---
+
+## When to use what?
+
+| Problem | Solver |
+|---------|--------|
+| Linear constraints, continuous variables | `solve_lp` |
+| Linear constraints, some integers | `solve_milp` |
+| Boolean satisfiability | `solve_sat` |
+| Discrete variables, complex constraints | `Model` |
+| Combinatorial, good initial solution | `tabu_search`, `anneal` |
+| Combinatorial, no clue where to start | `evolve` |
+| Smooth, differentiable | `adam` |
+| Expensive black-box | `bayesian_opt` |
+| Assignment, matching, flow | `max_flow`, `solve_assignment` |
+
+---
+
+## Philosophy
+
+1. **Pure Python** - no numpy, no scipy, no compiled extensions
+2. **Readable** - each solvor fits in one file you can actually read
+3. **Consistent** - same Result format, same minimize/maximize convention
+4. **Practical** - solves real problems, or AoC puzzles
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
+
+## License
+
+[MIT License](LICENSE) - free for personal and commercial use.