pykp 0.0.22__tar.gz

pykp-0.0.22/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.1
+Name: pykp
+Version: 0.0.22
+Summary: Tooling for sampling and solving instances of the 0-1 Knapsack Problem
+Home-page: https://github.com/HRSAndrabi/pykp
+Author: Hassan Andrabi
+Author-email: hrs.andrabi@gmail.com
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: anytree>=2.12.1
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: matplotlib==3.9.2
+Requires-Dist: numpy==2.1.3
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: twine>=4.0.2; extra == "dev"
+
+# PyKP: A Python Package for Knapsack Problem Solving
+
+PyKP is a free and open-source library for sampling and solving instances of the knapsack problem. It provides tools to define knapsack instances, solve them efficiently, and analyse computational complexity metrics. You can also use `pykp` to sample knapsack problem instances based on specified distributions.
+
+## Features
+
+- Define knapsack problem instances with custom items, weights, and values.
+- Solve knapsack instances using branch-and-bound and other methods.
+- Compute optimal and feasible solutions for different knapsack configurations.
+- Analyse computational complexity metrics.
+- Generate synthetic knapsack instances with custom weight, density, and solution value ranges.
+
+## Installation
+
+PyKP support Python version 3.12 and higher. To install PyKP, run
+
+```
+pip install pykp
+```
+
+## Usage
+
+### Defining and Solving a Knapsack Problem
+
+To start, define a knapsack problem with a set of items and solve it using the Knapsack class.
+
+```python
+import numpy as np
+from pykp import Knapsack
+from pykp import Item
+
+# Define items for the knapsack
+items = np.array([
+    Item(value=10, weight=5),
+    Item(value=15, weight=10),
+    Item(value=7, weight=3)
+])
+
+# Initialise a Knapsack instance
+capacity = 15
+knapsack = Knapsack(items=items, capacity=capacity)
+knapsack.solve()
+
+# Display the optimal solution
+print("Optimal Solution Value:", knapsack.optimal_nodes[0].value)
+```
+
+### Generating Knapsack Instances with Sampler
+
+The `Sampler` class allows you to generate knapsack instances based on specific ranges for item densities (value/weight ratio) and optimal solution values.
+
+```python
+from pykp import Sampler
+
+# Initialise a Sampler instance with desired ranges
+sampler = Sampler(
+    num_items=5,
+    normalised_capacity=0.6,
+    density_range=(0.5, 1.5),
+    solution_value_range=(100, 200)
+)
+
+# Generate a sampled knapsack instance
+sampled_knapsack = sampler.sample()
+print("Sampled Knapsack Capacity:", sampled_knapsack.capacity)
+```
+
+### Analysing Knapsack Solutions
+
+The package provides methods to analyse the optimal solutions and other feasible arrangements.
+
+```python
+# Display a summary of the knapsack solutions
+print(sampled_knapsack.summary())
+```
+
+## License
+
+This project is licensed under the MIT License.
+
+## Contributing
+
+Contributions are welcome. Please fork the repository and submit a pull request.
+
+## Contact
+
+For questions or feedback, please reach out at hrs.andrabi@gmail.com.

pykp-0.0.22/README.md

@@ -0,0 +1,87 @@
+# PyKP: A Python Package for Knapsack Problem Solving
+
+PyKP is a free and open-source library for sampling and solving instances of the knapsack problem. It provides tools to define knapsack instances, solve them efficiently, and analyse computational complexity metrics. You can also use `pykp` to sample knapsack problem instances based on specified distributions.
+
+## Features
+
+- Define knapsack problem instances with custom items, weights, and values.
+- Solve knapsack instances using branch-and-bound and other methods.
+- Compute optimal and feasible solutions for different knapsack configurations.
+- Analyse computational complexity metrics.
+- Generate synthetic knapsack instances with custom weight, density, and solution value ranges.
+
+## Installation
+
+PyKP support Python version 3.12 and higher. To install PyKP, run
+
+```
+pip install pykp
+```
+
+## Usage
+
+### Defining and Solving a Knapsack Problem
+
+To start, define a knapsack problem with a set of items and solve it using the Knapsack class.
+
+```python
+import numpy as np
+from pykp import Knapsack
+from pykp import Item
+
+# Define items for the knapsack
+items = np.array([
+    Item(value=10, weight=5),
+    Item(value=15, weight=10),
+    Item(value=7, weight=3)
+])
+
+# Initialise a Knapsack instance
+capacity = 15
+knapsack = Knapsack(items=items, capacity=capacity)
+knapsack.solve()
+
+# Display the optimal solution
+print("Optimal Solution Value:", knapsack.optimal_nodes[0].value)
+```
+
+### Generating Knapsack Instances with Sampler
+
+The `Sampler` class allows you to generate knapsack instances based on specific ranges for item densities (value/weight ratio) and optimal solution values.
+
+```python
+from pykp import Sampler
+
+# Initialise a Sampler instance with desired ranges
+sampler = Sampler(
+    num_items=5,
+    normalised_capacity=0.6,
+    density_range=(0.5, 1.5),
+    solution_value_range=(100, 200)
+)
+
+# Generate a sampled knapsack instance
+sampled_knapsack = sampler.sample()
+print("Sampled Knapsack Capacity:", sampled_knapsack.capacity)
+```
+
+### Analysing Knapsack Solutions
+
+The package provides methods to analyse the optimal solutions and other feasible arrangements.
+
+```python
+# Display a summary of the knapsack solutions
+print(sampled_knapsack.summary())
+```
+
+## License
+
+This project is licensed under the MIT License.
+
+## Contributing
+
+Contributions are welcome. Please fork the repository and submit a pull request.
+
+## Contact
+
+For questions or feedback, please reach out at hrs.andrabi@gmail.com.

