fbsim-core 1.0.0-beta.2

A library for american football simulation
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
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
#![doc = include_str!("../docs/league.md")]
pub mod matchup;
pub mod season;
pub mod team;

use crate::team::FootballTeam;
use crate::game::play::Game;
use crate::league::matchup::{LeagueMatchups, LeagueTeamRecord};
use crate::league::team::LeagueTeam;
use crate::league::season::{LeagueSeason, LeagueSeasonScheduleOptions};
use crate::league::season::matchup::{LeagueSeasonMatchup, LeagueSeasonMatchups};
use crate::league::season::week::{LeagueSeasonWeek};

use std::collections::BTreeMap;

#[cfg(feature = "rocket_okapi")]
use rocket_okapi::okapi::schemars;
#[cfg(feature = "rocket_okapi")]
use rocket_okapi::okapi::schemars::JsonSchema;
use rand::Rng;
use serde::{Serialize, Deserialize, Deserializer};

/// # `LeagueRaw` struct
///
/// A `LeagueRaw` represents a league that is freshly deserialized from JSON
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Serialize, Deserialize)]
pub struct LeagueRaw {
    pub teams: BTreeMap<usize, LeagueTeam>,
    pub current_season: Option<LeagueSeason>,
    pub seasons: Vec<LeagueSeason>
}

impl LeagueRaw {
    pub fn validate(&self) -> Result<(), String> {
        // Ensure the IDs in the current season map to matching league team IDs
        if let Some(season) = &self.current_season {
            for (id, team) in season.teams().iter() {
                if !self.teams.contains_key(id) {
                    return Err(
                        format!(
                            "Season {} contains team {} with nonexistent ID: {}",
                            season.year(), team.name(), id
                        )
                    )
                }
            }
        }

        // Ensure the IDs in all past seasons map to matching league team IDs
        for season in self.seasons.iter() {
            for (id, team) in season.teams().iter() {
                if !self.teams.contains_key(id) {
                    return Err(
                        format!(
                            "Season {} contains team {} with nonexistent ID: {}",
                            season.year(), team.name(), id
                        )
                    )
                }
            }
        }
        Ok(())
    }
}

/// # `League` struct
///
/// A `League` represents a football league. It contains a vector of teams in
/// the league as `LeagueTeam` objects. It also contains the season that is
/// currently in-progress, and it contains a vector of past seasons
#[cfg_attr(feature = "rocket_okapi", derive(JsonSchema))]
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Serialize)]
pub struct League {
    teams: BTreeMap<usize, LeagueTeam>,
    current_season: Option<LeagueSeason>,
    seasons: Vec<LeagueSeason>
}

impl TryFrom<LeagueRaw> for League {
    type Error = String;

    fn try_from(item: LeagueRaw) -> Result<Self, Self::Error> {
        // Validate the raw league
        match item.validate() {
            Ok(()) => (),
            Err(error) => return Err(error),
        };

        // If valid, then convert
        Ok(
            League{
                teams: item.teams,
                current_season: item.current_season,
                seasons: item.seasons
            }
        )
    }
}

impl<'de> Deserialize<'de> for League {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        // Only deserialize if the conversion from raw succeeds
        let raw = LeagueRaw::deserialize(deserializer)?;
        League::try_from(raw).map_err(serde::de::Error::custom)
    }
}

impl Default for League {
    /// Default constructor for the League struct
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    /// 
    /// let my_league = League::default();
    /// ```
    fn default() -> Self {
        League{
            teams: BTreeMap::new(),
            current_season: None,
            seasons: Vec::new()
        }
    }
}

impl League {
    /// Constructor for the `League` struct in which the vec of league
    /// teams is empty
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    ///
    /// let my_league = League::new();
    /// ```
    pub fn new() -> League {
        League::default()
    }

