Four README code blocks no longer compiled: `Player` was renamed `Rating`
in T2, the `Drift` trait gained a `T: Time` parameter and a second method,
and two blocks were missing imports outright. The `Rating` example needed
more than a rename — with the binding unused, `T` is ambiguous because
`ConstantDrift` implements `Drift<T>` for every `T`, so it now carries an
explicit annotation.
Nothing compiled those blocks. `src/lib.rs` gains a `cfg(doctest)` struct
carrying `#[doc = include_str!("../README.md")]`, which turns every `rust`
block into a doctest without displacing the curated crate docs as the
front page. Verified it bites: reintroducing `Player` fails the build with
E0432 rather than shipping. Illustrative blocks are fenced `text` — note
that a bare fence defaults to `rust` under rustdoc, which is how the
`variance_delta = elapsed * γ²` formula became a compile error.
Prose fixes: README claimed `Gaussian::forget` takes a square root (it
works in variance space) and pointed at a `.gamma()` builder method that
does not exist. CLAUDE.md's data-flow diagram spliced the public ingestion
shape into the internal one — `Team` is not in that chain — listed
`cdf()`/`erfc()` as public when they are `pub(crate)` and private, and
called `SkillStore` public when only `CompetitorStore` escapes the crate.
Rustdoc fixes: `EventBuilder::scores_with_sigma` claimed a debug-assert
that `Outcome::scores_with_sigma` never had and whose own docs contradict;
rejection happens at ingestion as `InvalidParameter`. `event.rs` described
`add_events_with_prior` as replaced when it is still the ingestion
chokepoint. `factors.rs` advertised `Game::custom` without noting it is
`#[doc(hidden)]`. Internal T2/T4 milestone labels are dropped from public
items; the ones in the private `time_slice` module are left alone.
Closes #35
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014b6wy2q8rnFK8U8GPJVQNU
146 lines
4.7 KiB
Rust
146 lines
4.7 KiB
Rust
use smallvec::SmallVec;
|
|
|
|
use crate::{
|
|
InferenceError, Outcome,
|
|
drift::Drift,
|
|
event::{Event, Member, Team},
|
|
history::History,
|
|
observer::Observer,
|
|
time::Time,
|
|
};
|
|
|
|
pub struct EventBuilder<'h, T, D, O, K>
|
|
where
|
|
T: Time,
|
|
D: Drift<T>,
|
|
O: Observer<T>,
|
|
K: Eq + std::hash::Hash + Clone,
|
|
{
|
|
history: &'h mut History<T, D, O, K>,
|
|
event: Event<T, K>,
|
|
current_team_idx: Option<usize>,
|
|
/// First validation failure seen while building, surfaced by `commit`.
|
|
///
|
|
/// The setters return `Self` so the chain stays fluent; they cannot return
|
|
/// a `Result` without breaking that. Recording the failure and reporting it
|
|
/// at `commit` keeps the check enforced in release, where the previous
|
|
/// `debug_assert!` was compiled out and a mismatched event was ingested
|
|
/// silently.
|
|
error: Option<InferenceError>,
|
|
}
|
|
|
|
impl<'h, T, D, O, K> EventBuilder<'h, T, D, O, K>
|
|
where
|
|
T: Time,
|
|
D: Drift<T>,
|
|
O: Observer<T>,
|
|
K: Eq + std::hash::Hash + Clone,
|
|
{
|
|
pub(crate) fn new(history: &'h mut History<T, D, O, K>, time: T) -> Self {
|
|
Self {
|
|
history,
|
|
event: Event {
|
|
time,
|
|
teams: SmallVec::new(),
|
|
outcome: Outcome::Ranked(SmallVec::new()),
|
|
},
|
|
current_team_idx: None,
|
|
error: None,
|
|
}
|
|
}
|
|
|
|
/// Add a team by its member keys (weight 1.0 each, no prior overrides).
|
|
pub fn team<I: IntoIterator<Item = K>>(mut self, keys: I) -> Self {
|
|
let members: SmallVec<[Member<K>; 4]> = keys.into_iter().map(Member::new).collect();
|
|
self.event.teams.push(Team { members });
|
|
self.current_team_idx = Some(self.event.teams.len() - 1);
|
|
self
|
|
}
|
|
|
|
/// Set per-member weights for the most recently added team.
|
|
///
|
|
/// A length mismatch is recorded and returned by [`EventBuilder::commit`]
|
|
/// as `InferenceError::MismatchedShape`, in both debug and release. The
|
|
/// weights are not applied in that case, so a partially-weighted team
|
|
/// cannot reach the history.
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// Panics if called before any `.team(...)`.
|
|
pub fn weights<I: IntoIterator<Item = f64>>(mut self, weights: I) -> Self {
|
|
let idx = self
|
|
.current_team_idx
|
|
.expect(".weights(...) called before any .team(...)");
|
|
|
|
let ws: Vec<f64> = weights.into_iter().collect();
|
|
let team = &mut self.event.teams[idx];
|
|
|
|
if ws.len() != team.members.len() {
|
|
self.error.get_or_insert(InferenceError::MismatchedShape {
|
|
kind: "weights",
|
|
expected: team.members.len(),
|
|
got: ws.len(),
|
|
});
|
|
|
|
return self;
|
|
}
|
|
|
|
for (m, w) in team.members.iter_mut().zip(ws) {
|
|
m.weight = w;
|
|
}
|
|
|
|
self
|
|
}
|
|
|
|
/// Set explicit ranks per team (length must equal number of teams).
|
|
pub fn ranking<I: IntoIterator<Item = u32>>(mut self, ranks: I) -> Self {
|
|
self.event.outcome = Outcome::ranking(ranks);
|
|
self
|
|
}
|
|
|
|
/// Set explicit per-team continuous scores; higher = better.
|
|
pub fn scores<I: IntoIterator<Item = f64>>(mut self, scores: I) -> Self {
|
|
self.event.outcome = crate::Outcome::scores(scores);
|
|
self
|
|
}
|
|
|
|
/// Set explicit per-team continuous scores with a per-event noise override.
|
|
///
|
|
/// `sigma` overrides `HistoryBuilder::score_sigma` for this event only.
|
|
/// Must be `> 0.0`. Constructing the outcome with a non-positive or NaN
|
|
/// sigma is allowed; the value is rejected with
|
|
/// `InferenceError::InvalidParameter` when the event is ingested, so
|
|
/// callers get an error from `commit` rather than a panic.
|
|
pub fn scores_with_sigma<I: IntoIterator<Item = f64>>(mut self, scores: I, sigma: f64) -> Self {
|
|
self.event.outcome = crate::Outcome::scores_with_sigma(scores, sigma);
|
|
self
|
|
}
|
|
|
|
/// Mark team `winner_idx` as winner; others tied for last.
|
|
pub fn winner(mut self, winner_idx: u32) -> Self {
|
|
self.event.outcome = Outcome::winner(winner_idx, self.event.teams.len() as u32);
|
|
self
|
|
}
|
|
|
|
/// All teams tied.
|
|
pub fn draw(mut self) -> Self {
|
|
self.event.outcome = Outcome::draw(self.event.teams.len() as u32);
|
|
self
|
|
}
|
|
|
|
/// Commit the event to the history.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// Returns the first validation failure recorded while building — see
|
|
/// [`EventBuilder::weights`] — otherwise forwards to
|
|
/// [`History::add_events`] and returns its errors.
|
|
pub fn commit(self) -> Result<(), InferenceError> {
|
|
if let Some(error) = self.error {
|
|
return Err(error);
|
|
}
|
|
|
|
self.history.add_events(std::iter::once(self.event))
|
|
}
|
|
}
|