add patients datastructure (not complete)

shared/package.json

@@ -27,12 +27,14 @@
     "dependencies": {
         "class-transformer": "^0.5.1",
         "class-validator": "^0.13.2",
+        "d3-quadtree": "^3.0.1",
         "immer": "^9.0.12",
         "lodash-es": "^4.17.21",
         "reflect-metadata": "^0.1.13",
         "uuid": "^8.3.2"
     },
     "devDependencies": {
+        "@types/d3-quadtree": "^3.0.2",
         "@types/jest": "^27.4.1",
         "@types/lodash-es": "^4.17.6",
         "@types/uuid": "^8.3.4",

shared/src/models/patients-datastructure.ts

@@ -0,0 +1,100 @@
+import { IsDefined, IsUUID } from 'class-validator';
+import { Quadtree, quadtree } from 'd3-quadtree';
+import type { ExerciseState } from '../state';
+import { UUID, uuid, uuidValidationOptions } from '../utils';
+import type { Position } from './utils';
+import { getCreate } from './utils';
+import type { Patient } from '.';
+
+/**
+ *
+ * @param id PatientId
+ * @param x x-coordinate of patient
+ * @param y y-coordinate of patient
+ */
+interface PatientData {
+    id: UUID;
+    x: number;
+    y: number;
+}
+
+export class PatientsDataStructure {
+    @IsUUID(4, uuidValidationOptions)
+    public readonly id: UUID = uuid();
+
+    @IsDefined()
+    public readonly dataStructure: Quadtree<PatientData>;
+
+    static readonly create = getCreate(this);
+
+    /**
+     * @deprecated Use {@link create} instead
+     */
+    constructor() {
+        // initialize and setting accessors to correct value in PatientData
+        this.dataStructure = quadtree<PatientData>()
+            .x((d) => d.x)
+            .y((d) => d.y);
+    }
+
+    fillDataStructure(state: ExerciseState) {
+        const patients = Object.values(state.patients).filter(
+            (patient) => patient.position !== undefined
+        );
+        const data: PatientData[] = [];
+        for (const patient of patients) {
+            if (patient.position?.x && patient.position.y) {
+                data.push({
+                    id: patient.id,
+                    x: patient.position?.x,
+                    y: patient.position.y,
+                });
+            }
+        }
+        // addAll calculates the extend before adding the data resulting in a more compact quadtree
+        // see https://github.com/d3/d3-quadtree#quadtree_addAll
+        this.dataStructure.addAll(data);
+    }
+
+    /**
+     * @param patient needs a patient with valid position
+     */
+    addPatient(patient: Patient) {
+        // TODO: check if patient got added sucessfully,
+        // maybe lazy via length checking (something got added)
+        if (patient.position?.x && patient.position.y) {
+            const x = patient.position.x;
+            const y = patient.position.y;
+            this.dataStructure.add({ id: patient.id, x, y });
+        } else throw new TypeError('Expected patient to have a valid position');
+    }
+
+    /**
+     * @param patient needs a patient with valid position
+     */
+    removePatient(patient: Patient) {
+        // TODO: check if patient got deleted sucessfully,
+        // as function remove does nothing when datum does not exist in quadtree
+        // maybe lazy via length checking (something got deleted)
+        if (patient.position?.x && patient.position.y) {
+            const x = patient.position.x;
+            const y = patient.position.y;
+            this.dataStructure.remove({ id: patient.id, x, y });
+        } else throw new TypeError('Expected patient to have a valid position');
+    }
+
+    movePatient(patient: Patient) {
+        // TODO: check if patient got moved sucessfully
+        if (patient.position?.x && patient.position.y) {
+            const x = patient.position.x;
+            const y = patient.position.y;
+            // first add then remove, to not have maybe an unnecessary extend
+            this.dataStructure.add({ id: patient.id, x, y });
+            this.dataStructure.remove({ id: patient.id, x, y });
+        } else throw new TypeError('Expected patient to have a valid position');
+    }
+
+    findAllPatientsInCircle(position: Position, radius: number) {
+        // TODO: implement search
+    }
+}

shared/src/state.ts

@@ -36,6 +36,7 @@ import { getCreate } from './models/utils';
 import type { UUID } from './utils';
 import { uuidValidationOptions, uuid } from './utils';
 import { PatientCategory } from './models/patient-category';
+import { PatientsDataStructure } from './models/patients-datastructure';
 
 export class ExerciseState {
     @IsUUID(4, uuidValidationOptions)
@@ -100,6 +101,9 @@ export class ExerciseState {
     @Type(() => StatisticsEntry)
     public readonly statistics: readonly StatisticsEntry[] = [];
     @ValidateNested()
+    @Type(() => PatientsDataStructure)
+    public readonly patientsDataStructure = PatientsDataStructure.create();
+    @ValidateNested()
     @Type(() => ExerciseConfiguration)
     public readonly configuration = ExerciseConfiguration.create();