    /// Adds a `LeagueTeam` to a `League`
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    ///
    /// let mut my_league = League::new();
    /// my_league.add_team();
    /// ```
    pub fn add_team(&mut self) {
        // Get the last item in the BTreeMap, which is auto-sorted by ID
        if let Some((&max_id, _)) = self.teams.iter().next_back() {
            // The list is non-empty and has a max ID
            self.teams.insert(max_id + 1, LeagueTeam::new());
        } else {
            // The list is empty
            self.teams.insert(0, LeagueTeam::new());
        }
    }

    /// Borrows the BTreeMap of teams immutably
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Add a few LeagueTeams to the League
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    ///
    /// // Get the BTreeMap of LeagueTeams
    /// let my_teams = my_league.teams();
    /// ```
    pub fn teams(&self) -> &BTreeMap<usize, LeagueTeam> {
        &self.teams
    }

    /// Borrows an immutable `LeagueTeam` from a `League` given the team ID
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Add a few LeagueTeams to the League
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    ///
    /// // Get the LeagueTeam with ID 2
    /// let my_team = my_league.team(2);
    /// ```
    pub fn team(&self, id: usize) -> Option<&LeagueTeam> {
        self.teams.get(&id)
    }

    /// Borrows a season from a `League` identified by its year
    ///
    /// ### Example
    /// ```
    /// use std::collections::BTreeMap;
    /// use fbsim_core::league::League;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Create a new season in the league
    /// let _ = my_league.add_season();
    ///
    /// // Borrow the past seasons from the League
    /// let my_season = my_league.season(2026);
    /// ```
    pub fn season(&self, year: usize) -> Option<&LeagueSeason> {
        // If the year corresponds to the current season, return it
        if let Some(season) = self.current_season() {
            if *season.year() == year {
                return Some(season);
            }
        }

        // Otherwise search for it in the past seasons
        self.seasons().iter().find(|&season| *season.year() == year).map(|v| v as _)
    }

    /// Borrow a week from a `League` identified by its year
    ///
    /// ### Example
    /// ```
    /// use std::collections::BTreeMap;
    /// use fbsim_core::league::League;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Create a new season in the league
    /// let _ = my_league.add_season();
    ///
    /// // Borrow the past seasons from the League
    /// let my_week = my_league.week(2026, 0);
    /// ```
    pub fn week(&self, year: usize, week: usize) -> Option<&LeagueSeasonWeek> {
        if let Some(season) = self.season(year) {
            return season.weeks().get(week);
        }
        None
    }

    /// Borrow a matchup from a `League` identified by its year
    ///
    /// ### Example
    /// ```
    /// use std::collections::BTreeMap;
    /// use fbsim_core::league::League;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Create a new season in the league
    /// let _ = my_league.add_season();
    ///
    /// // Borrow the past seasons from the League
    /// let my_matchup = my_league.matchup(2026, 0, 0);
    /// ```
    pub fn matchup(&self, year: usize, week: usize, matchup: usize) -> Option<&LeagueSeasonMatchup> {
        if let Some(week) = self.week(year, week) {
            return week.matchups().get(matchup);
        }
        None
    }

    /// Borrows the past seasons from a `League`
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    ///
    /// // Instantiate a new League
    /// let my_league = League::new();
    ///
    /// // Borrow the past seasons from the League
    /// let past_seasons = my_league.seasons();
    /// ```
    pub fn seasons(&self) -> &Vec<LeagueSeason> {
        &self.seasons
    }

    /// Borrows the current season from a `League`
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    /// use fbsim_core::league::season::LeagueSeason;
    ///
    /// // Instantiate a new League
    /// let my_league = League::new();
    ///
    /// // Borrow the current season from the League
    /// let my_season: &Option<LeagueSeason> = my_league.current_season();
    /// ```
    pub fn current_season(&self) -> &Option<LeagueSeason> {
        &self.current_season
    }

    /// Mutably borrows the current season from a `League`
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    /// use fbsim_core::league::season::LeagueSeason;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Borrow the current season from the League
    /// let my_season = my_league.current_season_mut();
    /// ```
    pub fn current_season_mut(&mut self) -> &mut Option<LeagueSeason> {
        &mut self.current_season
    }

