Documentation (#78). Every item below was measured against the code rather than read: - `expected_information_gain` and `predict_ranking` had `# Errors` immediately followed by `# Preconditions`, with the error list stranded at the bottom of the latter — rustdoc rendered a BLANK Errors section on both. The heading now sits with its content. - `predict_outcome`, `predict_ranking` and the free `expected_information_gain` all omitted `GridTooCoarse`. - `predict_margin` claimed `JointUnavailable` "if the LATEST slice holds ranked events". Measured with an early ranked slice and a late scored one: it fails. The condition is *any* slice. - `add_events` documented three errors and can return five more; it also claimed a weights `MismatchedShape` that is unreachable through it, since weights arrive one-per-`Member`. That check belongs to `EventBuilder::weights`, and the doc now says so. - `converge` and `converge_partial` both omitted the drift-variance `InvalidParameter`. `History` gains a hand-written `Debug` (#76). Summarising, not exhaustive — a derived one would print every competitor's skill at every slice. It exists because without it a consumer cannot `#[derive(Debug)]` on any struct holding a `History`, which is how both known consumers store one. `#[non_exhaustive]` on all 17 `InferenceError` struct variants and on `Outcome::Scored` (#74). The enum carried the attribute; no variant did, so adding a field to any of them — and downstream construction of any of them — were both in the public contract. This crate added two variants in two days. The options structs are deliberately NOT sealed. `ConvergenceOptions` and `GameOptions` are constructed by struct literal at 65 sites of which only 8 use `..default()`, and specifying all three convergence fields is a natural complete statement rather than a partial one. That is a real trade-off rather than an oversight, and it is left as a decision on #74. Also spells `UnknownKeys::Reject` explicitly at both sites that wildcarded it. `#[non_exhaustive]` on your own enum gives no exhaustiveness safety net if you then match `_`. Sealing the variants pushed ten test sites from constructing errors to `matches!`, which is the better assertion anyway — an `assert_eq!` against a constructed error breaks whenever a field is added, which is the exact fragility the attribute exists to prevent. BREAKING CHANGE: `InferenceError`'s struct variants and `Outcome::Scored` are `#[non_exhaustive]` — downstream patterns need `..` and downstream construction is no longer possible. Refs #78, #76, #74 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011hcFjNDmHXZF8URGLku5zZ
253 lines
7.6 KiB
Rust
253 lines
7.6 KiB
Rust
use trueskill_tt::{
|
|
ConstantDrift, ConvergenceOptions, Game, GameOptions, Gaussian, InferenceError, Outcome, Rating,
|
|
};
|
|
|
|
type R = Rating<i64, ConstantDrift>;
|
|
|
|
fn default_rating() -> R {
|
|
R::new(
|
|
Gaussian::from_ms(25.0, 25.0 / 3.0),
|
|
25.0 / 6.0,
|
|
ConstantDrift::new(25.0 / 300.0),
|
|
)
|
|
}
|
|
|
|
#[test]
|
|
fn game_ranked_1v1_golden() {
|
|
let a = default_rating();
|
|
let b = default_rating();
|
|
let g = Game::<i64, _>::ranked(
|
|
&[&[a], &[b]],
|
|
Outcome::winner(0, 2),
|
|
&GameOptions::default(),
|
|
)
|
|
.unwrap();
|
|
let p = g.posteriors();
|
|
assert!(p[0][0].mu() > 25.0);
|
|
assert!(p[1][0].mu() < 25.0);
|
|
assert!((p[0][0].sigma() - p[1][0].sigma()).abs() < 1e-6);
|
|
}
|
|
|
|
#[test]
|
|
fn game_one_v_one_shortcut() {
|
|
let a = default_rating();
|
|
let b = default_rating();
|
|
let (a_post, b_post) =
|
|
Game::<i64, _>::one_v_one(&a, &b, Outcome::winner(0, 2), &GameOptions::default()).unwrap();
|
|
assert!(a_post.mu() > 25.0);
|
|
assert!(b_post.mu() < 25.0);
|
|
}
|
|
|
|
#[test]
|
|
fn game_ranked_rejects_bad_p_draw() {
|
|
let a = R::new(Gaussian::default(), 1.0, ConstantDrift::new(0.0));
|
|
let err = Game::<i64, _>::ranked(
|
|
&[&[a], &[a]],
|
|
Outcome::winner(0, 2),
|
|
&GameOptions {
|
|
p_draw: 1.5,
|
|
score_sigma: 1.0,
|
|
convergence: ConvergenceOptions::default(),
|
|
},
|
|
)
|
|
.unwrap_err();
|
|
assert!(matches!(err, InferenceError::InvalidProbability { .. }));
|
|
}
|
|
|
|
#[test]
|
|
fn game_ranked_rejects_mismatched_ranks() {
|
|
let a = R::new(Gaussian::default(), 1.0, ConstantDrift::new(0.0));
|
|
let err = Game::<i64, _>::ranked(
|
|
&[&[a], &[a]],
|
|
Outcome::ranking([0, 1, 2]),
|
|
&GameOptions::default(),
|
|
)
|
|
.unwrap_err();
|
|
assert!(matches!(err, InferenceError::MismatchedShape { .. }));
|
|
}
|
|
|
|
#[test]
|
|
fn game_free_for_all_three_players() {
|
|
let a = default_rating();
|
|
let b = default_rating();
|
|
let c = default_rating();
|
|
let g = Game::<i64, _>::free_for_all(
|
|
&[&a, &b, &c],
|
|
Outcome::ranking([0, 1, 2]),
|
|
&GameOptions::default(),
|
|
)
|
|
.unwrap();
|
|
let p = g.posteriors();
|
|
assert_eq!(p.len(), 3);
|
|
assert!(p[0][0].mu() > p[1][0].mu());
|
|
assert!(p[1][0].mu() > p[2][0].mu());
|
|
}
|
|
|
|
#[test]
|
|
fn game_log_evidence_is_finite() {
|
|
let a = default_rating();
|
|
let b = default_rating();
|
|
let g = Game::<i64, _>::ranked(
|
|
&[&[a], &[b]],
|
|
Outcome::winner(0, 2),
|
|
&GameOptions::default(),
|
|
)
|
|
.unwrap();
|
|
assert!(g.log_evidence().is_finite());
|
|
assert!(g.log_evidence() < 0.0);
|
|
}
|
|
|
|
/// `one_v_one` used to hardcode `GameOptions::default()`, so a 1v1 could
|
|
/// never set `p_draw` and a drawn 1v1 was unreachable through it.
|
|
#[test]
|
|
fn one_v_one_honours_the_draw_probability_it_is_given() {
|
|
let a = default_rating();
|
|
let b = default_rating();
|
|
|
|
// Default options still reject a draw, because the default p_draw is zero.
|
|
let err = Game::<i64, _>::one_v_one(&a, &b, Outcome::draw(2), &GameOptions::default())
|
|
.expect_err("a draw needs a positive p_draw");
|
|
assert!(matches!(
|
|
err,
|
|
InferenceError::TieWithoutDrawProbability { .. }
|
|
));
|
|
|
|
// With a draw probability supplied it succeeds — which was impossible
|
|
// before the signature took options.
|
|
let options = GameOptions {
|
|
p_draw: 0.25,
|
|
..GameOptions::default()
|
|
};
|
|
let (a_post, b_post) = Game::<i64, _>::one_v_one(&a, &b, Outcome::draw(2), &options)
|
|
.expect("a draw is representable once p_draw is positive");
|
|
|
|
// A symmetric draw leaves the means alone and sharpens both sides.
|
|
assert!((a_post.mu() - b_post.mu()).abs() < 1e-9);
|
|
assert!(a_post.sigma() < 25.0 / 3.0);
|
|
}
|
|
|
|
/// Convergence options reach the 1v1 path too, not just `p_draw`.
|
|
#[test]
|
|
fn one_v_one_honours_convergence_options() {
|
|
let a = default_rating();
|
|
let b = default_rating();
|
|
let options = GameOptions {
|
|
convergence: ConvergenceOptions::default(),
|
|
..GameOptions::default()
|
|
};
|
|
let (a_post, _) = Game::<i64, _>::one_v_one(&a, &b, Outcome::winner(0, 2), &options).unwrap();
|
|
assert!(a_post.mu() > 25.0);
|
|
}
|
|
|
|
/// `Game` is a public entry point that does not pass through `History`'s
|
|
/// ingestion chokepoint, so it needs its own boundary — and did not have one.
|
|
///
|
|
/// A one-team game panicked at `src/game.rs:317` with "range start index 1 out
|
|
/// of range for slice of length 0", in release, from safe API. This is the
|
|
/// same defect `tests/ingestion_shape.rs` covers for `History`; fixing that
|
|
/// path left this one open, because they share no validation.
|
|
mod malformed_games {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn a_one_team_ranked_game_is_an_error_not_a_panic() {
|
|
let a = default_rating();
|
|
let err = Game::<i64, _>::ranked(&[&[a]], Outcome::winner(0, 1), &GameOptions::default())
|
|
.unwrap_err();
|
|
assert!(
|
|
matches!(err, InferenceError::NotEnoughTeams { got: 1, .. }),
|
|
"{err:?}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn a_one_team_scored_game_is_an_error_not_a_panic() {
|
|
let a = default_rating();
|
|
let err = Game::<i64, _>::scored(
|
|
&[&[a]],
|
|
Outcome::scores([1.0]),
|
|
&GameOptions {
|
|
score_sigma: 1.0,
|
|
..GameOptions::default()
|
|
},
|
|
)
|
|
.unwrap_err();
|
|
assert!(
|
|
matches!(err, InferenceError::NotEnoughTeams { got: 1, .. }),
|
|
"{err:?}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn a_zero_team_game_is_an_error() {
|
|
let err =
|
|
Game::<i64, ConstantDrift>::ranked(&[], Outcome::ranking([]), &GameOptions::default())
|
|
.unwrap_err();
|
|
assert!(
|
|
matches!(err, InferenceError::NotEnoughTeams { got: 0, .. }),
|
|
"{err:?}"
|
|
);
|
|
}
|
|
|
|
/// The quiet half: an empty team contributed no performance, so the game
|
|
/// returned a finite posterior for its opponent as though it had won one.
|
|
#[test]
|
|
fn an_empty_team_is_an_error() {
|
|
let a = default_rating();
|
|
let err =
|
|
Game::<i64, _>::ranked(&[&[], &[a]], Outcome::winner(0, 2), &GameOptions::default())
|
|
.unwrap_err();
|
|
assert!(
|
|
matches!(err, InferenceError::EmptyTeam { team: 0, .. }),
|
|
"{err:?}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn a_non_finite_score_is_an_error() {
|
|
let a = default_rating();
|
|
for bad in [f64::NAN, f64::INFINITY, f64::NEG_INFINITY] {
|
|
let err = Game::<i64, _>::scored(
|
|
&[&[a], &[a]],
|
|
Outcome::scores([bad, 1.0]),
|
|
&GameOptions {
|
|
score_sigma: 1.0,
|
|
..GameOptions::default()
|
|
},
|
|
)
|
|
.unwrap_err();
|
|
assert!(
|
|
matches!(err, InferenceError::InvalidParameter { name: "score", .. }),
|
|
"{bad}: {err:?}"
|
|
);
|
|
}
|
|
}
|
|
|
|
/// `free_for_all` and `one_v_one` build their teams internally, so they
|
|
/// must keep working — the check must not catch well-formed games.
|
|
#[test]
|
|
fn well_formed_games_are_untouched() {
|
|
let a = default_rating();
|
|
assert!(
|
|
Game::<i64, _>::ranked(
|
|
&[&[a], &[a]],
|
|
Outcome::winner(0, 2),
|
|
&GameOptions::default()
|
|
)
|
|
.is_ok()
|
|
);
|
|
assert!(
|
|
Game::<i64, _>::free_for_all(
|
|
&[&a, &a, &a],
|
|
Outcome::ranking([0, 1, 2]),
|
|
&GameOptions::default()
|
|
)
|
|
.is_ok()
|
|
);
|
|
assert!(
|
|
Game::<i64, _>::one_v_one(&a, &a, Outcome::winner(0, 2), &GameOptions::default())
|
|
.is_ok()
|
|
);
|
|
}
|
|
}
|