edsger 0.1.3__cp312-cp312-win_amd64.whl → 0.1.5__cp312-cp312-win_amd64.whl

edsger/utils.py

@@ -6,7 +6,15 @@ import numpy as np
 import pandas as pd
 
 
-def generate_random_network(n_edges=100, n_verts=20, seed=124, sort=True):
+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),
+):
     """
     Generate a random network with a specified number of edges and vertices.
 
@@ -20,6 +28,14 @@ def generate_random_network(n_edges=100, n_verts=20, seed=124, sort=True):
         The seed for the random number generator. Default is 124.
     sort : bool, optional
         Whether to sort the edges by tail and head vertices. Default is True.
+    allow_negative_weights : bool, optional
+        Whether to allow negative edge weights. Default is False (positive weights only).
+    negative_weight_ratio : float, optional
+        Proportion of edges that should have negative weights when allow_negative_weights=True.
+        Must be between 0.0 and 1.0. Default is 0.3 (30% negative).
+    weight_range : tuple of float, optional
+        Range of absolute values for weights as (min, max). Default is (0.1, 1.0).
+        When allow_negative_weights=True, negative weights will be in range (-max, -min).
 
     Returns
     -------
@@ -28,6 +44,8 @@ def generate_random_network(n_edges=100, n_verts=20, seed=124, sort=True):
 
     Examples
     --------
+    Generate a graph with positive weights only (default):
+
     >>> generate_random_network(n_edges=5, n_verts=3, seed=42)
        tail  head    weight
     0     0     2  0.975622
@@ -36,20 +54,66 @@ def generate_random_network(n_edges=100, n_verts=20, seed=124, sort=True):
     3     1     2  0.786064
     4     2     0  0.761140
 
+    Generate a graph with mixed positive and negative weights:
+
+    >>> generate_random_network(n_edges=5, n_verts=3, seed=42,
+    ...                        allow_negative_weights=True, negative_weight_ratio=0.4)
+       tail  head    weight
+    0     0     2  0.975622
+    1     1     0 -0.128114
+    2     1     0  0.450386
+    3     1     2 -0.786064
+    4     2     0  0.761140
 
     Notes
     -----
     The 'tail' and 'head' columns represent the source and destination vertices of each edge,
-    respectively. The 'weight' column represents the weight of each edge, which is a random
-    float between 0 and 1.
+    respectively. The 'weight' column represents the weight of each edge.
+
+    When allow_negative_weights=False (default), weights are random floats between
+    weight_range[0] and weight_range[1].
+
+    When allow_negative_weights=True, approximately negative_weight_ratio proportion of edges
+    will have negative weights, useful for testing algorithms like Bellman-Ford that support
+    negative edge weights.
 
     If `sort` is True, the DataFrame is sorted by the 'tail' and 'head' columns and the index
     is reset.
     """
+    # Validate parameters
+    if not 0.0 <= negative_weight_ratio <= 1.0:
+        raise ValueError("negative_weight_ratio must be between 0.0 and 1.0")
+    if (
+        len(weight_range) != 2
+        or weight_range[0] <= 0
+        or weight_range[1] <= weight_range[0]
+    ):
+        raise ValueError("weight_range must be (min, max) with 0 < min < max")
+
     rng = np.random.default_rng(seed=seed)
     tail = rng.integers(low=0, high=n_verts, size=n_edges)
     head = rng.integers(low=0, high=n_verts, size=n_edges)
-    weight = rng.random(size=n_edges)
+
+    # Generate weights
+    if allow_negative_weights:
+        # Generate weights in the specified range
+        weight = rng.uniform(low=weight_range[0], high=weight_range[1], size=n_edges)
+
+        # Randomly select edges to have negative weights
+        n_negative = int(n_edges * negative_weight_ratio)
+        if n_negative > 0:
+            negative_indices = rng.choice(n_edges, size=n_negative, replace=False)
+            weight[negative_indices] *= -1
+    else:
+        # Original behavior: positive weights in range [weight_range[0], weight_range[1]]
+        if weight_range == (0.1, 1.0):
+            # Keep backward compatibility for default case
+            weight = rng.random(size=n_edges)
+        else:
+            weight = rng.uniform(
+                low=weight_range[0], high=weight_range[1], size=n_edges
+            )
+
     edges = pd.DataFrame(data={"tail": tail, "head": head, "weight": weight})
     if sort:
         edges.sort_values(by=["tail", "head"], inplace=True)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edsger
-Version: 0.1.3
+Version: 0.1.5
 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>