pykp-0.0.22/pykp/__init__.py

@@ -0,0 +1,4 @@
+from .knapsack import Knapsack
+from .item import Item
+from .arrangement import Arrangement
+from .sampler import Sampler

pykp-0.0.22/pykp/arrangement.py

@@ -0,0 +1,63 @@
+import numpy as np
+from .item import Item
+
+class Arrangement():
+	"""
+    Represents an arrangement of items for the knapsack problem.
+
+    Attributes:
+    *    items (np.ndarray[Item]): An array of items for the knapsack problem.
+    *    state (np.ndarray[int]): Binary array indicating the inclusion/exclusion of items in the arrangement.
+    *    value (int): The total value of items in the arrangement.
+    *    weight (int): The total weight of items in the arrangement.
+    """
+	def __init__(
+		self,
+		items: np.ndarray[Item],
+		state: np.ndarray[int], 
+	):
+		"""Initialises an Arrangement instance.
+
+		Args:
+        	items (np.ndarray[Item]): An array of items for the knapsack problem.
+        	state (np.ndarray[int]): Binary array indicating the inclusion/exclusion of items in the arrangement.
+        	capacity (int): The maximum weight capacity constraint for the arrangement.
+		"""
+		if not np.all(np.isin(state, [0, 1])):
+			raise ValueError("Elements of `state` must be 0 or 1.")
+		
+		self.items = items
+		self.state = state
+		self.value = self.__calculate_value()
+		self.weight = self.__calculate_weight()
+
+	
+	def __calculate_value(self):
+		"""
+        Calculates the total value of items currently in the knapsack.
+
+        Returns:
+        	float: The total value of items in the knapsack.
+        """
+		return sum([self.items[i].value for i, inside in enumerate(self.state) if bool(inside)])
+
+
+	def __calculate_weight(self):
+		"""
+        Calculates the total weight of items currently in the knapsack.
+
+        Returns:
+        	float: The total weight of items in the knapsack.
+        """
+		return sum([self.items[i].weight for i, inside in enumerate(self.state) if bool(inside)])
+
+	
+	def __str__(self):
+		state = int("".join(self.state.astype(int).astype(str)), 2)
+		return f"(v: {self.value}, w: {self.weight}, s: {state})"
+	 
+	def __repr__(self):
+		state = int("".join(self.state.astype(int).astype(str)), 2)
+		return f"(v: {self.value}, w: {self.weight}, s: {state})"
+
+

pykp-0.0.22/pykp/item.py

@@ -0,0 +1,40 @@
+class Item:
+	"""
+	Represents an item for the knapsack problem.
+
+    Attributes:
+    	value (int): The value of the item.
+    	weight (int): The weight of the item.
+	"""
+	def __init__(self, value: int, weight: int):
+		"""
+		Initialises an Item instance.
+		
+		Args:
+			value (int): The value of the item.
+			weight (int): The weight of the item.
+		"""
+		self.weight = weight
+		self.value = value
+	
+	def update_value(self, new_value: int):
+		"""Updates the value of the item.
+
+		Args:
+			new_value (int): New value of the item. 
+		"""
+		self.value = new_value
+	
+	def update_weight(self, new_weight: int):
+		"""Updates the weight of the item.
+
+		Args:
+			new_weight (int): New weight of the item. 
+		"""
+		self.weight = new_weight
+
+	def __str__(self):
+		return f"weight: {self.weight}; value: {self.value}"
+
+	def __repr__(self):
+		return str(self)