    /// Gets the most recent year among the completed seasons
    fn most_recent_year(&self) -> usize {
        let mut most_recent_year = 0_usize;
        let seasons = self.seasons();
        for season in seasons.iter() {
            let season_year = season.year();
            if *season_year > most_recent_year {
                most_recent_year = *season_year;
            }
        }
        most_recent_year
    }

    /// Creates a new `LeagueSeason` and archives the current `LeagueSeason`
    /// if the current `LeagueSeason` is complete
    ///
    /// ### Example
    /// ```
    /// use std::collections::BTreeMap;
    /// use fbsim_core::league::League;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Create a new season for the new League
    /// let res = my_league.add_season();
    /// ```
    pub fn add_season(&mut self) -> Result<(), String> {
        // Check if the current season exists
        if let Some(season) = &mut self.current_season {
            // If so, then check if the season is complete
            if season.complete() {
                // If the season is complete, archive and create new season
                let most_recent_year = season.year();
                let mut new_season = LeagueSeason::new();
                let new_year = new_season.year_mut();
                *new_year = most_recent_year + 1;
                let old_season = season.clone();
                *season = new_season;
                self.seasons.push(old_season);
                return Ok(());
            }

            // If the season is not complete, then error
            return Err(
                format!(
                    "Cannot create new season: {}",
                    "Current season still in progress"
                )
            );
        }

        // Create a new league season
        let mut new_season = LeagueSeason::new();

        // If the past seasons list is empty then stick with the default year
        if self.seasons.is_empty() {
            self.current_season = Some(new_season);
            return Ok(());
        }

        // If the past seasons list is nonempty then update the year
        let most_recent_year = self.most_recent_year();
        let new_year = new_season.year_mut();
        *new_year = most_recent_year + 1;
        self.current_season = Some(new_season);
        Ok(())
    }

    /// Adds a `FootballTeam` to a `LeagueSeason`, and corresponds the
    /// `FootballTeam` to the `LeagueTeam` with the given team ID
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::team::FootballTeam;
    /// use fbsim_core::league::League;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Add a new team to the new league
    /// my_league.add_team();
    ///
    /// // Create a new season for the new League
    /// let res = my_league.add_season();
    ///
    /// // Add a new team to the new season corresponding to the new team
    /// my_league.add_season_team(0, FootballTeam::new());
    /// ```
    pub fn add_season_team(&mut self, id: usize, team: FootballTeam) -> Result<(), String> {
        // Ensure the given team ID exists in the league
        if !self.teams.contains_key(&id) {
            return Err(format!("No team with ID: {}", id));
        }
        
        // Add the team to the current season
        // Teams can only be added to the current season since all past seasons
        // must have already completed in order to be archived in that list
        match &mut self.current_season {
            Some(ref mut season) => season.add_team(id, team),
            None => Err("No current season to which to add a new team".to_string()),
        }
    }

    /// Generate a schedule for the current season
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::team::FootballTeam;
    /// use fbsim_core::league::League;
    /// use fbsim_core::league::season::LeagueSeasonScheduleOptions;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Add 4 new teams to the new league
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    ///
    /// // Create a new season for the new League
    /// let res = my_league.add_season();
    ///
    /// // Add 4 new teams to the new season
    /// my_league.add_season_team(0, FootballTeam::new());
    /// my_league.add_season_team(1, FootballTeam::new());
    /// my_league.add_season_team(2, FootballTeam::new());
    /// my_league.add_season_team(3, FootballTeam::new());
    ///
    /// // Generate the season schedule
    /// let mut rng = rand::thread_rng();
    /// my_league.generate_schedule(LeagueSeasonScheduleOptions::new(), &mut rng);
    /// ```
    pub fn generate_schedule(&mut self, options: LeagueSeasonScheduleOptions, rng: &mut impl Rng) -> Result<(), String> {
        // Generate a schedule for the current season if it exists
        match &mut self.current_season {
            Some(ref mut season) => season.generate_schedule(options, rng), // Return the result
            None => Err("No current season to simulate".to_string()),
        }
    }

