krabmaga 0.6.0

A modern developing art for reliable and efficient Agent-based Model (ABM) simulation with the Rust language.
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
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
use crate::engine::{
    fields::{field::Field, grid_option::GridOption},
    location::Int2D,
};
use crate::rand::Rng;

use cfg_if::cfg_if;
use std::hash::Hash;

cfg_if! {
    if #[cfg(any(feature = "parallel", feature = "visualization", feature = "visualization_wasm"))]{
        use crate::utils::dbdashmap::DBDashMap;
    } else {
        use std::cell::RefCell;
        use hashbrown::HashMap;
    }
}

cfg_if! {
    if #[cfg(any(feature = "parallel", feature = "visualization", feature = "visualization_wasm"))]{
        pub struct SparseGrid2D<O: Eq + Hash + Clone + Copy> {
            pub obj2loc: DBDashMap<O, Int2D>, // old locs
            pub loc2objs: DBDashMap<Int2D, Vec<O>>, // old locs_inversed
            pub width: i32,
            pub height: i32,
        }

        impl<O: Eq + Hash + Clone + Copy> SparseGrid2D<O> {
            pub fn new(width: i32, height: i32) -> SparseGrid2D<O> {
                SparseGrid2D {
                    obj2loc: DBDashMap::with_capacity((width * height) as usize),
                    loc2objs: DBDashMap::with_capacity((width * height) as usize),
                    width,
                    height,
                }
            }

            pub fn apply_to_all_values<F>(&self, closure: F, option: GridOption)
            where
                F: Fn(&Int2D, &O) -> Option<O>,
            {
                match option {
                    GridOption::READ => {
                        self.obj2loc.apply_to_all_keys(closure);
                    },
                    GridOption::WRITE => {
                        self.obj2loc.apply_to_all_keys(closure);
                    },
                    GridOption::READWRITE =>{
                        self.obj2loc.apply_to_all_keys(closure);
                    }
                }
            }

            pub fn get_empty_bags(&self) -> Vec<Int2D>{
                let mut empty_bags = Vec::new();
                for i in 0 ..  self.width{
                    for j in 0 .. self.height{
                        match self.loc2objs.get_read(&Int2D{x: i, y: j}){
                            Some(_x) => { },
                            None => {empty_bags.push(Int2D{x: i, y: j})}
                        }
                    }
                }
                empty_bags
            }

            pub fn get(&self, object: &O) -> Option<O> {
                match self.obj2loc.get_key_value(object) {
                    Some((updated_object, _loc)) => Some(*updated_object),
                    None => None,
                }
            }

            pub fn get_objects(&self, loc: &Int2D) -> Option<Vec<O>> {
                match self.loc2objs.get_read(loc) {
                    Some(vec) => {
                        if vec.is_empty() {
                            None
                        } else {
                            Some(vec.to_vec())
                        }
                    }
                    None => None,
                }
            }
            pub fn get_objects_unbuffered(&self, loc: &Int2D) -> Option<Vec<O>> {
                match self.loc2objs.get_write(loc) {
                    Some(vec) => {
                        if vec.is_empty() {
                            None
                        } else {
                            Some(vec.to_vec())
                        }
                    }
                    None => None,
                }
            }

            pub fn get_location(&self, object: O) -> Option<Int2D> {
                match self.obj2loc.get_read(&object) {
                    Some(updated_object) => Some(*updated_object),
                    None => None,
                }
            }

            pub fn get_location_unbuffered(&self, object: O) -> Option<Int2D> {
                match self.obj2loc.get_write(&object) {
                    Some(updated_object) => Some(*updated_object),
                    None => None,
                }
            }

            pub fn get_unbuffered(&self, object: &O) -> Option<O> {
                match self.obj2loc.get_write(object){
                    Some(loc) =>{
                    for obj in self.loc2objs.get_write(&*loc).expect("error on get_write").value_mut(){
                        if obj == object {
                            return Some(*obj);
                        }
                    }
                    }, None =>{
                        return None;
                    }
                }
                None
            }

            pub fn get_random_empty_bag(&self) -> Option<Int2D>{
                let mut rng = rand::rng();
                loop {
                    let loc = Int2D{x: rng.random_range(0..self.width), y: rng.random_range(0..self.height)};
                    match self.loc2objs.get_read(&loc){
                        Some(_bag) =>{},
                        None => {
                            return Some(loc)
                        }
                    }
                }
            }

            pub fn iter_objects<F>(&self, closure: F)
            where
                F: Fn(
                    &Int2D, //location
                    &O, //value
                )
            {
                for i in 0 ..  self.width{
                    for j in 0 .. self.height{
                        let loc = Int2D{x: i, y: j};
                        let bag = self.loc2objs.get_read(&loc);
                        match bag {
                            Some(bag) =>{
                                for obj in bag{
                                    closure(&loc, &obj);
                                }
                            },
                            None => {}
                        }
                    }
                }
            }

            pub fn remove_object(&self, object: &O) {
                if let Some(old_loc) = self.obj2loc.get_read(object) {
                    self.loc2objs
                        .get_write(old_loc)
                        .expect("error on get_write")
                        .value_mut()
                        .retain(|&x| x != *object);
                }

                self.obj2loc.remove(object);
            }

            pub fn set_object_location(&self, object: O, loc: &Int2D) {
                match self.loc2objs.get_write(loc) {
                    Some(mut vec) => {
                        if !vec.is_empty() {
                            vec.retain(|&x| x != object);
                        }
                        vec.push(object);
                    }
                    None => { self.loc2objs.insert(*loc, vec![object]);},
                }
                self.obj2loc.insert(object, *loc);
            }
        }

        impl<O: Eq + Hash + Clone + Copy> Field for SparseGrid2D<O> {
            fn lazy_update(&mut self){
                self.obj2loc.lazy_update();
                self.loc2objs.lazy_update();
            }

            fn update(&mut self) {
                self.obj2loc.update();
                self.loc2objs.update();
            }
        }
    }else{

        /// Field with double buffering for sparse matrix
        pub struct SparseGrid2D<O: Eq + Hash + Clone + Copy> {
            /// Hashmap to write data. Key is location, value is the number.
            // pub locs: RefCell<HashMap<Int2D, Vec<O>>>,
            /// Hashmap to read data. Key is the value, value is the location.
            // pub rlocs: RefCell<HashMap<Int2D, Vec<O>>>,
            pub locs: Vec<RefCell<HashMap<Int2D, Vec<O>>>>,
            read: usize,
            write: usize,
            /// First dimension of the field
            pub width: i32,
            /// Second dimension of the field
            pub height: i32,
        }
        impl<O: Eq + Hash + Clone + Copy> SparseGrid2D<O> {
            /// create a new instance of SparseGrid2D
            /// # Arguments
            ///
            /// * `width` - first dimension of the field
            /// * `height` - second dimension of the field
            pub fn new(width: i32, height: i32) -> SparseGrid2D<O> {
                SparseGrid2D {
                    // locs: RefCell::new(HashMap::new()),
                    // rlocs: RefCell::new(HashMap::new()),
                    locs: vec![RefCell::new(HashMap::new()), RefCell::new(HashMap::new())],
                    read: 0,
                    write: 1,
                    width,
                    height,
                }
            }

            /// Apply a closure to all objects.
            /// You have to return an object.
            /// You can return the same object or a new/updated one or `None` to remove it.
            ///
            /// # Arguments
            /// * `closure` - closure to apply to all objects
            /// * `option` - option to read or write
            /// ## `option` possible variants
            /// * `READ` - update the objects from rlocs
            /// * `WRITE` - update the objects from locs
            /// * `READWRITE` - check locs and rlocs simultaneously to apply the closure
            ///
            /// # Example
            ///
            /// ```
            /// struct Object{
            ///     id: i32,
            ///     flag: bool,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<Object>::new(10, 10);
            /// for i in 0..10 {
            ///    for j in 0..10 {
            ///       grid.set_object_location(Object::new(i*10 + j), &Int2D::new(i, j));
            ///    }
            /// }
            ///
            /// grid.apply_to_all_values(|loc, obj| {
            ///     let mut obj = *obj
            ///     obj.flag = true;
            ///     Some(obj)
            /// }, GridOption::WRITE); // Or READWRITE
            ///
            /// grid.lazy_update();
            ///
            /// grid.apply_to_all_values(|loc, obj| {
            ///     assert!(obj.flag);
            ///     None    // return None to delete object
            /// }, GridOption::READ);  // Or READWRITE
            ///
            /// ```
            ///
            pub fn apply_to_all_values<F>(&self, closure: F, option: GridOption)
            where
                F: Fn(&Int2D, &O) -> Option<O>,
            {
                match option {
                    GridOption::READ => {
                        let mut rlocs = self.locs[self.read].borrow_mut();
                        for (key,value) in rlocs.iter_mut() {
                            for obj in value{
                                *obj = closure(key, obj).expect("error on closure");
                            }
                        }
                    },
                    GridOption::WRITE => {
                        let mut locs = self.locs[self.write].borrow_mut();
                        for (key,value) in locs.iter_mut() {
                            for obj in value{
                                *obj = closure(key, obj).expect("error on closure");
                            }
                        }
                    }
                    // TO CHECK
                    // works only with 1 element for bag
                    GridOption::READWRITE =>{
                        let rlocs = self.locs[self.read].borrow();
                        let mut locs = self.locs[self.write].borrow_mut();

                        // for each bag in read
                        for (key, value) in rlocs.iter() {
                            if let Some(write_value) = locs.get_mut(key){
                                for obj in write_value{
                                    *obj = closure(key, obj).expect("error on closure");
                                }
                            }else{
                                for obj in value{
                                    let new_bag = vec![closure(key, obj).expect("error on closure")];
                                    locs.insert(*key, new_bag);
                                }
                            }
                        }
                    }
                }
            }

            /// Return the position of the first element that matches the given value.
            /// Return None if no element matches.
            ///
            /// # Arguments
            /// * `value` - value to search for
            ///
            /// # Example
            /// ```
            /// struct Object{
            ///  id: i32,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<u16>::new(10, 10);
            /// grid.set_object_location(Object::new(1), &Int2D::new(5, 5));
            /// grid.set_object_location(Object::new(1), &Int2D::new(6, 6));
            ///
            /// grid.lazy_update();
            /// let pos = grid.get_location(&Object::new(1));
            /// assert_eq!(pos, Some(Int2D::new(5, 5)));
            ///
            /// let none = grid.get_location(&Object::new(3));
            /// assert_eq!(none, None);
            /// ```
            ///
            pub fn get_location(&self, object: &O) -> Option<Int2D> {
                let rlocs = self.locs[self.read].borrow();
                for (key, objs) in rlocs.iter() {
                    for obj in objs {
                        if *obj == *object {
                            return Some(*key);
                        }
                    }
                }
                None
            }

            /// Return the position of the first element that matches the given value from write state.
            /// Return None if no element matches.
            ///
            /// # Arguments
            /// * `value` - value to search for
            ///
            /// # Example
            /// ```
            /// struct Object{
            ///  id: i32,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<u16>::new(10, 10);
            /// grid.set_object_location(Object::new(1), &Int2D::new(5, 5));
            /// grid.set_object_location(Object::new(1), &Int2D::new(6, 6));
            ///
            /// // Work on write state, so on unupdated state
            /// let pos = grid.get_location_unbuffered(&Object::new(1));
            /// assert_eq!(pos, Some(Int2D::new(5, 5)));
            ///
            /// let none = grid.get_location_unbuffered(&Object::new(2));
            /// assert_eq!(none, None);
            ///
            /// grid.lazy_update();
            /// let pos = grid.get_location_unbuffered(&Object::new(1));
            /// assert_eq!(pos, None);
            /// ```
            ///
            pub fn get_location_unbuffered(&self, object: &O) -> Option<Int2D> {
                let locs = self.locs[self.write].borrow();
                for (key, objs) in locs.iter() {
                    for obj in objs {
                        if *obj == *object {
                            return Some(*key);
                        }
                    }
                }
                None
            }

            /// Return all the objects in a specific position. `None` if position is empty.
            ///
            /// # Arguments
            /// * `loc` - location to get the objects
            ///
            /// # Example
            /// ```
            /// struct Object{
            /// id: i32,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<Object>::new(10, 10);
            /// grid.set_object_location(Object::new(1), &Int2D::new(5, 5));
            /// grid.set_object_location(Object::new(2), &Int2D::new(5, 5));
            /// grid.set_object_location(Object::new(3), &Int2D::new(5, 5));
            ///
            /// grid.lazy_update();
            /// let objects = grid.get_objects_at(&Int2D::new(5, 5));
            /// assert_eq!(objects.unwrap().len(), 3);
            ///
            /// let none = grid.get_objects_at(&Int2D::new(6, 6));
            /// assert_eq!(none, None);
            /// ```
            pub fn get_objects(&self, loc: &Int2D) -> Option<Vec<O>> {
                self.locs[self.read].borrow().get(loc).cloned()
            }

            /// Return all the objects in a specific position from write state. `None` if position is empty.
            /// Useful when you want to get some object don't written in previous iterations, but into the current step.
            ///
            /// # Arguments
            /// * `loc` - location to get the objects
            ///
            /// # Example
            /// ```
            /// struct Object{
            ///     id: i32,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<Object>::new(10, 10);
            /// grid.set_object_location(Object::new(1), &Int2D::new(5, 5));
            /// grid.set_object_location(Object::new(2), &Int2D::new(5, 5));
            /// grid.set_object_location(Object::new(3), &Int2D::new(5, 5));
            ///
            /// let objects = grid.get_objects_at_unbuffered(&Int2D::new(5, 5));
            /// assert_eq!(objects.unwrap().len(), 3);
            ///
            /// grid.lazy_update();
            /// let none = grid.get_objects_at_unbuffered(&Int2D::new(5, 5));
            /// assert_eq!(none, None);
            ///
            /// ```
            pub fn get_objects_unbuffered(&self, loc: &Int2D) -> Option<Vec<O>> {
                self.locs[self.write].borrow().get(loc).cloned()
            }


            /// Return all the empty bags from read state.
            ///
            /// # Example
            /// ```
            /// struct Object{
            ///    id: i32,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<Object>::new(10, 10);
            /// let empty = grid.get_empty_bags();
            /// assert_eq!(empty.len(), 100);
            ///
            /// for i in 0..10 {
            ///   for j in 0..10 {
            ///      grid.set_object_location(Object::new(i*10 + j), &Int2D::new(i, j));
            ///   }
            /// }
            ///
            /// // Before an update, the grid is not updated, so the empty bags are still available
            /// let empty = grid.get_empty_bags();
            /// assert_eq!(empty.len(), 100);
            ///
            /// grid.lazy_update();
            /// let empty = grid.get_empty_bags();
            /// assert_eq!(empty.len(), 0);
            ///
            /// ```
            pub fn get_empty_bags(&self) -> Vec<Int2D>{
                let mut empty_bags = Vec::new();
                for i in 0 ..  self.width{
                    for j in 0 .. self.height{
                        let loc = Int2D{x: i, y: j};
                        match self.locs[self.read].borrow().get(&loc){
                            Some(_bag) =>{
                                if _bag.is_empty(){
                                    empty_bags.push(loc);
                                }
                            },
                            None => {
                                empty_bags.push(Int2D{x: i, y: j});
                            }
                        }
                    }
                }
                empty_bags
            }


            /// Return a random empty bag from read state. `None` if no bags are available.
            ///
            /// # Example
            /// ```
            /// struct Object{
            ///   id: i32,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<Object>::new(10, 10);
            /// let empty = grid.get_random_empty_bag();
            /// assert(empty.is_some());
            ///
            /// grid.set_object_location(Object::new(1), &empty.unwrap());
            /// grid.lazy_update();
            ///
            /// let empty2 = grid.get_random_empty_bag();
            /// assert(empty2.is_some());
            /// assert_ne!(empty.unwrap(), empty2.unwrap());
            ///
            /// ```
            pub fn get_random_empty_bag(&self) -> Option<Int2D>{
                let mut rng = rand::rng();
                loop {
                    let loc = Int2D{x: rng.random_range(0..self.width), y: rng.random_range(0..self.height)};
                    match self.locs[self.read].borrow().get(&loc){
                        Some(_bag) =>{},
                        None => {
                            return Some(loc)
                        }
                    }
                }
            }

            /// Iterate over the read state and apply the closure.
            ///
            /// # Arguments
            /// * `closure` - closure to apply to each element of the matrix
            ///
            /// # Example
            /// ```
            /// struct Object{
            ///    id: i32,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<Object>::new(10, 10);
            /// for i in 0..10{
            ///    for j in 0..10{
            ///       grid.set_object_location(Object::new(i * j), &Int2D::new(i, j));
            ///    }
            /// }
            ///
            /// grid.lazy_update();
            /// grid.iter_objects(|loc, obj| {
            ///     assert_eq!(loc.x * loc.y, obj.id);
            ///     // Do something
            /// });
            ///
            /// ```
            pub fn iter_objects<F>(&self, closure: F)
            where
                F: Fn(
                    &Int2D, //location
                    &O//value
                )
            {
                let rlocs = self.locs[self.read].borrow();
                for (key, bag) in rlocs.iter(){
                    for obj in bag{
                        closure(key, obj);
                    }
                }
            }

            /// Iterate over all objects inside the field and apply the closure.
            /// Useful when you want to access to all the objects changed/executed into the current step.
            ///
            /// # Arguments
            /// * `closure` - closure to apply to each element of the matrix
            ///
            /// # Example
            /// ```
            /// struct Object{
            ///   id: i32,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<Object>::new(10, 10);
            /// for i in 0..10{
            ///     for j in 0..10{
            ///         grid.set_object_location(Object::new(i * j), &Int2D::new(i, j));
            ///     }
            /// }
            ///
            /// grid.iter_objects_unbuffered(|loc, obj| {
            ///     assert_eq!(loc.x * loc.y, obj.id);
            ///     // Do something
            /// });
            ///
            /// ```
            pub fn iter_objects_unbuffered<F>(&self, closure: F)
            where
                F: Fn(
                    &Int2D, //location
                    &O, //value
                )
            {
                let locs = self.locs[self.write].borrow();
                for (key, bag) in locs.iter(){
                    for obj in bag{
                        closure(key, obj);
                    }
                }
            }

            /// Insert an object in a specific position.
            /// Double buffering swap the write and read state at the end of the step, so you have to call this function also if the object is not changed.
            ///
            /// If the position is empty, the value is pushed in the bag.
            /// If the position is not empty, the value is pushed in the bag and the old value is dropped.
            ///
            /// # Arguments
            /// * `obj` - object to insert
            /// * `loc` - location to insert the object
            ///
            /// # Example
            /// ```
            /// struct Object{
            ///    id: i32,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<Object>::new(10, 10);
            ///
            /// grid.set_object_location(Object::new(1), &Int2D::new(5, 5));
            /// grid.set_object_location(Object::new(2), &Int2D::new(5, 5));
            ///
            /// let none = grid.get_objects(&Int2D::new(5, 5));
            /// assert_eq!(none, None);
            ///
            /// grid.lazy_update();
            /// let objects = grid.get_objects(&Int2D::new(5, 5));
            /// assert_eq!(objects.unwrap().len(), 2);
            /// assert_eq!(objects.unwrap()[0].id, 1);
            /// assert_eq!(objects.unwrap()[1].id, 2);
            ///
            /// ```
            ///
            pub fn set_object_location(&self, object: O, loc: &Int2D) {
                let mut locs = self.locs[self.write].borrow_mut();
                match locs.get_mut(loc){
                    Some(bag) =>{
                        bag.push(object);
                    },
                    None =>{
                        locs.insert(*loc, [object].to_vec());
                    }
                }
            }

            /// Remove an object from write state.
            /// You have to use it to remove an object written/updated in this step.
            /// Double buffering swap the write and read state at the end of the step, so you have to call
            /// this function only if the object was written/set in this step.
            ///
            /// # Arguments
            /// * `obj` - object to remove
            /// * `loc` - location to remove the object
            ///
            /// # Example
            /// ```
            /// struct Object{
            ///   id: i32,
            /// }
            ///
            /// let mut grid = SparseGrid2D::<Object>::new(10, 10);
            /// grid.set_object_location(Object::new(1), &Int2D::new(5, 5));
            /// grid.set_object_location(Object::new(2), &Int2D::new(5, 5));
            ///
            /// grid.remove_object_location(&Object::new(1), &Int2D::new(5, 5));
            /// let objects = grid.get_objects_unbuffered(&Int2D::new(5, 5));
            /// assert_eq!(objects.unwrap().len(), 1);
            /// assert_eq!(objects.unwrap()[0].id, 2);
            ///
            /// grid.lazy_update();
            /// let objects = grid.get_objects(&Int2D::new(5, 5));
            /// assert_eq!(objects.unwrap().len(), 1);
            /// assert_eq!(objects.unwrap()[0].id, 2);
            ///
            /// ```
            pub fn remove_object_location(&self, object: O, loc: &Int2D) {
                let mut locs = self.locs[self.write].borrow_mut();
                let bag = locs.get_mut(loc);
                if let Some(bag) = bag {
                    bag.retain(|&obj| obj != object);
                    if bag.is_empty(){
                        locs.remove(loc);
                    }
                }
            }

        }

        impl<O: Eq + Hash + Clone + Copy> Field for SparseGrid2D<O> {
            /// Swap the state of the field and clear locs
            fn lazy_update(&mut self){
                std::mem::swap(&mut self.read, &mut self.write);
                self.locs[self.write].borrow_mut().clear();
            }

            /// Swap the state of the field and updates the rlocs matrix
            fn update(&mut self) {
                let mut rlocs = self.locs[self.read].borrow_mut();
                rlocs.clear();
                for (key, value) in self.locs[self.write].borrow().iter() {
                    rlocs.insert(*key, value.clone());
                }
                self.locs[self.write].borrow_mut().clear();
            }
        }
    }
}