graphs-shaddad 0.0.1__tar.gz

graphs_shaddad-0.0.1/.gitignore

@@ -0,0 +1,8 @@
+test_env/
+.venv/
+dist/
+build/
+*.egg-info/
+__pycache__/
+*.pyc
+haddad_sam_hwk5

graphs_shaddad-0.0.1/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2026 The Python Packaging Authority
+
+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.

graphs_shaddad-0.0.1/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: graphs_shaddad
+Version: 0.0.1
+Summary: A graphing algorithm package
+Project-URL: Homepage, https://github.com/samhaddad2005/Open-Source-Project
+Project-URL: Issues, https://github.com/samhaddad2005/Open-Source-Project/issues
+Author-email: Sam Haddad <samhaddad@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# Open-Source-Project
+This repository aims to act as a open source software that contains many graphing algorithms. Among said graphs, Dijkstra's algorithm — an algorithm that aims to solve the problem of finding the shortest paths between nodes in a graph. — is found under src/graphs_shaddad.
+
+## Installation
+```
+pip install graphs_shaddad
+```
+
+## Dijkstra's Algorithm
+The graph is a dictionary mapping each node to a dictionary of `{neighbor: weight}`.
+```python
+from graphs_shaddad.sp import dijkstra
+
+graph = {
+    0: {1: 4, 2: 8},
+    1: {0: 4, 4: 6, 2: 3},
+    2: {0: 8, 3: 2, 1: 3},
+    3: {2: 2, 4: 10},
+    4: {1: 6, 3: 10},
+}
+dist, path = dijkstra(graph, 0)
+print(dist)  # {0: 0, 1: 4, 2: 7, 3: 9, 4: 10}
+```
+
+
+ <img width="400" height="324" alt="image" src="https://github.com/user-attachments/assets/82cb811e-dde9-4aed-b81e-7de8bbef569f" />
+
+
+Explanation of the shortest paths:
+- 0 -> 0 = 0: Source node itself, so distance is 0.
+- 0 -> 1 = 4: Direct edge from node 0 to 1 gives shortest distance 4.
+- 0 -> 2 = 7: Path 0 → 1 → 2 gives total cost 4 + 3 = 7, which is smaller than direct edge 8.
+- 0 -> 3 = 9: Path 0 → 1 → 2 → 3 gives total cost 4 + 3 + 2 = 9.
+- 0 -> 4 = 10: Path 0 → 1 → 4 gives total cost 4 + 6 = 10.
+
+## Prim's Algorithm for Minimum Spanning Tree (MST)
+```python
+from graphs_shaddad.sp import Graph
+
+g = Graph(5)
+g.graph = [[0, 2, 0, 6, 0],
+           [2, 0, 3, 8, 5],
+           [0, 3, 0, 0, 7],
+           [6, 8, 0, 0, 9],
+           [0, 5, 7, 9, 0]]
+g.primMST()  # prints each MST edge and its weight
+```
+
+Prim’s algorithm is a Greedy algorithm like Kruskal's algorithm. This algorithm always starts with a single node and moves through several adjacent nodes, in order to explore all of the connected edges along the way.
+
+The algorithm starts with an empty spanning tree.
+The idea is to maintain two sets of vertices. The first set contains the vertices already included in the MST, and the other set contains the vertices not yet included.
+At every step, it considers all the edges that connect the two sets and picks the minimum weight edge from these edges. After picking the edge, it moves the other endpoint of the edge to the set containing MST. 
+<img width="762" height="442" alt="image" src="https://github.com/user-attachments/assets/153ffc51-beac-4c83-bd24-c87062116569" />

graphs_shaddad-0.0.1/README.md

