edsger 0.1.5__cp311-cp311-macosx_11_0_arm64.whl → 0.1.6__cp311-cp311-macosx_11_0_arm64.whl

edsger/star.pyx

@@ -26,6 +26,13 @@ cdef functions:
 - _coo_to_csc_float64
 """
 
+# cython: language_level=3
+# cython: boundscheck=False
+# cython: wraparound=False
+# cython: embedsignature=False
+# cython: cdivision=True
+# cython: initializedcheck=False
+
 import numpy as np
 cimport numpy as cnp
 

edsger/utils.py

@@ -2,19 +2,20 @@
 graphs.
 """
 
+from typing import Tuple
 import numpy as np
 import pandas as pd
 
 
 def generate_random_network(
-    n_edges=100,
-    n_verts=20,
-    seed=124,
-    sort=True,
-    allow_negative_weights=False,
-    negative_weight_ratio=0.3,
-    weight_range=(0.1, 1.0),
-):
+    n_edges: int = 100,
+    n_verts: int = 20,
+    seed: int = 124,
+    sort: bool = True,
+    allow_negative_weights: bool = False,
+    negative_weight_ratio: float = 0.3,
+    weight_range: Tuple[float, float] = (0.1, 1.0),
+) -> pd.DataFrame:
     """
     Generate a random network with a specified number of edges and vertices.
 

{edsger-0.1.5.dist-info → edsger-0.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edsger
-Version: 0.1.5
+Version: 0.1.6
 Summary: Graph algorithms in Cython.
 Author-email: François Pacull <francois.pacull@architecture-performance.fr>
 Maintainer-email: François Pacull <francois.pacull@architecture-performance.fr>
@@ -48,6 +48,7 @@ Dynamic: license-file
 [![Python 3.9 | 3.10 | 3.11 | 3.12 | 3.13](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://pypi.org/project/edsger/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Cython lint: cython-lint](https://img.shields.io/badge/cython--lint-enabled-brightgreen.svg)](https://github.com/MarcoGorelli/cython-lint)
+[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 # Edsger
@@ -155,6 +156,53 @@ except ValueError as e:
 
     Error: Negative cycle detected in the graph
 
+## Breadth-First Search: Unweighted Directed Graphs
+
+The BFS (Breadth-First Search) algorithm finds shortest paths in directed graphs where edge weights are ignored (or all edges are treated as having equal weight). It's particularly efficient for finding paths based on the minimum number of hops/edges rather than weighted distances.
+
+```python
+from edsger.path import BFS
+
+# Create an unweighted directed graph
+edges_unweighted = pd.DataFrame({
+    'tail': [0, 0, 1, 2, 2, 3],
+    'head': [1, 2, 3, 3, 4, 4]
+})
+edges_unweighted
+```
+
+|    |   tail |   head |
+|---:|-------:|-------:|
+|  0 |      0 |      1 |
+|  1 |      0 |      2 |
+|  2 |      1 |      3 |
+|  3 |      2 |      3 |
+|  4 |      2 |      4 |
+|  5 |      3 |      4 |
+
+```python
+# Initialize BFS
+bfs = BFS(edges_unweighted)
+
+# Run BFS from vertex 0 with path tracking
+predecessors = bfs.run(vertex_idx=0, path_tracking=True)
+print("Predecessors:", predecessors)
+
+# Extract the path to vertex 4
+path = bfs.get_path(4)
+print("Path from 0 to 4:", path)
+```
+
+    Predecessors: [-9999     0     0     1     2]
+    Path from 0 to 4: [4 2 0]
+
+The BFS algorithm is ideal for directed graphs when:
+- All edges should be treated equally (ignoring edge weights)
+- You need to find paths with the minimum number of edges/hops
+- You want the fastest path-finding algorithm for unweighted directed graphs (O(V + E) time complexity)
+
+Note: The predecessor value -9999 indicates either the start vertex or an unreachable vertex. In the path output, vertices are listed from target to source.
+
 ## Installation
 
 ### Standard Installation
@@ -163,6 +211,80 @@ except ValueError as e:
 pip install edsger
 ```
 
+### Development Installation
+
+For development work, clone the repository and install in development mode:
+
+```bash
+git clone https://github.com/aetperf/Edsger.git
+cd Edsger
+pip install -r requirements-dev.txt
+pip install -e .
+```
+
+## Development
+
+This project uses several development tools to ensure code quality:
+
+### Type Checking
+
+We use [Pyright](https://github.com/microsoft/pyright) for static type checking:
+
+```bash
+# Run type checking
+make typecheck
+
+# Or directly with pyright
+pyright
+```
+
+For more details on type checking configuration and gradual typing strategy, see [TYPING.md](TYPING.md).
+
+### Running Tests
+
+```bash
+# Run all tests
+make test
+
+# Run with coverage
+make coverage
+```
+
+### Code Formatting and Linting
+
+```bash
+# Format code with black
+make format
+
+# Check code style
+make lint
+```
+
+### Pre-commit Hooks
+
+This project uses pre-commit hooks to maintain code quality. The hooks behave differently based on the branch:
+
+- **Protected branches (main, release*)**: All hooks run including pyright type checking
+- **Feature branches**: Only formatting hooks run (black, cython-lint) for faster commits
+  - Run `make typecheck` or `pre-commit run --all-files` to manually check types before merging
+
+```bash
+# Install pre-commit hooks
+pre-commit install
+
+# Run all hooks manually
+pre-commit run --all-files
+
+# Skip specific hooks if needed
+SKIP=pyright git commit -m "your message"
+```
+
+### Available Make Commands
+
+```bash
+make help  # Show all available commands
+```
+
 ## Why Use Edsger?
 
 Edsger is designed to be **dataframe-friendly**, providing seamless integration with pandas workflows for graph algorithms. Also it is rather efficient on Linux. Our benchmarks on the USA road network (23.9M vertices, 57.7M edges) demonstrate nice performance:
@@ -179,4 +301,4 @@ Edsger is licensed under the MIT License. See the LICENSE file for more details.
 
 ## Contact
 
-For any questions or inquiries, please contact François Pacull at [francois.pacull@architecture-performance.fr](mailto:francois.pacull@architecture-performance.fr).
+For any questions or inquiries, please contact me at [francois.pacull@architecture-performance.fr](mailto:francois.pacull@architecture-performance.fr).

edsger-0.1.6.dist-info/RECORD

@@ -0,0 +1,40 @@
+edsger-0.1.6.dist-info/RECORD,,
+edsger-0.1.6.dist-info/WHEEL,sha256=qxQkdhERtGxJzqnVOBnucx1aUmU2n3HmuzYdln_LyOw,109
+edsger-0.1.6.dist-info/top_level.txt,sha256=QvhzFORJIIot6GzSnDrtGa9KQt9iifCbOC5ULlzY5dg,7
+edsger-0.1.6.dist-info/METADATA,sha256=i2o0CNUcmx7lGlsDzZch3nh0v91NXNZrOUwd1OVV3vE,10258
+edsger-0.1.6.dist-info/licenses/LICENSE,sha256=eNjfz5CInLrVdczJbhazCKtb8-0qB0UaXZ3bXN0zio0,1111
+edsger-0.1.6.dist-info/licenses/AUTHORS.rst,sha256=9lqpqjiC4XukK7jdxXwKJJrddqwCV2DjpYTqhpP6znA,105
+edsger/spiess_florian.c,sha256=olSuOMSR8ee-iFBmUC2gYBAx9zRYNCfVGCVhTXhWl0s,1367225
+edsger/dijkstra.c,sha256=EuQkqlHjl6o9SoEdIDMAMn9Jy2w1NH6Zjm6XRFsNVg0,1686208
+edsger/bellman_ford.pyx,sha256=lFNLfuy85ZEyWFaJ4pf8xblNjp1UmL804Tem8rNot7c,17056
+edsger/_version.py,sha256=l1lWRV5fzx6-C3xpWdEYCx3Y5TNykf_HgoEs12q6cfQ,21
+edsger/bellman_ford.c,sha256=Yr95RS-kzzGYtkzKDR8_FjwSQhH3ijTDY0uiG98ndEA,1392627
+edsger/spiess_florian.cpython-311-darwin.so,sha256=VLRDlEAd-5QgiI9hEj5Hu13pTLVWHZHu1lKh5bVR1hg,275880
+edsger/commons.c,sha256=pBHEAwbniCTmdBnDAUZrGhEf2D08MJrtsuZV3Q8gPtk,343338
+edsger/star.c,sha256=fwNKxz48TsKTFLk68PjJxEbnjtCROf-Rf9DPgg8Z28I,1337551
+edsger/path_tracking.cpython-311-darwin.so,sha256=HqrwRlWTHL7AqS2lc3GYakc1XIsotTbAoFiYZ0P88P4,191504
+edsger/commons.pyx,sha256=NokCkVYss7f1Q9VRFeruByZwp7IXBmqXLzsVVORQ3oU,977
+edsger/pq_4ary_dec_0b.pxd,sha256=MbQuP1y1t6_2fJRkpqRPV2lmatwfqOxjsrb1GLfEudA,1065
+edsger/__init__.py,sha256=CoqO_GHq5NC94S2JrYjf6dVGOKnxJ2TRBDOjikyscOY,40
+edsger/prefetch_compat.h,sha256=6HfoyHI0dQE_MDsYHjUiX77Hg_z8eH6kRwN_5RAhbYo,806
+edsger/path_tracking.c,sha256=HD79UvkDecuUs43XVc6Hhzt44KKr2bgnJSUiN-BCkUA,1148355
+edsger/spiess_florian.pyx,sha256=INTaELmQxvAAF_QilEwe_hQwIAW7034A4TIA-U5oaBw,9738
+edsger/bfs.cpython-311-darwin.so,sha256=s-2ZOZfAaUWQxS8meAdLIA6nJfXAZivNuGjs6Ga-MkQ,231368
+edsger/pq_4ary_dec_0b.c,sha256=WAEzh-ABau9h-nkgq3FaooHaYm1aHN0OphXbDvvJX00,1374148
+edsger/dijkstra.cpython-311-darwin.so,sha256=CUwR1f49z1_9XbIkK-BIDeamPmUEjP-wV7rjn-fDl7g,366624
+edsger/networks.py,sha256=brp1iX1rafW8O6bEyKn2BFxmY5z8WWBJxKXdPRyohXI,10372
+edsger/commons.pxd,sha256=P9-n7ChbSIMSBRRY_lY3gBwXYUSvqJG-S_6e0dZTYU8,439
+edsger/.gitignore,sha256=tWvEr3sBkY2ODntRp4_IUz3cidH-xu1efiOQK9DfK04,12
+edsger/utils.py,sha256=FIe8ZQ_FMDJR1zPapHXz2sbjoq9vrIAPtkeFmM5YBJw,4711
+edsger/pq_4ary_dec_0b.pyx,sha256=b8JgVZzwx0eq42-Q85OwwwosmKBuCR6AYHDLGKl7hSk,17968
+edsger/graph_importer.py,sha256=qhKYY8Zsb_yKU9qPkWSG7ugEVJ5w8_7CDO5cCTmSP4M,11485
+edsger/bfs.pyx,sha256=UJ8X16G7NSylIw900a1n1_oVa2sl6LQltUEHwO3lnz0,7768
+edsger/commons.cpython-311-darwin.so,sha256=ubK9bumZZsKmp8S5uUcrKL3qbrj8WvtU2-GDDmCv_Ao,58096
+edsger/path_tracking.pyx,sha256=Cmb4w-0BUyM7uxCP-4PfVi4OaLspu_FVdjSSOCiDRe8,1979
+edsger/star.cpython-311-darwin.so,sha256=zvvYcDI51FmPDFsKiAc3zDM1DAdAmDEuWLGFrpNOjwU,251000
+edsger/path.py,sha256=weKm16O3xNU5n4QWSpKgiefczw5DdFpC86OP0dH0R5o,78877
+edsger/dijkstra.pyx,sha256=nxhbZJoohCaIVbQArsC4kTVzMTogMz1u44La_rc08h4,36685
+edsger/star.pyx,sha256=jCCwjELvm19dYPtZyB7q5TVRz4ZrR5FsO116yy_tiNY,9418
+edsger/bellman_ford.cpython-311-darwin.so,sha256=XUyNd77gaADldctXpCRl7MIwMkPbvInErQQkntC1OdE,267072
+edsger/pq_4ary_dec_0b.cpython-311-darwin.so,sha256=twz6P7igpgZYfhOF_JkJikBBNBBs4gwj4lkcdt9y07o,231208
+edsger/bfs.c,sha256=njGDEeOvujzHod-5T9wzMZcTV4Q80iYMrRZ0MMgDgvQ,1306768

edsger-0.1.5.dist-info/RECORD

@@ -1,36 +0,0 @@
-edsger-0.1.5.dist-info/RECORD,,
-edsger-0.1.5.dist-info/WHEEL,sha256=qxQkdhERtGxJzqnVOBnucx1aUmU2n3HmuzYdln_LyOw,109
-edsger-0.1.5.dist-info/top_level.txt,sha256=QvhzFORJIIot6GzSnDrtGa9KQt9iifCbOC5ULlzY5dg,7
-edsger-0.1.5.dist-info/METADATA,sha256=LF7X-0Qgi0OuVqY_I_uNsKr5xfCnPHYbOJ-AuPXN9jY,7111
-edsger-0.1.5.dist-info/licenses/LICENSE,sha256=eNjfz5CInLrVdczJbhazCKtb8-0qB0UaXZ3bXN0zio0,1111
-edsger-0.1.5.dist-info/licenses/AUTHORS.rst,sha256=9lqpqjiC4XukK7jdxXwKJJrddqwCV2DjpYTqhpP6znA,105
-edsger/spiess_florian.c,sha256=bAxIe7SjZi3TDAdwT5py4LMiz_S14NOm_z62l-ZP8ts,1356425
-edsger/dijkstra.c,sha256=KKT9sI0KGYnvDyEhP_Wr0j2GoMPSVfCWEQypIkBQP6c,1658053
-edsger/bellman_ford.pyx,sha256=swabcGIjYIeFBud5VdlPAQENv3_AXULnSNLXaQSpE3U,16884
-edsger/_version.py,sha256=Nmswip0IUvJenHIhdfSyTYurDcwWTvOQ8mPDREtwE1o,21
-edsger/bellman_ford.c,sha256=S10CgCkQO7hv9o2Ie_rfe7Cl2fytw_CtL7B-Zro66CA,1374207
-edsger/spiess_florian.cpython-311-darwin.so,sha256=kc0blCEvg75DAovaJnV5p7lEdQUhu7P83IKeYCgFka8,276280
-edsger/commons.c,sha256=li8n04xPc7bKullEhjVHTxS6s_WN8jCncKeWb3hJEjI,343126
-edsger/star.c,sha256=VHQUKaeAxlXGRY5NZt0Xyl6gUNZetjk598JX6MKuj98,1319723
-edsger/path_tracking.cpython-311-darwin.so,sha256=Uhy-5yTJjbP-xERsiqbizdRCfS0ZsfaFmgp6CAGU0XY,191152
-edsger/commons.pyx,sha256=rPWrq1zfN_IuTgLgvvQe8ma7bU1e3V8lWbBEFH5Vaw8,805
-edsger/pq_4ary_dec_0b.pxd,sha256=MbQuP1y1t6_2fJRkpqRPV2lmatwfqOxjsrb1GLfEudA,1065
-edsger/__init__.py,sha256=CoqO_GHq5NC94S2JrYjf6dVGOKnxJ2TRBDOjikyscOY,40
-edsger/prefetch_compat.h,sha256=6HfoyHI0dQE_MDsYHjUiX77Hg_z8eH6kRwN_5RAhbYo,806
-edsger/path_tracking.c,sha256=LESlwOk6leVuhrMy0CNN01Hgk_Bghi7G0oRBM8zuZrk,1144589
-edsger/spiess_florian.pyx,sha256=9CrcMyzwSXaC_EdSl1uiD9yhFH6ACtooZOMfYw6vhvA,9566
-edsger/pq_4ary_dec_0b.c,sha256=jNibkKCmxgC8Q_Y-lerC-SbqjIoDH7J6YgY6ohPJdLE,1367901
-edsger/dijkstra.cpython-311-darwin.so,sha256=8cixMXjmFRYZtMAqQ1Bn-aMDQsCQOeyTMKf6C9A1HFc,366992
-edsger/networks.py,sha256=o_dKC6fcxsqWr3fE0m5sUQkpZO-0B2x-w51l_1fyzAc,10316
-edsger/commons.pxd,sha256=P9-n7ChbSIMSBRRY_lY3gBwXYUSvqJG-S_6e0dZTYU8,439
-edsger/.gitignore,sha256=tWvEr3sBkY2ODntRp4_IUz3cidH-xu1efiOQK9DfK04,12
-edsger/utils.py,sha256=C38-cgHUPf5XEjT7359vu5xO8hl-fYAZsYL_mcp8Gts,4601
-edsger/pq_4ary_dec_0b.pyx,sha256=fRJCT79GsCocZgpostfn7t5nkNQALK0A93OJK4fxJR0,17796
-edsger/commons.cpython-311-darwin.so,sha256=ERBQGGHVxdBdlO2TWSLHql-S6SZKtHPaXowj2aikGF4,58016
-edsger/path_tracking.pyx,sha256=uO06fzL8V5KeI3w5FPVJJ13ZtdFGTol6oUjVX4Jjxxs,1807
-edsger/star.cpython-311-darwin.so,sha256=ucRFvAIuEsinmmr5nFY2hbbZDazqU9Pl0PNKcwdL0G4,250648
-edsger/path.py,sha256=MJTK4QJKfJnX0FjRC8HnDm0RDOKcoAOdY1a6mQq5LpU,57316
-edsger/dijkstra.pyx,sha256=R8DM9LlHXUOZ38t7qINaB1t_QBP_aeWBOqIHHVN9W10,36513
-edsger/star.pyx,sha256=MVS4kylmMAXOHm8liTfTMLzrr0jhA3cRU3-KCfVjNNM,9246
-edsger/bellman_ford.cpython-311-darwin.so,sha256=8tTxOMqamB43XPboGfMU3j6ZyIiCs2wwyA155D5Qntw,250816
-edsger/pq_4ary_dec_0b.cpython-311-darwin.so,sha256=C-1t3STU2-O-Fo5ArssE7ZR4TI6J4s4WqzhgTeEEzkI,214440