micro_traffic_sim_core 0.1.9

Core library for microscopic traffic simulation via cellular automata.
Documentation
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
use crate::conflicts::conflicts::*;
use crate::agents::{Vehicle, VehicleID};
use indexmap::IndexMap;
use crate::maneuver::LaneChangeType;
use crate::grid::cell::CellID;
use crate::verbose::*;

use std::fmt;

/// Error type for conflict resolution failures.
#[derive(Debug, Clone)]
pub enum ConflictSolverError {
    /// The conflict data is inconsistent or invalid.
    InvalidConflict(String),
    /// Not enough participants in the conflict to resolve it.
    InsufficientParticipants(CellID, String),
    /// The priority participant index is invalid.
    InvalidPriorityIndex(CellID, usize, usize),
}

impl fmt::Display for ConflictSolverError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidConflict(msg) => write!(f, "Invalid conflict: {}", msg),
            Self::InsufficientParticipants(cell_id, conflict_type) => {
                write!(f, "Insufficient participants in conflict for cell {}, type: {}", cell_id, conflict_type)
            },
            Self::InvalidPriorityIndex(cell_id, index, len) => {
                write!(f, "Invalid priority index {} for conflict at cell {} (participants: {})", index, cell_id, len)
            }
        }
    }
}

/// Solves conflicts between vehicles based on their intentions and priority for the current simulation step.
///
/// # Arguments
/// * `conflicts_data` - A vector of `CellConflict` containing conflicts to be resolved
/// * `verbose` - If true, prints detailed information about the conflicts being resolved
/// 
/// # Returns
/// * `Result<(), ConflictSolverError>` - Returns Ok if conflicts are resolved successfully, or an error if there are issues
/// 
/// # Example
/// ```
/// use micro_traffic_sim_core::conflicts::{CellConflict, ConflictType, solve_conflicts};
/// use micro_traffic_sim_core::agents::{Vehicle, VehicleID, VehiclesStorage};
/// use micro_traffic_sim_core::verbose::LocalLogger;
/// 
/// // Prepare vehicles storage (owned Vehicles)
/// let mut vehicles: VehiclesStorage = VehiclesStorage::new();
/// vehicles.insert(1, Vehicle::new(1).with_speed(2).build());
/// vehicles.insert(2, Vehicle::new(2).with_speed(3).build());
/// 
/// // Conflict among vehicle IDs 1 and 2, first has priority
/// let conflicts = vec![CellConflict {
///    cell_id: 1,
///    participants: vec![1, 2],
///    priority_participant_index: 0,
///    conflict_type: ConflictType::ForwardLaneChange,
/// }];
/// 
/// let result = solve_conflicts(conflicts, &mut vehicles, &LocalLogger::none());
/// assert!(result.is_ok(), "Conflict resolution failed");
pub fn solve_conflicts<'b>(
    conflicts_data: Vec<CellConflict>,
    vehicles: &mut IndexMap<VehicleID, Vehicle>,
    verbose: &LocalLogger,
) -> Result<(), ConflictSolverError> {
    if verbose.is_at_least(VerboseLevel::Main) {
        verbose.log_with_fields(
            EVENT_CONFLICTS_SOLVE,
            "Solve conflicts",
            &[("conflicts_num", &conflicts_data.len())]
        );
    }
    let mut trajectories_conflicts: Vec<CellConflict> = Vec::new();
    let mut conflict_zones_conflicts: Vec<CellConflict> = Vec::new();
    for conflict in conflicts_data {
        if conflict.participants.len() < 2 {
            return Err(ConflictSolverError::InsufficientParticipants(
                conflict.cell_id,
                format!("{:?}", conflict.conflict_type),
            ));
        }

        // Validate priority participant index
        if conflict.priority_participant_index >= conflict.participants.len() {
            return Err(ConflictSolverError::InvalidPriorityIndex(
                conflict.cell_id,
                conflict.priority_participant_index,
                conflict.participants.len(),
            ));
        }

        match conflict.conflict_type {
            ConflictType::SelfTail => {
                if verbose.is_at_least(VerboseLevel::Additional) {
                    verbose.log_with_fields(
                        EVENT_CONFLICT_SOLVE,
                        "Conflict - self tail",
                        &[
                            ("cell", &conflict.cell_id),
                            ("conflict_type", &format!("{:?}", conflict.conflict_type)),
                            ("participants", &format!("{:?}", conflict.participants)),
                        ]
                    );
                }
                continue;
            }
            ConflictType::CrossLaneChange | ConflictType::TailCrossLaneChange => {
                // This must be crossing trajectories conflict. Need to postprocess after
                if let Some(priority_participant_id) = conflict.participants.get(conflict.priority_participant_index) {
                    if let Some(priority_participant) = vehicles.get_mut(priority_participant_id) {
                        priority_participant.is_conflict_participant = false;
                    }
                }
                if verbose.is_at_least(VerboseLevel::Additional) {
                    verbose.log_with_fields(
                        EVENT_CONFLICT_SOLVE,
                        "Found trajectories cross conflict",
                        &[
                            ("cell", &conflict.cell_id),
                            ("conflict_type", &format!("{:?}", conflict.conflict_type)),
                            ("participants", &format!("{:?}", conflict.participants)),
                            ("priority_participant_index", &conflict.priority_participant_index),
                        ]
                    );
                }
                trajectories_conflicts.push(conflict);
                continue;
            }
            ConflictType::CrossConflictZone => {
                if let Some(priority_participant_id) = conflict.participants.get(conflict.priority_participant_index) {
                    if let Some(priority_participant) = vehicles.get_mut(priority_participant_id) {
                        priority_participant.is_conflict_participant = false;
                    }
                }
                if verbose.is_at_least(VerboseLevel::Additional) {
                    verbose.log_with_fields(
                        EVENT_CONFLICT_SOLVE,
                        "Found trajectories cross conflict in zone",
                        &[
                            ("cell", &conflict.cell_id),
                            ("conflict_type", &format!("{:?}", conflict.conflict_type)),
                            ("participants", &format!("{:?}", conflict.participants)),
                            ("priority_participant_index", &conflict.priority_participant_index),
                        ]
                    );
                }
                conflict_zones_conflicts.push(conflict);
                continue;
            }
            _ => {}           
        }


        if verbose.is_at_least(VerboseLevel::Additional) {
            verbose.log_with_fields(
                EVENT_CONFLICT_SOLVE,
                "Solving common conflicts",
                &[
                    ("cell", &conflict.cell_id),
                    ("conflict_type", &format!("{:?}", conflict.conflict_type)),
                    ("participants", &format!("{:?}", conflict.participants)),
                    ("priority_index", &conflict.priority_participant_index),
                ]
            );
        }

        let priority_index = conflict.priority_participant_index;
        for (i, participant_id) in conflict.participants.iter().enumerate() {
            let participant = vehicles.get_mut(participant_id).ok_or_else(|| ConflictSolverError::InvalidConflict(format!("Vehicle {} not found", participant_id)))?;
            if i == priority_index {
                // Movement to cell is allowed
                // intention_cell remains the same (especially for vehicles for which conflict Cell ID is just intermediate cell)
                // intention_cell could be changed only if maneuver has been met
                if participant.intention.intention_maneuver != LaneChangeType::NoChange {
                    participant.intention.intention_cell_id = conflict.cell_id;
                    participant.intention.intention_speed = 1;
                }
            } else {
                // Stay still
                participant.block_with_speed(0);
            }
        }
    }
    
    // Postprocessing remaining possible trajectories conflicts
    for conflict in trajectories_conflicts {
        if verbose.is_at_least(VerboseLevel::Additional) {
            let vehicles_ids: Vec<_> = conflict.participants.clone();
            verbose.log_with_fields(
                EVENT_CONFLICT_SOLVE,
                "Solve trajectories cross conflict",
                &[
                    ("cell", &conflict.cell_id),
                    ("participants_ids", &format!("{:?}", vehicles_ids)),
                    ("conflict_type", &format!("{:?}", conflict.conflict_type)),
                ]
            );
        }
        match conflict.conflict_type {
            ConflictType::TailCrossLaneChange => {
                let priority_index = conflict.priority_participant_index;
                for (i, participant_id) in conflict.participants.iter().enumerate() {
                    let participant = vehicles.get_mut(participant_id).ok_or_else(|| ConflictSolverError::InvalidConflict(format!("Vehicle {} not found", participant_id)))?;
                    if i != priority_index {
                        participant.block_with_speed(0);
                    }
                }
                continue;
            }
            _ => {}
        }
        // Solve plain trajectories conflict
        let mut need_to_solve = true;
        let mut left_maneuver_index: Option<usize> = None;
        let mut right_maneuver_index: Option<usize> = None;
        for (i, participant_id) in conflict.participants.iter().enumerate() {
            let participant = vehicles.get(participant_id).ok_or_else(|| ConflictSolverError::InvalidConflict(format!("Vehicle {} not found", participant_id)))?;
            match participant.intention.intention_maneuver {
                LaneChangeType::ChangeLeft => left_maneuver_index = Some(i),
                LaneChangeType::ChangeRight => right_maneuver_index = Some(i),
                LaneChangeType::Block => need_to_solve = false,
                _ => {}
            }
        }
        if need_to_solve && left_maneuver_index.is_some() && right_maneuver_index.is_some() {
            // Vehicle which is trying to do maneuver to the right should stop
            if let Some(right_index) = right_maneuver_index {
                let right_id = conflict.participants[right_index];
                if let Some(v) = vehicles.get_mut(&right_id) { v.block_with_speed(0); }
            }
            // Vehicle which is trying to do maneuver to the left is allowed to do so
            // IntentionManeuver is saved
            // intention_cell is saved
            // Explicitly make speed to be equal 1 (just in case)
            if let Some(left_index) = left_maneuver_index {
                let left_id = conflict.participants[left_index];
                if let Some(v) = vehicles.get_mut(&left_id) { v.intention.intention_speed = 1; }
            }
        }
    }

    for conflict in conflict_zones_conflicts {
        if verbose.is_at_least(VerboseLevel::Additional) {
            let vehicles_ids: Vec<_> = conflict.participants.clone();
            verbose.log_with_fields(
                EVENT_CONFLICT_SOLVE,
                "Solve trajectories cross conflict in zone",
                &[
                    ("cell", &conflict.cell_id),
                    ("participants_ids", &format!("{:?}", vehicles_ids)),
                    ("conflict_type", &format!("{:?}", conflict.conflict_type)),
                ]
            );
        }
        
        let priority_index = conflict.priority_participant_index;
        for (i, participant_id) in conflict.participants.iter().enumerate() {
            if i != priority_index {
                if let Some(v) = vehicles.get_mut(participant_id) { v.block_with_speed(1); }
            }
        }
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::behaviour::BehaviourType;
    use crate::agents::{Vehicle, VehicleIntention, VehiclesStorage};
    use crate::maneuver::LaneChangeType;
    use crate::grid::cell::CellID;
    use crate::conflicts::conflicts::{CellConflict, ConflictType};

    fn _create_test_vehicle(
        id: u64,
        speed: i32,
        maneuver: LaneChangeType,
        intention_cell: CellID,
    ) -> Vehicle {
        let mut vehicle = Vehicle::new(id)
            .with_behaviour(BehaviourType::Undefined)
            .with_speed(speed)
            .build();
        
        vehicle.set_intention(VehicleIntention {
            intention_maneuver: maneuver,
            intention_cell_id: intention_cell,
            intention_speed: speed,
            ..Default::default()
        });
        
        vehicle
    }

    fn create_test_vehicle(
        id: u64,
        speed: i32,
        maneuver: LaneChangeType,
        intention_cell: CellID,
    ) -> Vehicle {
        let mut vehicle = Vehicle::new(id)
            .with_behaviour(BehaviourType::Undefined)
            .with_speed(speed)
            .build();
        vehicle.set_intention(VehicleIntention {
            intention_maneuver: maneuver,
            intention_cell_id: intention_cell,
            intention_speed: speed,
            ..Default::default()
        });
        vehicle
    }

    #[test]
    fn test_solve_conflicts_empty_conflicts_list() {
        let conflicts: Vec<CellConflict> = vec![];
        let mut vehicles = VehiclesStorage::new();
        let result = solve_conflicts(conflicts, &mut vehicles, &LocalLogger::none());
        assert!(result.is_ok(), "solve_conflicts should handle empty conflicts list");
    }

    #[test]
    fn test_solve_conflicts_insufficient_participants() {
    let vehicle = create_test_vehicle(1,2, LaneChangeType::NoChange, 5);

        let conflicts = vec![CellConflict {
            cell_id: 5,
            participants: vec![1],
            priority_participant_index: 0,
            conflict_type: ConflictType::MergeForward,
        }];

    let mut vehicles = VehiclesStorage::new();
        vehicles.insert(1, vehicle);
        let result = solve_conflicts(conflicts, &mut vehicles, &LocalLogger::none());
        assert!(result.is_err(), "solve_conflicts should return error for conflicts with insufficient participants");
        
        match result {
            Err(ConflictSolverError::InsufficientParticipants(cell_id, _)) => {
                assert_eq!(cell_id, 5, "Error should contain correct cell ID");
            }
            _ => panic!("Expected InsufficientParticipants error"),
        }
    }

    #[test]
    fn test_solve_conflicts_invalid_priority_index() {
    let vehicle1 = create_test_vehicle(1, 2, LaneChangeType::NoChange, 5);
    let vehicle2 = create_test_vehicle(2, 2, LaneChangeType::NoChange, 5);
        
        let conflicts = vec![CellConflict {
            cell_id: 5,
            participants: vec![1, 2],
            priority_participant_index: 5, // Invalid index (only 0 and 1 are valid)
            conflict_type: ConflictType::MergeForward,
        }];

    let mut vehicles = VehiclesStorage::new();
    vehicles.insert(1, vehicle1);
    vehicles.insert(2, vehicle2);
        let result = solve_conflicts(conflicts, &mut vehicles, &LocalLogger::none());
        assert!(result.is_err(), "solve_conflicts should return error for invalid priority index");
        
        match result {
            Err(ConflictSolverError::InvalidPriorityIndex(cell_id, index, len)) => {
                assert_eq!(cell_id, 5);
                assert_eq!(index, 5);
                assert_eq!(len, 2);
            }
            _ => panic!("Expected InvalidPriorityIndex error"),
        }
    }

    #[test]
    fn test_solve_conflicts_common_conflict() {
    let priority_vehicle = create_test_vehicle(1, 3, LaneChangeType::ChangeLeft, 5);
    let blocked_vehicle = create_test_vehicle(2, 2, LaneChangeType::NoChange, 5);
        
        let conflicts = vec![CellConflict {
            cell_id: 5,
            participants: vec![1, 2],
            priority_participant_index: 0, // First vehicle (index 0) has priority
            conflict_type: ConflictType::ForwardLaneChange,
        }];

    let mut vehicles = VehiclesStorage::new();
    vehicles.insert(1, priority_vehicle);
    vehicles.insert(2, blocked_vehicle);
        let result = solve_conflicts(conflicts, &mut vehicles, &LocalLogger::none());
        assert!(result.is_ok(), "solve_conflicts should handle common conflicts");
        
        // After solving, we can check the vehicle states
        assert_eq!(vehicles.get(&1).unwrap().intention.intention_cell_id, 5, "Priority vehicle should have target cell");
        assert_eq!(vehicles.get(&1).unwrap().intention.intention_speed, 1, "Priority vehicle should have speed 1");
        assert_eq!(vehicles.get(&2).unwrap().intention.intention_speed, 0, "Blocked vehicle should have speed 0");
    }

    #[test]
    fn test_solve_conflicts_trajectories_conflict() {
    let left_vehicle = create_test_vehicle(1, 2, LaneChangeType::ChangeLeft, 5);
    let right_vehicle = create_test_vehicle(2, 2, LaneChangeType::ChangeRight, 6);
        
        let conflicts = vec![CellConflict {
            cell_id: -1, // Trajectories conflict has no specific cell
            participants: vec![1, 2],
            priority_participant_index: 0, // Left vehicle has priority
            conflict_type: ConflictType::CrossLaneChange,
        }];

    let mut vehicles = VehiclesStorage::new();
    vehicles.insert(1, left_vehicle);
    vehicles.insert(2, right_vehicle);
        let result = solve_conflicts(conflicts, &mut vehicles, &LocalLogger::none());
        assert!(result.is_ok(), "solve_conflicts should handle trajectories conflicts");
        
        // Check that right vehicle is blocked (right maneuver loses to left maneuver)
        assert_eq!(vehicles.get(&2).unwrap().intention.intention_speed, 0, "Right vehicle should be blocked");
        assert_eq!(vehicles.get(&1).unwrap().intention.intention_speed, 1, "Left vehicle should continue");
    }

    #[test]
    fn test_solve_conflicts_conflict_zone() {
    let priority_vehicle = create_test_vehicle(1,2, LaneChangeType::NoChange, 5);
    let blocked_vehicle = create_test_vehicle(2, 2, LaneChangeType::NoChange, 6);
        
        let conflicts = vec![CellConflict {
            cell_id: 10,
            participants: vec![1, 2],
            priority_participant_index: 0, // First vehicle has priority
            conflict_type: ConflictType::CrossConflictZone,
        }];

        let mut vehicles: IndexMap<VehicleID, Vehicle> = IndexMap::new();
    vehicles.insert(1, priority_vehicle);
    vehicles.insert(2, blocked_vehicle);
        let result = solve_conflicts(conflicts, &mut vehicles, &LocalLogger::none());
        assert!(result.is_ok(), "solve_conflicts should handle conflict zone conflicts");
        
        // In conflict zones, blocked vehicles get speed 1 (not 0)
        assert_eq!(vehicles.get(&2).unwrap().intention.intention_speed, 1, "Blocked vehicle in conflict zone should have speed 1");
    }

    #[test]
    fn test_solve_conflicts_multiple_conflicts() {
    let vehicle1 = create_test_vehicle(1, 2, LaneChangeType::ChangeLeft, 5);
    let vehicle2 = create_test_vehicle(2, 2, LaneChangeType::NoChange, 5);
    let vehicle3 = create_test_vehicle(3, 1, LaneChangeType::ChangeRight, 7);
    let vehicle4 = create_test_vehicle(4, 1, LaneChangeType::NoChange, 7);
        
        let conflicts = vec![
            CellConflict {
                cell_id: 5,
                participants: vec![1, 2],
                priority_participant_index: 0, // Vehicle 1 has priority
                conflict_type: ConflictType::ForwardLaneChange,
            },
            CellConflict {
                cell_id: 7,
                participants: vec![3, 4],
                priority_participant_index: 1, // Vehicle 4 has priority (index 1)
                conflict_type: ConflictType::ForwardLaneChange,
            },
        ];

        let mut vehicles: IndexMap<VehicleID, Vehicle> = IndexMap::new();
    vehicles.insert(1, vehicle1);
    vehicles.insert(2, vehicle2);
    vehicles.insert(3, vehicle3);
    vehicles.insert(4, vehicle4);
        let result = solve_conflicts(conflicts, &mut vehicles, &LocalLogger::none());
        assert!(result.is_ok(), "solve_conflicts should handle multiple conflicts");
        
        // Check first conflict resolution
        assert_eq!(vehicles.get(&1).unwrap().intention.intention_cell_id, 5, "Vehicle 1 should get target cell");
        assert_eq!(vehicles.get(&1).unwrap().intention.intention_speed, 1, "Vehicle 1 should have speed 1");
        assert_eq!(vehicles.get(&2).unwrap().intention.intention_speed, 0, "Vehicle 2 should be blocked");
        
        // Check second conflict resolution
        assert_eq!(vehicles.get(&3).unwrap().intention.intention_speed, 0, "Vehicle 3 should be blocked");
        assert_eq!(vehicles.get(&4).unwrap().intention.intention_speed, 1, "Vehicle 4 should keep its original speed (has priority, NoChange)");
    }
}