    /// Simulate the entire current season
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::team::FootballTeam;
    /// use fbsim_core::league::League;
    /// use fbsim_core::league::season::LeagueSeasonScheduleOptions;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Add 4 new teams to the new league
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    ///
    /// // Create a new season for the new League
    /// let res = my_league.add_season();
    ///
    /// // Add 4 new season teams to the new season
    /// my_league.add_season_team(0, FootballTeam::new());
    /// my_league.add_season_team(1, FootballTeam::new());
    /// my_league.add_season_team(2, FootballTeam::new());
    /// my_league.add_season_team(3, FootballTeam::new());
    ///
    /// // Generate the season schedule
    /// let mut rng = rand::thread_rng();
    /// my_league.generate_schedule(LeagueSeasonScheduleOptions::new(), &mut rng);
    ///
    /// // Simulate the season
    /// my_league.sim(&mut rng);
    /// ```
    pub fn sim(&mut self, rng: &mut impl Rng) -> Result<(), String> {
        // Simulate the current season if it exists, return the result
        match &mut self.current_season {
            Some(ref mut season) => season.sim(rng),
            None => Err("No current season to simulate".to_string()),
        }
    }

    /// Simulate a week of the current season
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::team::FootballTeam;
    /// use fbsim_core::league::League;
    /// use fbsim_core::league::season::LeagueSeasonScheduleOptions;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Add 4 new teams to the new league
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    ///
    /// // Create a new season for the new League
    /// let res = my_league.add_season();
    ///
    /// // Add 4 new season teams to the new season
    /// my_league.add_season_team(0, FootballTeam::new());
    /// my_league.add_season_team(1, FootballTeam::new());
    /// my_league.add_season_team(2, FootballTeam::new());
    /// my_league.add_season_team(3, FootballTeam::new());
    ///
    /// // Generate the season schedule
    /// let mut rng = rand::thread_rng();
    /// my_league.generate_schedule(LeagueSeasonScheduleOptions::new(), &mut rng);
    ///
    /// // Simulate the first week of the season
    /// my_league.sim_week(0, &mut rng);
    /// ```
    pub fn sim_week(&mut self, week: usize, rng: &mut impl Rng) -> Result<(), String> {
        // Simulate a week of the current season if it exists, return the result
        match &mut self.current_season {
            Some(ref mut season) => season.sim_week(week, rng),
            None => Err("No current season to simulate".to_string()),
        }
    }

    /// Simulate a matchup from the current season
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::team::FootballTeam;
    /// use fbsim_core::league::League;
    /// use fbsim_core::league::season::LeagueSeasonScheduleOptions;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Add 4 new teams to the new league
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    ///
    /// // Create a new season for the new League
    /// let res = my_league.add_season();
    ///
    /// // Add 4 new season teams to the new season
    /// my_league.add_season_team(0, FootballTeam::new());
    /// my_league.add_season_team(1, FootballTeam::new());
    /// my_league.add_season_team(2, FootballTeam::new());
    /// my_league.add_season_team(3, FootballTeam::new());
    ///
    /// // Generate the season schedule
    /// let mut rng = rand::thread_rng();
    /// my_league.generate_schedule(LeagueSeasonScheduleOptions::new(), &mut rng);
    ///
    /// // Simulate the first week of the season
    /// my_league.sim_matchup(0, 0, &mut rng);
    /// ```
    pub fn sim_matchup(&mut self, week: usize, matchup: usize, rng: &mut impl Rng) -> Result<Game, String> {
        // Simulate a matchup from the current season if it exists, return the result
        match &mut self.current_season {
            Some(ref mut season) => season.sim_matchup(week, matchup, rng),
            None => Err("No current season to simulate".to_string()),
        }
    }

