edsger 0.1.4__cp311-cp311-macosx_11_0_arm64.whl → 0.1.5__cp311-cp311-macosx_11_0_arm64.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.4.dist-info → edsger-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edsger
-Version: 0.1.4
+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>
@@ -54,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/)
 
@@ -98,6 +98,63 @@ 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

edsger-0.1.5.dist-info/RECORD

@@ -0,0 +1,36 @@
+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

edsger-0.1.4.dist-info/RECORD

@@ -1,33 +0,0 @@
-edsger-0.1.4.dist-info/RECORD,,
-edsger-0.1.4.dist-info/WHEEL,sha256=qxQkdhERtGxJzqnVOBnucx1aUmU2n3HmuzYdln_LyOw,109
-edsger-0.1.4.dist-info/top_level.txt,sha256=QvhzFORJIIot6GzSnDrtGa9KQt9iifCbOC5ULlzY5dg,7
-edsger-0.1.4.dist-info/METADATA,sha256=W7VnBFB3jCX77cLnj1naJ-1BGzYatHsQ2DGoBk6Gbkk,5369
-edsger-0.1.4.dist-info/licenses/LICENSE,sha256=eNjfz5CInLrVdczJbhazCKtb8-0qB0UaXZ3bXN0zio0,1111
-edsger-0.1.4.dist-info/licenses/AUTHORS.rst,sha256=9lqpqjiC4XukK7jdxXwKJJrddqwCV2DjpYTqhpP6znA,105
-edsger/spiess_florian.c,sha256=rkz11lkANig6lSuQ6pFBWtMdOXuM2uOYvx7VmwRQJ6w,1355775
-edsger/dijkstra.c,sha256=_yF4vvqlSo00GQK1mTkqZFn0VmtILVECpBXOO3DcoT0,1657403
-edsger/_version.py,sha256=JMD28FXYHc_TM03visyUSd3UA9FZAaJMRStnfZoq50Y,21
-edsger/spiess_florian.cpython-311-darwin.so,sha256=Jh7BUGAa1vcLq6gqRxD1V_Y7SIA89KiZU9k2tLxfZkU,276312
-edsger/commons.c,sha256=tdBzW_gCuLRoKR8kpvLLA25kKzA3e-_2xc8Nq-nPXo0,343009
-edsger/star.c,sha256=i92m8J2fiypXVKRuWo3uPvLZfns5YynagtrYlLPewis,1319073
-edsger/path_tracking.cpython-311-darwin.so,sha256=1rEt-_0dfUHeDT4rPXdn5O019WaclPrfaiotJWaZcgs,191200
-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=CfibJn9D2rhfHKJsYJuGBETRhNNS4mAlQ0llS6mJGB0,1143939
-edsger/spiess_florian.pyx,sha256=9CrcMyzwSXaC_EdSl1uiD9yhFH6ACtooZOMfYw6vhvA,9566
-edsger/pq_4ary_dec_0b.c,sha256=NKUN0BMgirhv5zCyLjyuMhq7HaxkvI6mjBitxPFcuBU,1367251
-edsger/dijkstra.cpython-311-darwin.so,sha256=sU7ItPPr393zN_E5y0uSCQgUfJSnyKmvU7sal0GUQ1M,367040
-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=igl2xDpkjTuQ5fhDdynQ0ekMSva52BstrTsZaTtE2RI,2034
-edsger/pq_4ary_dec_0b.pyx,sha256=fRJCT79GsCocZgpostfn7t5nkNQALK0A93OJK4fxJR0,17796
-edsger/commons.cpython-311-darwin.so,sha256=fGR441o1wyvlV1uOOcWLVOyP91J7D0pxWF3mbT7Ncko,58016
-edsger/path_tracking.pyx,sha256=uO06fzL8V5KeI3w5FPVJJ13ZtdFGTol6oUjVX4Jjxxs,1807
-edsger/star.cpython-311-darwin.so,sha256=xe-xzBtEBWmLN00fk-JdVcyBpY5FrywQ8I3bbVguyGc,250696
-edsger/path.py,sha256=4hwoXiaepp_twwEQMmlygFsYy1HcxtZmR1HSvNStUC4,34874
-edsger/dijkstra.pyx,sha256=R8DM9LlHXUOZ38t7qINaB1t_QBP_aeWBOqIHHVN9W10,36513
-edsger/star.pyx,sha256=MVS4kylmMAXOHm8liTfTMLzrr0jhA3cRU3-KCfVjNNM,9246
-edsger/pq_4ary_dec_0b.cpython-311-darwin.so,sha256=OS3RHv-FKNQQmfFzdg4Khf-wfBbAC1WtHMGZTNUc5yY,214488