use crate::bandit::{
ContextualBandit, checked_finite_add, checked_increment, validate_arm, validate_reward_finite,
};
use crate::error::RillError;
use rand::Rng;
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct LinUcbConfig {
pub alpha: f64,
pub arm_count: usize,
pub feature_count: usize,
}
impl Default for LinUcbConfig {
fn default() -> Self {
Self {
alpha: 1.0,
arm_count: 2,
feature_count: 1,
}
}
}
impl LinUcbConfig {
pub fn validate(&self) -> Result<(), RillError> {
if self.arm_count == 0 {
return Err(RillError::InvalidArmCount(self.arm_count));
}
if self.feature_count == 0 {
return Err(RillError::InvalidFeatureCount(self.feature_count));
}
if !self.alpha.is_finite() || self.alpha <= 0.0 {
return Err(RillError::InvalidParameter {
name: "alpha",
value: self.alpha,
});
}
Ok(())
}
}
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
pub struct LinUcb {
arm_count: usize,
feature_count: usize,
alpha: f64,
a_matrices: Vec<Vec<Vec<f64>>>,
b_vectors: Vec<Vec<f64>>,
samples_seen: u64,
}
impl LinUcb {
pub fn new(config: LinUcbConfig) -> Result<Self, RillError> {
config.validate()?;
let d = config.feature_count;
let a_matrices = (0..config.arm_count).map(|_| identity_matrix(d)).collect();
let b_vectors = (0..config.arm_count).map(|_| vec![0.0; d]).collect();
Ok(Self {
arm_count: config.arm_count,
feature_count: config.feature_count,
alpha: config.alpha,
a_matrices,
b_vectors,
samples_seen: 0,
})
}
pub const fn alpha(&self) -> f64 {
self.alpha
}
pub fn a_matrix(&self, arm: usize) -> Result<&[Vec<f64>], RillError> {
validate_arm(self.arm_count, arm)?;
Ok(&self.a_matrices[arm])
}
pub fn b_vector(&self, arm: usize) -> Result<&[f64], RillError> {
validate_arm(self.arm_count, arm)?;
Ok(&self.b_vectors[arm])
}
pub fn validate(&self) -> Result<(), RillError> {
LinUcbConfig {
alpha: self.alpha,
arm_count: self.arm_count,
feature_count: self.feature_count,
}
.validate()?;
if self.a_matrices.len() != self.arm_count || self.b_vectors.len() != self.arm_count {
return Err(RillError::InvalidState(
"arm_count does not match per-arm state lengths".to_owned(),
));
}
for arm in 0..self.arm_count {
let matrix = &self.a_matrices[arm];
let vector = &self.b_vectors[arm];
if matrix.len() != self.feature_count
|| matrix.iter().any(|row| row.len() != self.feature_count)
|| vector.len() != self.feature_count
{
return Err(RillError::InvalidState(format!(
"arm {arm} state does not match feature_count"
)));
}
if matrix.iter().flatten().any(|value| !value.is_finite())
|| vector.iter().any(|value| !value.is_finite())
{
return Err(RillError::InvalidState(format!(
"arm {arm} state contains a non-finite value"
)));
}
for (i, row) in matrix.iter().enumerate() {
for (j, &value) in row.iter().take(i).enumerate() {
if value != matrix[j][i] {
return Err(RillError::InvalidState(format!(
"A matrix for arm {arm} is not symmetric"
)));
}
}
}
if !matrix_is_positive_definite(matrix) {
return Err(RillError::InvalidState(format!(
"A matrix for arm {arm} is not positive definite"
)));
}
}
Ok(())
}
fn validate_context(&self, context: &[f64]) -> Result<(), RillError> {
if context.len() != self.feature_count {
return Err(RillError::DimensionMismatch {
expected: self.feature_count,
actual: context.len(),
});
}
for (i, &v) in context.iter().enumerate() {
if !v.is_finite() {
return Err(RillError::NonFiniteValue {
field: "context",
value: context[i],
});
}
}
Ok(())
}
fn arm_score(&self, arm: usize, context: &[f64]) -> Result<f64, RillError> {
let a_inv = matrix_inverse(&self.a_matrices[arm])?;
let b = &self.b_vectors[arm];
let theta = matrix_vector_mul(&a_inv, b);
let exploitation = dot(&theta, context);
let quad = quadratic_form(context, &a_inv);
let quad_safe = if quad < 0.0 { 0.0 } else { quad };
let score = exploitation + self.alpha * quad_safe.sqrt();
if !score.is_finite() {
return Err(RillError::NonFiniteValue {
field: "LinUCB score",
value: score,
});
}
Ok(score)
}
}
impl ContextualBandit for LinUcb {
fn arm_count(&self) -> usize {
self.arm_count
}
fn feature_count(&self) -> usize {
self.feature_count
}
fn samples_seen(&self) -> u64 {
self.samples_seen
}
fn select(&self, context: &[f64], rng: &mut impl Rng) -> Result<usize, RillError> {
self.validate_context(context)?;
let mut best_arm = 0usize;
let mut best_score = f64::NEG_INFINITY;
let mut tied = 0usize;
for arm in 0..self.arm_count {
let score = self.arm_score(arm, context)?;
if score > best_score {
best_score = score;
best_arm = arm;
tied = 1;
} else if score == best_score {
tied += 1;
if rng.gen_range(0..tied) == 0 {
best_arm = arm;
}
}
}
Ok(best_arm)
}
fn update(&mut self, arm: usize, context: &[f64], reward: f64) -> Result<(), RillError> {
validate_arm(self.arm_count, arm)?;
self.validate_context(context)?;
validate_reward_finite(reward)?;
let d = self.feature_count;
let mut next_a = self.a_matrices[arm].clone();
for i in 0..d {
for j in 0..d {
next_a[i][j] =
checked_finite_add(next_a[i][j], context[i] * context[j], "A matrix")?;
}
}
let mut next_b = self.b_vectors[arm].clone();
for i in 0..d {
next_b[i] = checked_finite_add(next_b[i], reward * context[i], "b vector")?;
}
let next_samples = checked_increment(self.samples_seen, "samples_seen")?;
self.a_matrices[arm] = next_a;
self.b_vectors[arm] = next_b;
self.samples_seen = next_samples;
Ok(())
}
fn reset(&mut self) {
for a in &mut self.a_matrices {
*a = identity_matrix(self.feature_count);
}
for b in &mut self.b_vectors {
for v in b.iter_mut() {
*v = 0.0;
}
}
self.samples_seen = 0;
}
}
#[cfg(feature = "serde")]
#[derive(serde::Deserialize)]
struct LinUcbState {
arm_count: usize,
feature_count: usize,
alpha: f64,
a_matrices: Vec<Vec<Vec<f64>>>,
b_vectors: Vec<Vec<f64>>,
samples_seen: u64,
}
#[cfg(feature = "serde")]
impl<'de> serde::Deserialize<'de> for LinUcb {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
let state = LinUcbState::deserialize(deserializer)?;
let bandit = Self {
arm_count: state.arm_count,
feature_count: state.feature_count,
alpha: state.alpha,
a_matrices: state.a_matrices,
b_vectors: state.b_vectors,
samples_seen: state.samples_seen,
};
bandit.validate().map_err(serde::de::Error::custom)?;
Ok(bandit)
}
}
fn identity_matrix(d: usize) -> Vec<Vec<f64>> {
let mut m = vec![vec![0.0; d]; d];
for (i, row) in m.iter_mut().enumerate() {
row[i] = 1.0;
}
m
}
fn matrix_is_positive_definite(matrix: &[Vec<f64>]) -> bool {
let n = matrix.len();
let mut lower = vec![vec![0.0; n]; n];
for i in 0..n {
for j in 0..=i {
let correction: f64 = (0..j).map(|k| lower[i][k] * lower[j][k]).sum();
let residual = matrix[i][j] - correction;
if i == j {
if !residual.is_finite() || residual <= 0.0 {
return false;
}
lower[i][j] = residual.sqrt();
} else {
lower[i][j] = residual / lower[j][j];
if !lower[i][j].is_finite() {
return false;
}
}
}
}
true
}
#[allow(clippy::needless_range_loop)]
fn matrix_inverse(matrix: &[Vec<f64>]) -> Result<Vec<Vec<f64>>, RillError> {
let n = matrix.len();
let mut aug = vec![vec![0.0; 2 * n]; n];
for i in 0..n {
for j in 0..n {
aug[i][j] = matrix[i][j];
}
aug[i][n + i] = 1.0;
}
for col in 0..n {
let mut pivot = col;
let mut max_val = aug[col][col].abs();
for row in (col + 1)..n {
if aug[row][col].abs() > max_val {
max_val = aug[row][col].abs();
pivot = row;
}
}
if max_val < 1e-12 {
return Err(RillError::InvalidParameter {
name: "matrix",
value: 0.0,
});
}
if pivot != col {
aug.swap(col, pivot);
}
let pivot_val = aug[col][col];
for j in 0..(2 * n) {
aug[col][j] /= pivot_val;
}
for row in 0..n {
if row == col {
continue;
}
let factor = aug[row][col];
if factor == 0.0 {
continue;
}
for j in 0..(2 * n) {
aug[row][j] -= factor * aug[col][j];
}
}
}
let mut inv = vec![vec![0.0; n]; n];
for i in 0..n {
for j in 0..n {
inv[i][j] = aug[i][n + j];
}
}
Ok(inv)
}
fn matrix_vector_mul(matrix: &[Vec<f64>], vector: &[f64]) -> Vec<f64> {
let n = matrix.len();
let vector = &vector[..n];
matrix
.iter()
.map(|row| {
row[..n]
.iter()
.zip(vector)
.map(|(matrix_value, vector_value)| matrix_value * vector_value)
.sum()
})
.collect()
}
fn dot(a: &[f64], b: &[f64]) -> f64 {
a.iter().zip(b.iter()).map(|(x, y)| x * y).sum()
}
fn quadratic_form(x: &[f64], matrix: &[Vec<f64>]) -> f64 {
let n = x.len();
let mut result = 0.0;
for i in 0..n {
for j in 0..n {
result += x[i] * matrix[i][j] * x[j];
}
}
result
}
#[cfg(test)]
mod tests {
use super::*;
use rand::SeedableRng;
use rand_chacha::ChaCha8Rng;
fn make_bandit() -> LinUcb {
LinUcb::new(LinUcbConfig {
alpha: 1.0,
arm_count: 3,
feature_count: 2,
})
.unwrap()
}
#[test]
fn rejects_zero_arm_count() {
let result = LinUcb::new(LinUcbConfig {
alpha: 1.0,
arm_count: 0,
feature_count: 2,
});
assert!(matches!(result, Err(RillError::InvalidArmCount(0))));
}
#[test]
fn rejects_zero_feature_count() {
let result = LinUcb::new(LinUcbConfig {
alpha: 1.0,
arm_count: 3,
feature_count: 0,
});
assert!(matches!(result, Err(RillError::InvalidFeatureCount(0))));
}
#[test]
fn rejects_invalid_alpha() {
for &bad in &[0.0, -1.0, f64::NAN, f64::INFINITY] {
let result = LinUcb::new(LinUcbConfig {
alpha: bad,
arm_count: 3,
feature_count: 2,
});
assert!(matches!(result, Err(RillError::InvalidParameter { .. })));
}
}
#[test]
fn initial_state() {
let b = make_bandit();
assert_eq!(b.arm_count(), 3);
assert_eq!(b.feature_count(), 2);
assert_eq!(b.samples_seen(), 0);
assert!((b.alpha() - 1.0).abs() < 1e-12);
}
#[test]
fn initial_a_is_identity() {
let b = make_bandit();
let a = b.a_matrix(0).unwrap();
assert!((a[0][0] - 1.0).abs() < 1e-12);
assert!((a[0][1] - 0.0).abs() < 1e-12);
assert!((a[1][0] - 0.0).abs() < 1e-12);
assert!((a[1][1] - 1.0).abs() < 1e-12);
}
#[test]
fn initial_b_is_zero() {
let b = make_bandit();
let bv = b.b_vector(0).unwrap();
assert!((bv[0] - 0.0).abs() < 1e-12);
assert!((bv[1] - 0.0).abs() < 1e-12);
}
#[test]
fn initial_ties_are_randomized() {
let b = make_bandit();
let mut rng = ChaCha8Rng::seed_from_u64(12);
let mut seen = std::collections::HashSet::new();
for _ in 0..100 {
seen.insert(b.select(&[0.5, 0.8], &mut rng).unwrap());
}
assert_eq!(seen.len(), b.arm_count());
}
#[test]
fn select_returns_valid_arm() {
let b = make_bandit();
let mut rng = ChaCha8Rng::seed_from_u64(42);
let context = [0.5, 0.8];
let arm = b.select(&context, &mut rng).unwrap();
assert!(arm < 3);
}
#[test]
fn update_modifies_a_and_b() {
let mut b = make_bandit();
let context = [0.5, 0.8];
b.update(0, &context, 1.0).unwrap();
let a = b.a_matrix(0).unwrap();
assert!((a[0][0] - (1.0 + 0.5 * 0.5)).abs() < 1e-12);
assert!((a[0][1] - (0.5 * 0.8)).abs() < 1e-12);
assert!((a[1][0] - (0.8 * 0.5)).abs() < 1e-12);
assert!((a[1][1] - (1.0 + 0.8 * 0.8)).abs() < 1e-12);
let bv = b.b_vector(0).unwrap();
assert!((bv[0] - 0.5).abs() < 1e-12);
assert!((bv[1] - 0.8).abs() < 1e-12);
assert_eq!(b.samples_seen(), 1);
}
#[test]
fn update_does_not_affect_other_arms() {
let mut b = make_bandit();
let context = [0.5, 0.8];
b.update(0, &context, 1.0).unwrap();
let a1 = b.a_matrix(1).unwrap();
assert!((a1[0][0] - 1.0).abs() < 1e-12);
let b1 = b.b_vector(1).unwrap();
assert!((b1[0] - 0.0).abs() < 1e-12);
}
#[test]
fn select_rejects_wrong_context_length() {
let b = make_bandit();
let mut rng = ChaCha8Rng::seed_from_u64(0);
assert!(b.select(&[0.5], &mut rng).is_err());
assert!(b.select(&[0.5, 0.8, 0.9], &mut rng).is_err());
}
#[test]
fn select_rejects_non_finite_context() {
let b = make_bandit();
let mut rng = ChaCha8Rng::seed_from_u64(0);
assert!(b.select(&[f64::NAN, 0.8], &mut rng).is_err());
assert!(b.select(&[0.5, f64::INFINITY], &mut rng).is_err());
}
#[test]
fn update_rejects_invalid_arm() {
let mut b = make_bandit();
let context = [0.5, 0.8];
assert!(b.update(3, &context, 1.0).is_err());
}
#[test]
fn update_rejects_wrong_context_length() {
let mut b = make_bandit();
assert!(b.update(0, &[0.5], 1.0).is_err());
assert!(b.update(0, &[0.5, 0.8, 0.9], 1.0).is_err());
}
#[test]
fn update_rejects_non_finite_reward() {
let mut b = make_bandit();
let context = [0.5, 0.8];
assert!(b.update(0, &context, f64::NAN).is_err());
assert!(b.update(0, &context, f64::INFINITY).is_err());
}
#[test]
fn update_rejects_arithmetic_overflow_without_mutating_state() {
let mut b = make_bandit();
let before = b.clone();
assert!(b.update(0, &[f64::MAX, f64::MAX], 1.0).is_err());
assert_eq!(b.a_matrices, before.a_matrices);
assert_eq!(b.b_vectors, before.b_vectors);
assert_eq!(b.samples_seen(), before.samples_seen());
}
#[test]
fn a_matrix_rejects_invalid_arm() {
let b = make_bandit();
assert!(b.a_matrix(5).is_err());
}
#[test]
fn b_vector_rejects_invalid_arm() {
let b = make_bandit();
assert!(b.b_vector(5).is_err());
}
#[test]
fn reset_clears_state() {
let mut b = make_bandit();
let context = [0.5, 0.8];
b.update(0, &context, 1.0).unwrap();
b.update(1, &context, 0.5).unwrap();
assert_eq!(b.samples_seen(), 2);
b.reset();
assert_eq!(b.samples_seen(), 0);
let a = b.a_matrix(0).unwrap();
assert!((a[0][0] - 1.0).abs() < 1e-12);
let bv = b.b_vector(0).unwrap();
assert!((bv[0] - 0.0).abs() < 1e-12);
}
#[test]
fn identity_matrix_inverse_is_identity() {
let ident = identity_matrix(3);
let inv = matrix_inverse(&ident).unwrap();
for (i, row) in inv.iter().enumerate() {
for (j, &val) in row.iter().enumerate() {
let expected = if i == j { 1.0 } else { 0.0 };
assert!((val - expected).abs() < 1e-12);
}
}
}
#[test]
fn known_2x2_matrix_inverse() {
let matrix = vec![vec![4.0, 7.0], vec![2.0, 6.0]];
let inv = matrix_inverse(&matrix).unwrap();
assert!((inv[0][0] - 0.6).abs() < 1e-10);
assert!((inv[0][1] - (-0.7)).abs() < 1e-10);
assert!((inv[1][0] - (-0.2)).abs() < 1e-10);
assert!((inv[1][1] - 0.4).abs() < 1e-10);
}
#[test]
fn singular_matrix_inverse_returns_error() {
let matrix = vec![vec![1.0, 2.0], vec![2.0, 4.0]];
let result = matrix_inverse(&matrix);
assert!(result.is_err());
}
#[test]
fn dot_product_correct() {
assert!((dot(&[1.0, 2.0, 3.0], &[4.0, 5.0, 6.0]) - 32.0).abs() < 1e-12);
}
#[test]
fn matrix_vector_mul_correct() {
let m = vec![vec![1.0, 2.0], vec![3.0, 4.0]];
let v = vec![5.0, 6.0];
let r = matrix_vector_mul(&m, &v);
assert!((r[0] - 17.0).abs() < 1e-12);
assert!((r[1] - 39.0).abs() < 1e-12);
}
#[test]
fn quadratic_form_correct() {
let ident = identity_matrix(3);
let x = [1.0, 2.0, 3.0];
let q = quadratic_form(&x, &ident);
assert!((q - 14.0).abs() < 1e-12);
}
#[test]
fn contextual_selection_prefers_aligned_arm() {
let mut b = LinUcb::new(LinUcbConfig {
alpha: 0.1,
arm_count: 2,
feature_count: 2,
})
.unwrap();
let mut rng = ChaCha8Rng::seed_from_u64(7);
for _ in 0..20 {
b.update(0, &[1.0, 0.0], 1.0).unwrap();
}
for _ in 0..20 {
b.update(1, &[0.0, 1.0], 1.0).unwrap();
}
let arm = b.select(&[1.0, 0.0], &mut rng).unwrap();
assert_eq!(arm, 0);
let arm = b.select(&[0.0, 1.0], &mut rng).unwrap();
assert_eq!(arm, 1);
}
#[test]
fn learns_to_prefer_high_reward_arm() {
let mut b = LinUcb::new(LinUcbConfig {
alpha: 0.5,
arm_count: 2,
feature_count: 1,
})
.unwrap();
let mut rng = ChaCha8Rng::seed_from_u64(99);
for step in 1..=100 {
let x = step as f64 * 0.1;
let arm = b.select(&[x], &mut rng).unwrap();
let reward = if arm == 0 { 2.0 * x } else { 0.1 * x };
b.update(arm, &[x], reward).unwrap();
}
let final_arm = b.select(&[5.0], &mut rng).unwrap();
assert_eq!(final_arm, 0);
}
#[cfg(feature = "serde")]
#[test]
fn serde_roundtrip() {
let mut b = LinUcb::new(LinUcbConfig {
alpha: 1.5,
arm_count: 2,
feature_count: 3,
})
.unwrap();
b.update(0, &[1.0, 0.5, 0.2], 1.0).unwrap();
b.update(1, &[0.3, 0.7, 0.9], 0.5).unwrap();
let json = serde_json::to_string(&b).unwrap();
let restored: LinUcb = serde_json::from_str(&json).unwrap();
assert_eq!(restored.arm_count(), b.arm_count());
assert_eq!(restored.feature_count(), b.feature_count());
assert_eq!(restored.samples_seen(), b.samples_seen());
assert!((restored.alpha() - b.alpha()).abs() < 1e-12);
let orig_a = b.a_matrix(0).unwrap();
let rest_a = restored.a_matrix(0).unwrap();
for (orig_row, rest_row) in orig_a.iter().zip(rest_a.iter()) {
for (&o, &r) in orig_row.iter().zip(rest_row.iter()) {
assert!((o - r).abs() < 1e-12);
}
}
}
#[cfg(feature = "serde")]
#[test]
fn serde_rejects_malformed_state() {
let json = r#"{
"arm_count": 2,
"feature_count": 2,
"alpha": 1.0,
"a_matrices": [[[1.0, 0.0], [0.0, 1.0]]],
"b_vectors": [[0.0, 0.0]],
"samples_seen": 0
}"#;
assert!(serde_json::from_str::<LinUcb>(json).is_err());
}
}