circlejerk 0.1.1

A tiny in-memory opinion tracker for measuring group consensus
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

# circlejerk

A tiny in-memory opinion tracker for measuring group consensus.

`circlejerk` counts repeated opinions and reports whether a group agrees, how
strong the dominant opinion is, and which opinion has the most support.

## Usage

Add the crate to your project:

```toml
[dependencies]
circlejerk = "0.1.1"
```

Record opinions and inspect the result:

```rust
use circlejerk::CircleJerk;

let mut group = CircleJerk::new();
group.agree("Rust is great");
group.agree("Rust is great");
group.agree("Other languages are fine too");

assert_eq!(group.participants(), 3);
assert_eq!(group.dominant_opinion(), Some("Rust is great"));
assert_eq!(group.consensus_ratio(), 2.0 / 3.0);
assert!(!group.consensus());
```

Each call to `agree` counts as one participant. The crate does not track
participant identities. If several opinions tie for the most support,
`dominant_opinion` may return any one of them.

## License

Licensed under the MIT License. See [LICENSE](LICENSE) for details.