nypc-perf 0.1.2

Performance calculation of NYPC
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

# nypc-perf

[![Crates.io](https://img.shields.io/crates/v/nypc-perf.svg)](https://crates.io/crates/nypc-perf)
[![Documentation](https://docs.rs/nypc-perf/badge.svg)](https://docs.rs/nypc-perf)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A Rust library for calculating player performance based on battle results using the Bradley-Terry model.

## Overview

This library implements a Bradley-Terry model based performance system that estimates player performance levels from head-to-head battle outcomes. The algorithm uses Newton-Raphson iteration to find maximum likelihood estimates of player performances that best explain the observed win/loss patterns.

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
nypc-perf = "0.1.2"
```

## Usage

### Basic Example

```rust
use nypc_perf::{BattleResult, PerfCalc, Rating};

// Create battle results between players
let battles = vec![
    BattleResult {
        i: 0,           // Player 0
        j: 1,           // Player 1
        wij: 2.0,       // Player 0 won twice against Player 1
        wji: 1.0,       // Player 1 won once against Player 0
    },
    BattleResult {
        i: 0,
        j: 2,
        wij: 1.0,
        wji: 0.0,
    }
];

// Initialize performance ratings to 0
let mut perf = vec![
    Rating::new(0.0),       // Variable rating
    Rating::new(0.0),       // Variable rating  
    Rating::new_fixed(0.0)  // Fixed anchor rating
];

// Run the rating calculation
let result = PerfCalc::new()
    .max_iters(100)     // Maximum iterations (default: 100)
    .epsilon(1e-6)      // Convergence threshold (default: 1e-6)
    .run(&mut perf, &battles);

// Check if calculation converged
match result {
    Ok(iters) => println!("Converged after {} iterations", iters),
    Err(err) => println!("Did not converge, final error: {}", err)
}

// perf now contains the estimated log-performance ratings
// Higher values indicate better performance
for (i, rating) in perf.iter().enumerate() {
    println!("Player {}: {:.6}", i, rating.value);
}
```

## Authors

**NEXON Algorithm Research Team** - [_algorithm@nexon.co.kr](mailto:_algorithm@nexon.co.kr)

## Documentation

For detailed API documentation, visit [docs.rs/nypc-perf](https://docs.rs/nypc-perf).