turboswarm 0.1.0__tar.gz

turboswarm-0.1.0/Cargo.lock

@@ -0,0 +1,406 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "crossbeam-deque"
+version = "0.8.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9dd111b7b7f7d55b72c0a6ae361660ee5853c9af73f70c3c2ef6858b950e2e51"
+dependencies = [
+ "crossbeam-epoch",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-epoch"
+version = "0.9.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5b82ac4a3c2ca9c3460964f020e1402edd5753411d7737aa39c3714ad1b5420e"
+dependencies = [
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-utils"
+version = "0.8.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28"
+
+[[package]]
+name = "either"
+version = "1.16.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "91622ff5e7162018101f2fea40d6ebf4a78bbe5a49736a2020649edf9693679e"
+
+[[package]]
+name = "getrandom"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ff2abc00be7fca6ebc474524697ae276ad847ad0a6b3faa4bcb027e9a4614ad0"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wasi",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.186"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
+
+[[package]]
+name = "matrixmultiply"
+version = "0.3.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a06de3016e9fae57a36fd14dba131fccf49f74b40b7fbdb472f96e361ec71a08"
+dependencies = [
+ "autocfg",
+ "rawpointer",
+]
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "ndarray"
+version = "0.16.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "882ed72dce9365842bf196bdeedf5055305f11fc8c03dee7bb0194a6cad34841"
+dependencies = [
+ "matrixmultiply",
+ "num-complex",
+ "num-integer",
+ "num-traits",
+ "portable-atomic",
+ "portable-atomic-util",
+ "rawpointer",
+]
+
+[[package]]
+name = "num-complex"
+version = "0.4.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "73f88a1307638156682bada9d7604135552957b7818057dcef22705b4d509495"
+dependencies = [
+ "num-traits",
+]
+
+[[package]]
+name = "num-integer"
+version = "0.1.46"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7969661fd2958a5cb096e56c8e1ad0444ac2bbcd0061bd28660485a44879858f"
+dependencies = [
+ "num-traits",
+]
+
+[[package]]
+name = "num-traits"
+version = "0.2.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "numpy"
+version = "0.22.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "edb929bc0da91a4d85ed6c0a84deaa53d411abfb387fc271124f91bf6b89f14e"
+dependencies = [
+ "libc",
+ "ndarray",
+ "num-complex",
+ "num-integer",
+ "num-traits",
+ "pyo3",
+ "rustc-hash",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "portable-atomic-util"
+version = "0.2.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c2a106d1259c23fac8e543272398ae0e3c0b8d33c88ed73d0cc71b0f1d902618"
+dependencies = [
+ "portable-atomic",
+]
+
+[[package]]
+name = "ppv-lite86"
+version = "0.2.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9"
+dependencies = [
+ "zerocopy",
+]
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pso-core"
+version = "0.1.0"
+dependencies = [
+ "rand",
+ "rand_chacha",
+ "rayon",
+]
+
+[[package]]
+name = "pso-py"
+version = "0.1.0"
+dependencies = [
+ "numpy",
+ "pso-core",
+ "pyo3",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f402062616ab18202ae8319da13fa4279883a2b8a9d9f83f20dbade813ce1884"
+dependencies = [
+ "cfg-if",
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b14b5775b5ff446dd1056212d778012cbe8a0fbffd368029fd9e25b514479c38"
+dependencies = [
+ "once_cell",
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ab5bcf04a2cdcbb50c7d6105de943f543f9ed92af55818fd17b660390fc8636"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fd24d897903a9e6d80b968368a34e1525aeb719d568dba8b3d4bfa5dc67d453"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "36c011a03ba1e50152b4b394b479826cad97e7a21eb52df179cd91ac411cbfbe"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.46"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dfbc457d0c7a0759a614551b11a6409e5951f6c7537be1f1b7682b9ae9230368"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rand"
+version = "0.8.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5ca0ecfa931c29007047d1bc58e623ab12e5590e8c7cc53200d5202b69266d8a"
+dependencies = [
+ "libc",
+ "rand_chacha",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_chacha"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88"
+dependencies = [
+ "ppv-lite86",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_core"
+version = "0.6.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
+dependencies = [
+ "getrandom",
+]
+
+[[package]]
+name = "rawpointer"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "60a357793950651c4ed0f3f52338f53b2f809f32d83a07f72909fa13e4c6c1e3"
+
+[[package]]
+name = "rayon"
+version = "1.12.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fb39b166781f92d482534ef4b4b1b2568f42613b53e5b6c160e24cfbfa30926d"
+dependencies = [
+ "either",
+ "rayon-core",
+]
+
+[[package]]
+name = "rayon-core"
+version = "1.13.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "22e18b0f0062d30d4230b2e85ff77fdfe4326feb054b9783a3460d8435c8ab91"
+dependencies = [
+ "crossbeam-deque",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "rustc-hash"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2"
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+
+[[package]]
+name = "syn"
+version = "2.0.118"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1b9ae57f904213ebb649ce6895b8a66c66f0203b9319718f69a5612a065b1422"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.12.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"
+
+[[package]]
+name = "wasi"
+version = "0.11.1+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b"
+
+[[package]]
+name = "zerocopy"
+version = "0.8.52"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce1022995ff5ff5d841ad7d994facc23098cd40152f2c1d11cd607c6f530653f"
+dependencies = [
+ "zerocopy-derive",
+]
+
+[[package]]
+name = "zerocopy-derive"
+version = "0.8.52"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1ae7f38b72ec2a254e2b87ef277cf2cd4fb97cbebf944faa6f33354da0867930"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]

turboswarm-0.1.0/Cargo.toml

@@ -0,0 +1,16 @@
+[workspace]
+resolver = "2"
+members = ["crates/pso-core", "crates/pso-py"]
+
+[workspace.package]
+version = "0.1.0"
+edition = "2021"
+license = "MIT"
+authors = ["Jose L. Salmeron <joseluis.salmeron@gmail.com>"]
+repository = "https://github.com/turboswarm/turboswarm.github.io"
+homepage = "https://github.com/turboswarm/turboswarm.github.io"
+
+[workspace.dependencies]
+rand = "0.8"
+rand_chacha = "0.3"   # RNG with reproducible seed (reproducibility matters)
+rayon = "1"           # data parallelism for parallel objective evaluation

turboswarm-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tu Nombre
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

turboswarm-0.1.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: turboswarm
+Version: 0.1.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: mkdocs-material ; extra == 'docs'
+Requires-Dist: mkdocstrings[python] ; extra == 'docs'
+Requires-Dist: black ; extra == 'docs'
+Requires-Dist: jupyter ; extra == 'notebooks'
+Requires-Dist: plotly ; extra == 'notebooks'
+Provides-Extra: docs
+Provides-Extra: notebooks
+License-File: LICENSE
+Summary: Particle Swarm Optimization with a Rust core
+Keywords: pso,optimization,swarm,metaheuristics
+Author-email: "Jose L. Salmeron" <joseluis.salmeron@gmail.com>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/turboswarm/turboswarm.github.io
+Project-URL: Issues, https://github.com/turboswarm/turboswarm.github.io/issues
+Project-URL: Repository, https://github.com/turboswarm/turboswarm.github.io
+
+# turboswarm
+
+**Particle Swarm Optimization** with a compute core in **Rust** and an API in
+**Python**. Focused on visualization, variant comparison and clear code.
+Supports real, integer, binary and mixed variables, constraints and
+multi-objective optimization.
+
+## Installation
+
+From source (development), with [maturin](https://www.maturin.rs/):
+
+```bash
+pip install maturin
+python -m venv .venv && source .venv/bin/activate
+maturin develop --release      # compiles the Rust core and installs it
+```
+
+## Usage
+
+```python
+import turboswarm as pso
+
+# Native benchmark (fast, in Rust, without the GIL)
+r = pso.minimize("rastrigin", bounds=[(-5.12, 5.12)] * 2, seed=42)
+
+# Your own function in Python
+r = pso.minimize(lambda x: sum(xi**2 for xi in x), bounds=[(-5, 5)] * 3)
+
+# Integer variables
+r = pso.minimize(f, bounds=[(-10, 10)] * 2, integer=True)
+
+# Variant and topology by name
+r = pso.minimize("ackley", bounds=[(-32.768, 32.768)] * 2,
+                 velocity="fips", topology="ring", seed=1)
+
+print(r.best_position, r.best_value)
+```
+
+### Parameters of `minimize`
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `objective` | — | callable `f(list)->float`, or name of a native benchmark |
+| `bounds` | — | list of `(min, max)` per dimension |
+| `integer` / `binary` | `False` | optimize over integers / `{0,1}` |
+| `var_types` | `None` | per-dimension `"real"`/`"integer"`/`"binary"` (mixed) |
+| `n_particles` | `30` | swarm size |
+| `max_iter` | `100` | iterations |
+| `w, c1, c2` | `0.729, 1.494, 1.494` | inertia, cognitive, social |
+| `velocity` | `"inertia"` | `"inertia"`, `"constriction"`, `"fips"` |
+| `topology` | `"global"` | `"global"`, `"ring"`, `"vonneumann"`, `"random"` |
+| `bounds_handling` | `"clamp"` | `"clamp"`, `"reflect"`, `"wrap"`, `"reinit"` |
+| `seed` | `None` | seed (fix it for reproducibility) |
+| `record_history` | `True` | store the trace for visualization |
+| `v_max` | `None` | clamp each velocity component to `[-v_max, v_max]` |
+| `patience` / `tol` | `0` / `0.0` | stop after `patience` iters without `>tol` improvement |
+| `max_evals` / `target` / `max_time` | `None` | stop on evaluation / value / time budget |
+| `constraints` / `penalty` | `None` / `1e6` | inequality constraints `g(x)<=0` via penalty |
+| `callback` | `None` | `callback(iteration, best_value)`; return `False` to stop |
+| `vectorized` | `False` | objective receives the whole swarm as a NumPy array |
+
+**Native benchmarks:** `sphere`, `rastrigin`, `rosenbrock`, `ackley`,
+`griewank`, `schwefel`. Their metadata (recommended bound and optimum) are in
+`pso.benchmark_info(name) -> (bound, optimum)`.
+
+> FIPS performs better with local topologies (`"ring"`, `"vonneumann"`). The
+> `"constriction"` and `"fips"` variants derive their factor from `c1 + c2`.
+
+### Result (`PsoResult`)
+
+- `best_position` — list of floats (whole-valued for integer/binary dims)
+- `best_value` — float
+- `convergence` — best value per iteration (convergence curve)
+- `history` — `history[iter][particle][dim]` (empty if `record_history=False`)
+- `evaluations` — number of objective evaluations performed
+- `stop_reason` — `"max_iterations"`, `"target"`, `"max_evaluations"`,
+  `"stagnation"`, `"max_time"` or `"callback"`
+
+### Multi-objective (MOPSO)
+
+`minimize_multi` returns a `ParetoFront` (`.positions`, `.objectives`):
+
+```python
+front = pso.minimize_multi(
+    lambda x: [sum(xi**2 for xi in x), sum((xi - 2) ** 2 for xi in x)],
+    bounds=[(-5, 5)] * 2, seed=42,
+)
+print(len(front))            # non-dominated solutions
+```
+
+## Visualization
+
+```python
+import matplotlib.pyplot as plt
+
+pso.viz.plot_convergence(r); plt.show()
+pso.viz.compare({"inertia": rA, "fips": rB}); plt.show()
+pso.viz.plot_pareto(front); plt.show()   # objective space of a Pareto front
+
+anim = pso.viz.animate_swarm(r, pso.benchmarks.rastrigin, [(-5.12, 5.12)] * 2)
+# in a notebook:  from IPython.display import HTML; HTML(anim.to_jshtml())
+```
+
+`animate_swarm` only supports 2D problems and requires `record_history=True`.
+
+## Documentation
+
+A navigable documentation portal (narrative guide + API reference) is built with
+MkDocs Material:
+
+```bash
+pip install -e ".[docs]"
+./scripts/build-docs.sh --serve   # http://127.0.0.1:8000
+```
+
+## License
+
+MIT.
+

turboswarm-0.1.0/crates/pso-core/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "pso-core"
+description = "Particle Swarm Optimization core: extensible and modular"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+authors.workspace = true
+repository.workspace = true
+homepage.workspace = true
+readme = "README.md"
+documentation = "https://docs.rs/pso-core"
+keywords = ["pso", "optimization", "swarm", "metaheuristics"]
+categories = ["science", "algorithms"]
+
+[dependencies]
+rand.workspace = true
+rand_chacha.workspace = true
+rayon.workspace = true
+
+[dev-dependencies]
+# tests use only std + the crate itself

turboswarm-0.1.0/crates/pso-core/README.md

@@ -0,0 +1,40 @@
+# pso-core
+
+The Rust core of [**turboswarm**](https://github.com/turboswarm/turboswarm.github.io)
+— a Particle Swarm Optimization library. Pure Rust, no FFI, zero-cost generics.
+
+The PSO loop knows nothing about any concrete variant: everything that changes
+lives behind three traits — `SearchSpace`, `Velocity` and `Topology`. Adding a
+variant means implementing one trait, without touching the core.
+
+## Features
+
+- Velocity variants: inertia, constriction (Clerc-Kennedy) and FIPS.
+- Topologies: global, ring, Von Neumann and random.
+- Spaces: continuous, integer (with discretization) and mixed.
+- Multi-objective optimization (MOPSO) in `pso_core::mopso`.
+- Parallel objective evaluation (`minimize_parallel`, via `rayon`).
+- Run control: target / evaluation / time budgets, stagnation, callback.
+- Benchmarks with metadata (sphere, rastrigin, rosenbrock, ackley, griewank,
+  schwefel).
+
+## Example
+
+```rust
+use pso_core::prelude::*;
+use pso_core::benchmarks::rastrigin;
+
+let space = ContinuousSpace::uniform(2, -5.12, 5.12);
+let velocity = InertiaVelocity::new(0.729, 1.49445, 1.49445);
+let params = PsoParams { seed: Some(42), ..Default::default() };
+
+let result = Pso::new(space, velocity, GlobalBest::new(), params).minimize(rastrigin);
+assert!(result.best_value < 1e-3);
+```
+
+The Python bindings live in the `turboswarm` package
+(`pip install turboswarm`). Full docs: <https://turboswarm.github.io/>.
+
+## License
+
+MIT

turboswarm-0.1.0/crates/pso-core/examples/basic.rs

@@ -0,0 +1,27 @@
+//! Usage example from Rust. Run with:
+//!   cargo run --example basic -p pso-core
+
+use pso_core::benchmarks::rastrigin;
+use pso_core::prelude::*;
+
+fn main() {
+    // A 2-D box with the same range on every dimension.
+    // (For different ranges per dimension, use
+    //  `ContinuousSpace::new(vec![(-5.0, 5.0), (0.0, 100.0)])`.)
+    let space = ContinuousSpace::uniform(2, -5.12, 5.12);
+    let velocity = InertiaVelocity::new(0.9, 1.49445, 1.49445).with_decay(0.4);
+    let params = PsoParams {
+        n_particles: 40,
+        max_iterations: 200,
+        seed: Some(42),
+        record_history: true,
+        ..Default::default()
+    };
+
+    let pso = Pso::new(space, velocity, GlobalBest::new(), params);
+    let result = pso.minimize(rastrigin);
+
+    println!("Best position: {:?}", result.best_position);
+    println!("Best value:    {:.6}", result.best_value);
+    println!("Iterations:    {}", result.history.iterations());
+}