File size: 7,525 Bytes
666f6cf |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
from dataclasses import dataclass, field
from typing import List, Optional, Annotated, Union
from solverforge_legacy.solver.domain import (
planning_entity,
planning_solution,
PlanningId,
PlanningVariable,
PlanningEntityCollectionProperty,
ProblemFactCollectionProperty,
ValueRangeProvider,
PlanningScore,
PlanningPin,
)
from solverforge_legacy.solver import SolverStatus
from solverforge_legacy.solver.score import HardMediumSoftScore
from .json_serialization import JsonDomainBase
from pydantic import Field
# Time granularity is 15 minutes (which is often recommended when dealing with humans for practical purposes).
GRAIN_LENGTH_IN_MINUTES = 15
@dataclass
class Person:
id: Annotated[str, PlanningId]
full_name: str
@dataclass
class TimeGrain:
id: Annotated[str, PlanningId]
grain_index: int
day_of_year: int
starting_minute_of_day: int
@dataclass
class Room:
id: Annotated[str, PlanningId]
name: str
capacity: int
# Define Attendance base class and subclasses before Meeting to avoid forward references
@dataclass
class Attendance:
id: Annotated[str, PlanningId]
person: Person
meeting_id: str
@dataclass
class RequiredAttendance:
id: Annotated[str, PlanningId]
person: Person
meeting_id: str
@dataclass
class PreferredAttendance:
id: Annotated[str, PlanningId]
person: Person
meeting_id: str
@dataclass
class Meeting:
id: Annotated[str, PlanningId]
topic: str
duration_in_grains: int
speakers: Optional[List[Person]] = None
content: Optional[str] = None
entire_group_meeting: bool = False
required_attendances: List[RequiredAttendance] = field(default_factory=list)
preferred_attendances: List[PreferredAttendance] = field(default_factory=list)
def get_required_capacity(self) -> int:
return len(self.required_attendances) + len(self.preferred_attendances)
def add_required_attendant(self, person: Person) -> None:
person_id = person.id
for r in self.required_attendances:
if r.person.id == person_id:
raise ValueError(
f"The person {person_id} is already assigned to the meeting {self.id}."
)
self.required_attendances.append(
RequiredAttendance(
id=f"{self.id}-{self.get_required_capacity() + 1}",
meeting_id=self.id,
person=person,
)
)
def add_preferred_attendant(self, person: Person) -> None:
person_id = person.id
for p in self.preferred_attendances:
if p.person.id == person_id:
raise ValueError(
f"The person {person_id} is already assigned to the meeting {self.id}."
)
self.preferred_attendances.append(
PreferredAttendance(
id=f"{self.id}-{self.get_required_capacity() + 1}",
meeting_id=self.id,
person=person,
)
)
@planning_entity
@dataclass
class MeetingAssignment:
id: Annotated[str, PlanningId]
meeting: Meeting
pinned: Annotated[bool, PlanningPin] = False
starting_time_grain: Annotated[Optional[TimeGrain], PlanningVariable] = None
room: Annotated[Optional[Room], PlanningVariable] = None
def get_grain_index(self) -> Optional[int]:
if self.starting_time_grain is None:
return None
return self.starting_time_grain.grain_index
def calculate_overlap(self, other: "MeetingAssignment") -> int:
if self.starting_time_grain is None or other.starting_time_grain is None:
return 0
# start is inclusive, end is exclusive
start = self.starting_time_grain.grain_index
end = self.get_last_time_grain_index() + 1
other_start = other.starting_time_grain.grain_index
other_end = other.get_last_time_grain_index() + 1
if other_end < start or end < other_start:
return 0
return min(end, other_end) - max(start, other_start)
def get_last_time_grain_index(self) -> Optional[int]:
if self.starting_time_grain is None:
return None
return (
self.starting_time_grain.grain_index + self.meeting.duration_in_grains - 1
)
def get_room_capacity(self) -> int:
if self.room is None:
return 0
return self.room.capacity
def get_required_capacity(self) -> int:
return self.meeting.get_required_capacity()
@planning_solution
@dataclass
class MeetingSchedule:
people: Annotated[List[Person], ProblemFactCollectionProperty]
time_grains: Annotated[
List[TimeGrain], ProblemFactCollectionProperty, ValueRangeProvider
]
rooms: Annotated[List[Room], ProblemFactCollectionProperty, ValueRangeProvider]
meetings: Annotated[List[Meeting], ProblemFactCollectionProperty]
required_attendances: Annotated[
List[RequiredAttendance], ProblemFactCollectionProperty
] = field(default_factory=list)
preferred_attendances: Annotated[
List[PreferredAttendance], ProblemFactCollectionProperty
] = field(default_factory=list)
attendances: Annotated[
List[Attendance], ProblemFactCollectionProperty
] = field(default_factory=list)
meeting_assignments: Annotated[
List[MeetingAssignment], PlanningEntityCollectionProperty
] = field(default_factory=list)
score: Annotated[Optional[HardMediumSoftScore], PlanningScore] = None
solver_status: SolverStatus = SolverStatus.NOT_SOLVING
# Pydantic REST models for API (used for deserialization and context)
class PersonModel(JsonDomainBase):
id: str
full_name: str
class TimeGrainModel(JsonDomainBase):
id: str
grain_index: int
day_of_year: int
starting_minute_of_day: int
class RoomModel(JsonDomainBase):
id: str
name: str
capacity: int
class RequiredAttendanceModel(JsonDomainBase):
id: str
person: PersonModel
meeting_id: str = Field(..., alias="meeting")
class PreferredAttendanceModel(JsonDomainBase):
id: str
person: PersonModel
meeting_id: str = Field(..., alias="meeting")
class MeetingModel(JsonDomainBase):
id: str
topic: str
duration_in_grains: int
speakers: Optional[List[PersonModel]] = None
content: Optional[str] = None
entire_group_meeting: bool = False
required_attendances: List[RequiredAttendanceModel] = Field(
default_factory=list, alias="requiredAttendances"
)
preferred_attendances: List[PreferredAttendanceModel] = Field(
default_factory=list, alias="preferredAttendances"
)
class MeetingAssignmentModel(JsonDomainBase):
id: str
meeting: Union[str, MeetingModel]
pinned: bool = False
starting_time_grain: Union[str, TimeGrainModel, None] = None
room: Union[str, RoomModel, None] = None
class MeetingScheduleModel(JsonDomainBase):
people: List[PersonModel]
time_grains: List[TimeGrainModel]
rooms: List[RoomModel]
meetings: List[MeetingModel]
required_attendances: List[RequiredAttendanceModel] = Field(
default_factory=list, alias="requiredAttendances"
)
preferred_attendances: List[PreferredAttendanceModel] = Field(
default_factory=list, alias="preferredAttendances"
)
meeting_assignments: List[MeetingAssignmentModel] = Field(default_factory=list)
score: Optional[str] = None
solver_status: Optional[str] = None
|