    /// Simulate a play from a matchup in the current season
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::team::FootballTeam;
    /// use fbsim_core::league::League;
    /// use fbsim_core::league::season::LeagueSeasonScheduleOptions;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Add 4 new teams to the new league
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    ///
    /// // Create a new season for the new League
    /// let res = my_league.add_season();
    ///
    /// // Add 4 new season teams to the new season
    /// my_league.add_season_team(0, FootballTeam::new());
    /// my_league.add_season_team(1, FootballTeam::new());
    /// my_league.add_season_team(2, FootballTeam::new());
    /// my_league.add_season_team(3, FootballTeam::new());
    ///
    /// // Generate the season schedule
    /// let mut rng = rand::thread_rng();
    /// my_league.generate_schedule(LeagueSeasonScheduleOptions::new(), &mut rng);
    ///
    /// // Simulate the first week of the season
    /// my_league.sim_play(0, 0, &mut rng);
    /// ```
    pub fn sim_play(&mut self, week: usize, matchup: usize, rng: &mut impl Rng) -> Result<Option<Game>, String> {
        // Simulate a matchup from the current season if it exists, return the result
        match &mut self.current_season {
            Some(ref mut season) => season.sim_play(week, matchup, rng),
            None => Err("No current season to simulate".to_string()),
        }
    }

    /// Get all matchups involving a team for a given season
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::team::FootballTeam;
    /// use fbsim_core::league::League;
    /// use fbsim_core::league::season::LeagueSeasonScheduleOptions;
    /// use fbsim_core::league::season::matchup::LeagueSeasonMatchups;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Add 4 new teams to the new league
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    ///
    /// // Create a new season for the new League
    /// let res = my_league.add_season();
    ///
    /// // Add 4 new season teams to the new season
    /// my_league.add_season_team(0, FootballTeam::new());
    /// my_league.add_season_team(1, FootballTeam::new());
    /// my_league.add_season_team(2, FootballTeam::new());
    /// my_league.add_season_team(3, FootballTeam::new());
    ///
    /// // Generate the season schedule
    /// let mut rng = rand::thread_rng();
    /// my_league.generate_schedule(LeagueSeasonScheduleOptions::new(), &mut rng);
    ///
    /// // Simulate the season
    /// my_league.sim(&mut rng);
    ///
    /// // Get the season matchups for team 0
    /// let matchups: LeagueSeasonMatchups = my_league.team_season_matchups(0, 2026).unwrap();
    /// ```
    pub fn team_season_matchups(&self, id: usize, year: usize) -> Result<LeagueSeasonMatchups, String> {
        // Ensure the team ID exists
        let _team = match self.team(id) {
            Some(t) => t,
            None => return Err(
                format!(
                    "No team found with id {}",
                    id
                )
            )
        };

        // Get the season identified by the given year
        let season = match self.season(year) {
            Some(s) => s,
            None => return Err(
                format!(
                    "No season found with year {}",
                    year
                )
            )
        };

        // Get the matchups involving the given team for that season
        season.team_matchups(id)
    }

    /// Get a team's all-time playoff record across all seasons
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    /// use fbsim_core::league::matchup::LeagueTeamRecord;
    ///
    /// // Create a league and add a team
    /// let mut my_league = League::new();
    /// my_league.add_team();
    ///
    /// // Calculate that team's playoff record
    /// let record = my_league.team_playoff_record(0);
    /// assert!(record.is_ok());
    /// assert!(record.unwrap() == LeagueTeamRecord::new());
    /// ```
    pub fn team_playoff_record(&self, id: usize) -> Result<LeagueTeamRecord, String> {
        // Ensure the team ID exists in the league
        if !self.teams.contains_key(&id) {
            return Err(format!("No team with ID: {}", id));
        }
        let mut record = LeagueTeamRecord::new();

        // Add playoff record from current season
        if let Some(season) = self.current_season() {
            let season_record = season.playoff_record(id)?;
            record.increment_wins(*season_record.wins());
            record.increment_losses(*season_record.losses());
            record.increment_ties(*season_record.ties());
        }

        // Add playoff records from past seasons
        for season in self.seasons().iter() {
            let season_record = season.playoff_record(id)?;
            record.increment_wins(*season_record.wins());
            record.increment_losses(*season_record.losses());
            record.increment_ties(*season_record.ties());
        }
        Ok(record)
    }

