Struct abstutil::collections::Counter

pub struct Counter<T: Ord + PartialEq + Clone> {
    map: BTreeMap<T, usize>,
    sum: usize,
}

A counter per key

Fields

map: BTreeMap<T, usize>

sum: usize

Implementations

impl<T: Ord + PartialEq + Clone> Counter<T>

pub fn new() -> Counter<T>

pub fn add(&mut self, val: T, amount: usize) -> usize

pub fn inc(&mut self, val: T) -> usize

pub fn get(&self, val: T) -> usize

If the key is missing, returns 0

pub fn sorted_asc(&self) -> Vec<Vec<T>>

Values with the same count are grouped together

pub fn highest_n(&self, n: usize) -> Vec<(T, usize)>

pub fn max_key(&self) -> T

If two keys share the maximum, returns one of them arbitrarily (and deterministically)

pub fn max(&self) -> usize

pub fn sum(&self) -> usize

pub fn compare(self, other: Counter<T>) -> Vec<(T, usize, usize)>

pub fn borrow(&self) -> &BTreeMap<T, usize>

pub fn consume(self) -> BTreeMap<T, usize>

pub fn is_empty(&self) -> bool

pub fn extend(&mut self, other: Counter<T>)

pub fn subset(&mut self, keys: &BTreeSet<T>)

Remove all entries that aren’t in the specified set of keys

Trait Implementations

impl<T: Clone + Ord + PartialEq + Clone> Clone for Counter<T>

fn clone(&self) -> Counter<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Ord + PartialEq + Clone> Default for Counter<T>

fn default() -> Counter<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Counter<T>

where T: Deserialize<'de> + Ord + PartialEq + Clone,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq + Ord + PartialEq + Clone> PartialEq for Counter<T>

fn eq(&self, other: &Counter<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for Counter<T>

where T: Serialize + Ord + PartialEq + Clone,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Ord + PartialEq + Clone> StructuralPartialEq for Counter<T>