@@ -0,0 +1,54 @@
+# Open-Source-Project
+This repository aims to act as a open source software that contains many graphing algorithms. Among said graphs, Dijkstra's algorithm — an algorithm that aims to solve the problem of finding the shortest paths between nodes in a graph. — is found under src/graphs_shaddad.
+
+## Installation
+```
+pip install graphs_shaddad
+```
+
+## Dijkstra's Algorithm
+The graph is a dictionary mapping each node to a dictionary of `{neighbor: weight}`.
+```python
+from graphs_shaddad.sp import dijkstra
+
+graph = {
+    0: {1: 4, 2: 8},
+    1: {0: 4, 4: 6, 2: 3},
+    2: {0: 8, 3: 2, 1: 3},
+    3: {2: 2, 4: 10},
+    4: {1: 6, 3: 10},
+}
+dist, path = dijkstra(graph, 0)
+print(dist)  # {0: 0, 1: 4, 2: 7, 3: 9, 4: 10}
+```
+
+
+ <img width="400" height="324" alt="image" src="https://github.com/user-attachments/assets/82cb811e-dde9-4aed-b81e-7de8bbef569f" />
+
+
+Explanation of the shortest paths:
+- 0 -> 0 = 0: Source node itself, so distance is 0.
+- 0 -> 1 = 4: Direct edge from node 0 to 1 gives shortest distance 4.
+- 0 -> 2 = 7: Path 0 → 1 → 2 gives total cost 4 + 3 = 7, which is smaller than direct edge 8.
+- 0 -> 3 = 9: Path 0 → 1 → 2 → 3 gives total cost 4 + 3 + 2 = 9.
+- 0 -> 4 = 10: Path 0 → 1 → 4 gives total cost 4 + 6 = 10.
+
+## Prim's Algorithm for Minimum Spanning Tree (MST)
+```python
+from graphs_shaddad.sp import Graph
+
+g = Graph(5)
+g.graph = [[0, 2, 0, 6, 0],
+           [2, 0, 3, 8, 5],
+           [0, 3, 0, 0, 7],
+           [6, 8, 0, 0, 9],
+           [0, 5, 7, 9, 0]]
+g.primMST()  # prints each MST edge and its weight
+```
+
+Prim’s algorithm is a Greedy algorithm like Kruskal's algorithm. This algorithm always starts with a single node and moves through several adjacent nodes, in order to explore all of the connected edges along the way.
+
+The algorithm starts with an empty spanning tree.
+The idea is to maintain two sets of vertices. The first set contains the vertices already included in the MST, and the other set contains the vertices not yet included.
+At every step, it considers all the edges that connect the two sets and picks the minimum weight edge from these edges. After picking the edge, it moves the other endpoint of the edge to the set containing MST. 
+<img width="762" height="442" alt="image" src="https://github.com/user-attachments/assets/153ffc51-beac-4c83-bd24-c87062116569" />

graphs_shaddad-0.0.1/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["hatchling >= 1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "graphs_shaddad"
+version = "0.0.1"
+authors = [
+  { name="Sam Haddad", email="samhaddad@gmail.com" },
+]
+description = "A graphing algorithm package"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/samhaddad2005/Open-Source-Project"
+Issues = "https://github.com/samhaddad2005/Open-Source-Project/issues"
+
+[tool.hatch.build.targets.sdist]
+include = ["src/", "README.md", "LICENSE"]

graphs_shaddad-0.0.1/src/graphs_shaddad/sp.py

@@ -0,0 +1,84 @@
+import sys
+from heapq import heappush, heappop
+
+def dijkstra(graph, source):
+    dist = {node: sys.maxsize for node in graph}
+    dist[source] = 0
+    heap = []
+    heappush(heap, (0, source))
+    path = {source: []}
+
+    while heap:
+        w, u = heappop(heap)
+        for v in graph[u]:
+            if w + graph[u][v] < dist[v]:
+                dist[v] = w + graph[u][v]
+                heappush(heap, (dist[v], v))
+                path[v] = path[u] + [u]
+
+    return dist, path
+class Graph:
+    def __init__(self, vertices):
+        self.V = vertices
+        self.graph = [[0 for column in range(vertices)] for row in range(vertices)]
+        
+    def printMST(self, parent):
+        print("Edge \tWeight")
+        for i in range(1, self.V):
+            print(parent[i], "-", i, "\t", self.graph[parent[i]][i])
+
+    # A utility function to find the vertex with
+    # minimum distance value, from the set of vertices
+    # not yet included in shortest path tree
+    def minKey(self, key, mstSet):
+
+        # Initialize min value
+        min = sys.maxsize
+
+        for v in range(self.V):
+            if key[v] < min and mstSet[v] == False:
+                min = key[v]
+                min_index = v
+
+        return min_index
+
+    # Function to construct and print MST for a graph
+    # represented using adjacency matrix representation
+    def primMST(self):
+
+        # Key values used to pick minimum weight edge in cut
+        key = [sys.maxsize] * self.V
+        
+        parent = [None] * self.V  # Array to store constructed MST
+        
+        # Make key 0 so that this vertex is picked as first vertex
+        key[0] = 0
+        
+        mstSet = [False] * self.V
+
+        parent[0] = -1  # First node is always the root of
+
+        for cout in range(self.V):
+            u = self.minKey(key, mstSet)
+
+            mstSet[u] = True
+
+
+            for v in range(self.V):
+                if self.graph[u][v] > 0 and mstSet[v] == False \
+                and key[v] > self.graph[u][v]:
+                    key[v] = self.graph[u][v]
+                    parent[v] = u
+
+        self.printMST(parent)
+
+
+if __name__ == '__main__':
+    g = Graph(5)
+    g.graph = [[0, 2, 0, 6, 0],
+               [2, 0, 3, 8, 5],
+               [0, 3, 0, 0, 7],
+               [6, 8, 0, 0, 9],
+               [0, 5, 7, 9, 0]]
+
+    g.primMST()