@@ -42,6 +42,7 @@ Dynamic: license-file
 
 ![Tests Status](https://github.com/aetperf/edsger/actions/workflows/tests.yml/badge.svg?branch=release)
 [![codecov](https://codecov.io/gh/aetperf/edsger/branch/release/graph/badge.svg)](https://codecov.io/gh/aetperf/edsger)
+[![Documentation Status](https://readthedocs.org/projects/edsger/badge/?version=latest)](https://edsger.readthedocs.io/en/latest/?badge=latest)
 [![PyPI version](https://img.shields.io/pypi/v/edsger.svg?refresh=1)](https://pypi.org/project/edsger/)
 [![Downloads](https://static.pepy.tech/badge/edsger)](https://pepy.tech/project/edsger)
 [![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/)
@@ -53,7 +54,7 @@ Dynamic: license-file
 
 *Graph algorithms in Cython*
 
-Welcome to our Python library for graph algorithms. So far, the library only includes Dijkstra's algorithm but we should add a range of common path algorithms later. It is also open-source and easy to integrate with other Python libraries. To get started, simply install the library using pip, and import it into your Python project.
+Welcome to our Python library for graph algorithms. The library includes both Dijkstra's and Bellman-Ford's algorithms, with plans to add more common path algorithms later. It is also open-source and easy to integrate with other Python libraries. To get started, simply install the library using pip, and import it into your Python project.
 
 Documentation : [https://edsger.readthedocs.io/en/latest/](https://edsger.readthedocs.io/en/latest/)
 
@@ -97,14 +98,77 @@ print("Shortest paths:", shortest_paths)
 
 We get the shortest paths from the source node 0 to all other nodes in the graph. The output is an array with the shortest path length to each node. A path length is the sum of the weights of the edges in the path.
 
+## Bellman-Ford Algorithm: Handling Negative Weights
+
+The Bellman-Ford algorithm can handle graphs with negative edge weights and detect negative cycles, making it suitable for more complex scenarios than Dijkstra's algorithm.
+
+```python
+from edsger.path import BellmanFord
+
+# Create a graph with negative weights
+edges_negative = pd.DataFrame({
+    'tail': [0, 0, 1, 1, 2, 3],
+    'head': [1, 2, 2, 3, 3, 4],
+    'weight': [1, 4, -2, 5, 1, 3]  # Note the negative weight
+})
+edges_negative
+```
+
+|    |   tail |   head |   weight |
+|---:|-------:|-------:|---------:|
+|  0 |      0 |      1 |      1.0 |
+|  1 |      0 |      2 |      4.0 |
+|  2 |      1 |      2 |     -2.0 |
+|  3 |      1 |      3 |      5.0 |
+|  4 |      2 |      3 |      1.0 |
+|  5 |      3 |      4 |      3.0 |
+
+```python
+# Initialize and run Bellman-Ford
+bf = BellmanFord(edges_negative)
+shortest_paths = bf.run(vertex_idx=0)
+print("Shortest paths:", shortest_paths)
+```
+
+    Shortest paths: [ 0.  1. -1.  0.  3.]
+
+The Bellman-Ford algorithm finds the optimal path even with negative weights. In this example, the shortest path from node 0 to node 2 has length -1 (going 0→1→2 with weights 1 + (-2) = -1), which is shorter than the direct path 0→2 with weight 4.
+
+### Negative Cycle Detection
+
+Bellman-Ford can also detect negative cycles, which indicate that no shortest path exists:
+
+```python
+# Create a graph with a negative cycle
+edges_cycle = pd.DataFrame({
+    'tail': [0, 1, 2],
+    'head': [1, 2, 0],
+    'weight': [1, -2, -1]  # Cycle 0→1→2→0 has total weight -2
+})
+
+bf_cycle = BellmanFord(edges_cycle)
+try:
+    bf_cycle.run(vertex_idx=0)
+except ValueError as e:
+    print("Error:", e)
+```
+
+    Error: Negative cycle detected in the graph
+
+## Installation
+
+### Standard Installation
+
+```bash
+pip install edsger
+```
+
 ## Why Use Edsger?
 
-Edsger is designed to be **dataframe-friendly**, providing seamless integration with pandas workflows for graph algorithms. Also it is rather efficient. Our benchmarks on the USA road network (23.9M vertices, 57.7M edges) demonstrate nice performance:
+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:
 
 <img src="https://raw.githubusercontent.com/aetperf/edsger/release/docs/source/assets/dijkstra_benchmark_comparison.png" alt="Dijkstra Performance Comparison" width="700">
 
-*Benchmark performed on Intel i9-12900H Linux laptop.*
-
 ## Contributing
 
 We welcome contributions to the Edsger library. If you have any suggestions, bug reports, or feature requests, please open an issue on our [GitHub repository](https://github.com/aetperf/Edsger).

edsger-0.1.5.dist-info/RECORD

@@ -0,0 +1,29 @@
+edsger/.gitignore,sha256=mr9Izcwvjgv215xjRKhWEZ7vsyrKWhMqvWjSLHRYDjk,13
+edsger/__init__.py,sha256=lgtGe3cqdwWdO1DLEOx7fX3i8D4Z_2rXHSq7Xecf-NM,41
+edsger/_version.py,sha256=Nmswip0IUvJenHIhdfSyTYurDcwWTvOQ8mPDREtwE1o,21
+edsger/bellman_ford.cp312-win_amd64.pyd,sha256=5drEeO6adIiCHaN1sJTpc8XWJMU4coAl5W04auzKw1M,190464
+edsger/bellman_ford.pyx,sha256=Wep9yc2G6f14IqwFvedSApZGreQIoBLPEXLHGgXOHk8,17428
+edsger/commons.cp312-win_amd64.pyd,sha256=tZSV5QtdAy9n2V0GasErZFy9EDisSSW9gFotAFuBTJU,23552
+edsger/commons.pxd,sha256=UshKjr5ve3Or9u75xGyGPKRz1RwCCb5N-xgNevXZ4j4,464
+edsger/commons.pyx,sha256=6Ze22eE_zwXPRAe550DEhEvu-b7hvKmwQu73rzzWMUE,839
+edsger/dijkstra.cp312-win_amd64.pyd,sha256=IV7ZeAEw9prZh0HaEfTOP8dx6Ex93oEm1VKzaFnzRPY,257536
+edsger/dijkstra.pyx,sha256=kBXFya0bugjp97xas145sZEUXtb89_Sg9v8IdWiURoE,37542
+edsger/networks.py,sha256=hH9sgT5Ic4TLVCjxPNzMDWNjNDbqpXMxXxLeWxCpdLE,10730
+edsger/path.py,sha256=P9d4uvz-jn9y8I3vncB7HjUluvRGAsdYvgqeQVbT8ew,58809
+edsger/path_tracking.cp312-win_amd64.pyd,sha256=oVp9b8-yD2O_Hjbl4CsE0ILzJydNs12xjUe66U9t11Q,140800
+edsger/path_tracking.pyx,sha256=H24TLmC53I8LjbM1S5E7gS8WEb5uE_PZ8nhG6BteMYA,1900
+edsger/pq_4ary_dec_0b.cp312-win_amd64.pyd,sha256=9_0TXvdcy4RvVmtMiIz7y2yFso4NEz1PlioL6oCx0CY,167936
+edsger/pq_4ary_dec_0b.pxd,sha256=VvXcQzJq3OGBptrbawtemagPimuqSCayGQ91Jrad894,1098
+edsger/pq_4ary_dec_0b.pyx,sha256=IzvzQerf-LYy7weQpgI0f28Q8gUrR4ENaedekXs1Jeg,18486
+edsger/prefetch_compat.h,sha256=AyAYq_ZHKk5ChaJDrZOAOYe6SprL0_2byjRbjcBGrsU,826
+edsger/spiess_florian.cp312-win_amd64.pyd,sha256=86picdlJEqpHZTrMGqP9Q48kp2Ko0veDKFeA28t9eWI,198656
+edsger/spiess_florian.pyx,sha256=tjfF9Iv8nqpp4lnv4KAjF-37ij0_SgQ0fnacVVKx-CE,9934
+edsger/star.cp312-win_amd64.pyd,sha256=U_eWZ_zyyC5LL3-OoAxaQcZLM6e9wfPbg3RZz2iLbDA,185344
+edsger/star.pyx,sha256=9LAIXhlccEeDgT41ico7n57FJ7PKCzhPv4f22Lphn78,9602
+edsger/utils.py,sha256=I1HJtmbnu9XWiY0rstM_D0NCX0bPjdtK-BeIAXwYjO4,4728
+edsger-0.1.5.dist-info/licenses/AUTHORS.rst,sha256=8udN6bgZHdHYcVzV38y6SPnF-x6Ks0uXxxFsic6Aces,110
+edsger-0.1.5.dist-info/licenses/LICENSE,sha256=w7gRlruGxK3_4KTZAyJsOR2tML4UQgB-GNm2LerwJS0,1132
+edsger-0.1.5.dist-info/METADATA,sha256=ZROC5X1uwWzhe_Q68ASsHpKXZKbBX-MPk6ljEk3BeV4,7293
+edsger-0.1.5.dist-info/WHEEL,sha256=8UP9x9puWI0P1V_d7K2oMTBqfeLNm21CTzZ_Ptr0NXU,101
+edsger-0.1.5.dist-info/top_level.txt,sha256=QvhzFORJIIot6GzSnDrtGa9KQt9iifCbOC5ULlzY5dg,7
+edsger-0.1.5.dist-info/RECORD,,

edsger-0.1.3.dist-info/RECORD

@@ -1,27 +0,0 @@
-edsger/.gitignore,sha256=mr9Izcwvjgv215xjRKhWEZ7vsyrKWhMqvWjSLHRYDjk,13
-edsger/__init__.py,sha256=lgtGe3cqdwWdO1DLEOx7fX3i8D4Z_2rXHSq7Xecf-NM,41
-edsger/_version.py,sha256=R5TtpJu7Qu6sOarfDpp-5Oyy8Pi2Ir3VewCvsCQiAgo,21
-edsger/commons.cp312-win_amd64.pyd,sha256=hvbl0R_hhQFu1mApSWr8-xQZj1U6rHtgUfv8HVK3vMs,23040
-edsger/commons.pxd,sha256=UshKjr5ve3Or9u75xGyGPKRz1RwCCb5N-xgNevXZ4j4,464
-edsger/commons.pyx,sha256=6Ze22eE_zwXPRAe550DEhEvu-b7hvKmwQu73rzzWMUE,839
-edsger/dijkstra.cp312-win_amd64.pyd,sha256=Rl3PRWKmJbEstNfikjYAjMXUdG3sAWTxloppFz7RKps,252928
-edsger/dijkstra.pyx,sha256=kBXFya0bugjp97xas145sZEUXtb89_Sg9v8IdWiURoE,37542
-edsger/networks.py,sha256=hH9sgT5Ic4TLVCjxPNzMDWNjNDbqpXMxXxLeWxCpdLE,10730
-edsger/path.py,sha256=2NtkhwN2HQUsoZn0Sl6UbFKWIcWVTvnE6D8IH-xEG88,35768
-edsger/path_tracking.cp312-win_amd64.pyd,sha256=iPjPfWZn-79UB2l-KG9An04EzdOXGt80Z10iPO3JjHw,135168
-edsger/path_tracking.pyx,sha256=H24TLmC53I8LjbM1S5E7gS8WEb5uE_PZ8nhG6BteMYA,1900
-edsger/pq_4ary_dec_0b.cp312-win_amd64.pyd,sha256=apkpbNPgWBEziUn9TAqEPI3Unqgee-5esj3LHfUBQ4Y,163328
-edsger/pq_4ary_dec_0b.pxd,sha256=VvXcQzJq3OGBptrbawtemagPimuqSCayGQ91Jrad894,1098
-edsger/pq_4ary_dec_0b.pyx,sha256=IzvzQerf-LYy7weQpgI0f28Q8gUrR4ENaedekXs1Jeg,18486
-edsger/prefetch_compat.h,sha256=AyAYq_ZHKk5ChaJDrZOAOYe6SprL0_2byjRbjcBGrsU,826
-edsger/spiess_florian.cp312-win_amd64.pyd,sha256=YUe6UD3_VljB2-8sx6mj1BwdK1Bj25Kb9FHxZYnUlhc,192512
-edsger/spiess_florian.pyx,sha256=tjfF9Iv8nqpp4lnv4KAjF-37ij0_SgQ0fnacVVKx-CE,9934
-edsger/star.cp312-win_amd64.pyd,sha256=eDmVyKxhYkQK7YaY65GP6EjVdzhS55FbAG4hNIb-MXc,181760
-edsger/star.pyx,sha256=9LAIXhlccEeDgT41ico7n57FJ7PKCzhPv4f22Lphn78,9602
-edsger/utils.py,sha256=xYfOFIbYpAiZljhUOgGWy0TVNvWaMFCwbCLPBkzdVos,2097
-edsger-0.1.3.dist-info/licenses/AUTHORS.rst,sha256=8udN6bgZHdHYcVzV38y6SPnF-x6Ks0uXxxFsic6Aces,110
-edsger-0.1.3.dist-info/licenses/LICENSE,sha256=w7gRlruGxK3_4KTZAyJsOR2tML4UQgB-GNm2LerwJS0,1132
-edsger-0.1.3.dist-info/METADATA,sha256=pd11DVCVJaNAwtzqYHZQu3HffnIgBUmwWwfuzgNTAF0,5314
-edsger-0.1.3.dist-info/WHEEL,sha256=8UP9x9puWI0P1V_d7K2oMTBqfeLNm21CTzZ_Ptr0NXU,101
-edsger-0.1.3.dist-info/top_level.txt,sha256=QvhzFORJIIot6GzSnDrtGa9KQt9iifCbOC5ULlzY5dg,7
-edsger-0.1.3.dist-info/RECORD,,