Adding changes to improve my code based on review

Author: SaraTahir28

laptop Allocation/.vscode/settings.json laptopAllocation/.vscode/settings.jsonlaptop Allocation/.vscode/settings.json renamed to laptopAllocation/.vscode/settings.json

@@ -1,7 +1,6 @@
 from dataclasses import dataclass
 from enum import Enum
 from typing import Dict, List
-import sys
 import numpy as np  #to build and mnaiplate our sadness grid
 from scipy.optimize import linear_sum_assignment #to find optimal laptop allocaation to minimize sadness across all users
 
@@ -15,7 +14,7 @@ class Person:
     name: str
     age: int
     # Sorted in order of preference, most preferred is first.
-    preferred_operating_systems: List[OperatingSystem]
+    preferred_operating_systems: tuple[OperatingSystem]
 
 
 @dataclass(frozen=True)
@@ -27,7 +26,7 @@ class Laptop:
     operating_system: OperatingSystem
 
 #library of laptops
-laptop = [
+laptops = [
     Laptop(id=1, manufacturer="Dell", model="XPS", screen_size_in_inches=13, operating_system=OperatingSystem.ARCH),
     Laptop(id=2, manufacturer="Dell", model="XPS", screen_size_in_inches=15, operating_system=OperatingSystem.UBUNTU),
     Laptop(id=3, manufacturer="Dell", model="XPS", screen_size_in_inches=15, operating_system=OperatingSystem.UBUNTU),
@@ -39,28 +38,42 @@ class Laptop:
 ]
 # Preset dataset of people
 people = [
-    Person(name="Sara", age=31, preferred_operating_systems=[OperatingSystem.ARCH,OperatingSystem.UBUNTU]),
-    Person(name="Shabs", age=40, preferred_operating_systems=[OperatingSystem.ARCH,OperatingSystem.MACOS,OperatingSystem.UBUNTU]),
-    Person(name="Jawad", age= 36, preferred_operating_systems=[OperatingSystem.MACOS,OperatingSystem.UBUNTU,OperatingSystem.ARCH]),    
-    Person(name="Mike", age=35, preferred_operating_systems=[OperatingSystem.MACOS,OperatingSystem.ARCH]),
-    Person(name="Mawra", age=28, preferred_operating_systems=[OperatingSystem.MACOS]),
-    Person(name="Fatma", age= 22, preferred_operating_systems=[OperatingSystem.UBUNTU,OperatingSystem.ARCH]),    
-    Person(name="Muhib", age= 19, preferred_operating_systems=[OperatingSystem.MACOS,OperatingSystem.UBUNTU]),    
+    Person(name="Sara", age=31, preferred_operating_systems=(OperatingSystem.ARCH,OperatingSystem.UBUNTU)),
+    Person(name="Shabs", age=40, preferred_operating_systems=(OperatingSystem.ARCH,OperatingSystem.MACOS,OperatingSystem.UBUNTU)),
+    Person(name="Jawad", age= 36, preferred_operating_systems=(OperatingSystem.MACOS,OperatingSystem.UBUNTU,OperatingSystem.ARCH)),    
+    Person(name="Mike", age=35, preferred_operating_systems=(OperatingSystem.MACOS,OperatingSystem.ARCH)),
+    Person(name="Mawra", age=28, preferred_operating_systems=(OperatingSystem.MACOS,)),#adding a comma for one item tuple
+    Person(name="Fatma", age= 22, preferred_operating_systems=(OperatingSystem.UBUNTU,OperatingSystem.ARCH)),    
+    Person(name="Muhib", age= 19, preferred_operating_systems=(OperatingSystem.MACOS,OperatingSystem.UBUNTU)),    
 
 ]
 
+
+# Updated based on feedback: 
+# Instead of hard‑coding sadness scores (0, 1, 2), this version uses the 
+# position of the laptop’s OS in the person’s preference list to decide the sadness value. 
+# I check for membership first (so no exceptions), then 
+# use the index as the rank. Only the top MAX_HAPPY_RANK preferences count; 
+# anything lower or not listed gets a high penalty. 
+
+MAX_HAPPY_RANK = 3
+TERRIBLE_SADNESS = 100
 def sadness(person: Person, laptop: Laptop) -> int:
-    if laptop.operating_system == person.preferred_operating_systems[0]:
-        return 0
-    elif len(person.preferred_operating_systems) > 1 and laptop.operating_system == person.preferred_operating_systems[1]:
-        return 1
-    elif len(person.preferred_operating_systems) > 2 and laptop.operating_system == person.preferred_operating_systems[2]:
-        return 2
-    else:
-        return 100
-    
-#I have chose to use  Hungarian Algorithm Approach to solve the problem.
+    prefs = person.preferred_operating_systems
+
+    if laptop.operating_system not in prefs:
+        return TERRIBLE_SADNESS
 
+    rank = prefs.index(laptop.operating_system)
+
+    return rank if rank < MAX_HAPPY_RANK else TERRIBLE_SADNESS
+
+    #Allocate laptops to people in a way that minimises total sadness.
+    #Builds a cost matrix using the sadness() function and applies the
+    #Hungarian algorithm (linear_sum_assignment) to find the optimal
+    #one‑to‑one assignment between people and laptops.
+
+    
 def allocate_laptops(people: List[Person], laptops: List[Laptop]) -> Dict[Person, Laptop]:
     n_people = len(people) #length of people []
     n_laptops = len(laptops) #length of laptops []
@@ -73,15 +86,15 @@ def allocate_laptops(people: List[Person], laptops: List[Laptop]) -> Dict[Person
             # Hungarian algorithm to run on our sadness matrix
     row_indices, col_indices = linear_sum_assignment(sadness_matrix) #which person which laptop
         # Map people to laptops
-    allocation = {}
+    allocation: Dict[Person, Laptop] = {}
     for i, j in zip(row_indices, col_indices):#it pairs up results (person indices and laptop indices). The loop then uses those pairs to build the final allocation dictionary
-        allocation[people[i].name] = laptops[j]
+        allocation[people[i]] = laptops[j]
     return allocation
 
 
 def print_allocation(allocation: Dict[Person, Laptop]):
-    for name, lap in allocation.items():
-        print(f"{name} gets Laptop {lap.id} ({lap.operating_system.value})")
+    for person, lap in allocation.items():
+        print(f"{person.name} gets Laptop {lap.id} ({lap.operating_system.value})")
 
-allocation = allocate_laptops(people, laptop)
+allocation = allocate_laptops(people, laptops)
 print_allocation(allocation)

laptop Allocation/laptop.py laptopAllocation/laptop.pylaptop Allocation/laptop.py renamed to laptopAllocation/laptop.py

@@ -0,0 +1,12 @@
+# test_basic.py
+# A very small test just to confirm the core logic works.
+# Full testing is beyond the scope of this assignment, but this shows
+# that the sadness function behaves correctly for a simple case.
+#If a person gets a laptop with their first‑choice operating system, their sadness should be 0.
+from laptop import Person, Laptop, OperatingSystem, sadness
+
+def test_sadness_first_choice():
+    person = Person("Test", 20, (OperatingSystem.MACOS,))
+    laptop = Laptop(1, "Apple", "macBook", 13, OperatingSystem.MACOS)
+
+    assert sadness(person, laptop) == 0