    /// Get a team's total championship appearances across all seasons
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    ///
    /// // Create a league and add a team
    /// let mut my_league = League::new();
    /// my_league.add_team();
    ///
    /// // Calculate that team's championship appearances
    /// let appearances = my_league.team_championship_appearances(0);
    /// assert!(appearances.is_ok());
    /// assert!(appearances.unwrap() == 0);
    /// ```
    pub fn team_championship_appearances(&self, id: usize) -> Result<usize, String> {
        // Ensure the team ID exists in the league
        if !self.teams.contains_key(&id) {
            return Err(format!("No team with ID: {}", id));
        }
        let mut appearances = 0;

        // Check current season
        if let Some(season) = self.current_season() {
            if season.team_in_championship(id)? {
                appearances += 1;
            }
        }

        // Check past seasons
        for season in self.seasons().iter() {
            if season.team_in_championship(id)? {
                appearances += 1;
            }
        }
        Ok(appearances)
    }

    /// Get a team's total championship wins across all seasons
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::League;
    ///
    /// // Create a league and add a team
    /// let mut my_league = League::new();
    /// my_league.add_team();
    ///
    /// // Calculate that team's championship wins
    /// let wins = my_league.team_championship_wins(0);
    /// assert!(wins.is_ok());
    /// assert!(wins.unwrap() == 0);
    /// ```
    pub fn team_championship_wins(&self, id: usize) -> Result<usize, String> {
        // Ensure the team ID exists in the league
        if !self.teams.contains_key(&id) {
            return Err(format!("No team with ID: {}", id));
        }
        let mut wins = 0;

        // Check current season
        if let Some(season) = self.current_season() {
            if season.team_won_championship(id)? {
                wins += 1;
            }
        }

        // Check past seasons
        for season in self.seasons().iter() {
            if season.team_won_championship(id)? {
                wins += 1;
            }
        }
        Ok(wins)
    }

    /// Get all matchups involving a team over all seasons
    ///
    /// ### Example
    /// ```
    /// use std::collections::BTreeMap;
    /// use fbsim_core::team::FootballTeam;
    /// use fbsim_core::league::League;
    /// use fbsim_core::league::season::LeagueSeasonScheduleOptions;
    ///
    /// // Instantiate a new League
    /// let mut my_league = League::new();
    ///
    /// // Add 4 new teams to the new league
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    /// my_league.add_team();
    ///
    /// // Create a new season for the new League
    /// let res = my_league.add_season();
    ///
    /// // Add 4 new season teams to the new season
    /// my_league.add_season_team(0, FootballTeam::new());
    /// my_league.add_season_team(1, FootballTeam::new());
    /// my_league.add_season_team(2, FootballTeam::new());
    /// my_league.add_season_team(3, FootballTeam::new());
    ///
    /// // Generate the season schedule
    /// let mut rng = rand::thread_rng();
    /// my_league.generate_schedule(LeagueSeasonScheduleOptions::new(), &mut rng);
    ///
    /// // Simulate the season
    /// my_league.sim(&mut rng);
    ///
    /// // Get the season matchups for team 0
    /// let matchups = my_league.team_matchups(0);
    /// assert!(matchups.is_ok());
    /// ```
    pub fn team_matchups(&self, id: usize) -> Result<LeagueMatchups, String> {
        // Ensure the team ID exists in the league
        if !self.teams.contains_key(&id) {
            return Err(format!("No team with ID: {}", id));
        }
        let mut matchups: BTreeMap<usize, LeagueSeasonMatchups> = BTreeMap::new();

        // For the current season, get the team's season matchups
        if let Some(s) = self.current_season() {
            let res = s.team_matchups(id);
            if let Ok(m) = res {
                matchups.insert(*s.year(), m);
            }
        }

        // For each previous season, get the team's season matchups
        for season in self.seasons().iter() {
            let res = season.team_matchups(id);
            if let Ok(m) = res {
                matchups.insert(*season.year(), m);
            }
        }

        // Return the matchups as a LeagueMatchups struct
        Ok(LeagueMatchups::new(matchups))
    }
}