localsearch 0.24.0

A Library of Local Search based Metaheuristics
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

//! Utilities

use std::collections::VecDeque;

/// RingBuffer to be used to implement a Tabu List
#[derive(Debug, Clone)]
pub struct RingBuffer<T> {
    capacity: usize,
    buff: VecDeque<T>,
}

impl<T> RingBuffer<T> {
    /// Constructor of RingBuffer
    pub fn new(capacity: usize) -> Self {
        let buff = VecDeque::with_capacity(capacity);
        Self { capacity, buff }
    }

    /// Append a new item to the buffer
    pub fn append(&mut self, item: T) {
        if self.buff.len() == self.capacity {
            self.buff.pop_front();
        }
        self.buff.push_back(item);
    }

    /// Convert to an iterator
    pub fn iter(&self) -> impl Iterator<Item = &T> {
        self.buff.iter()
    }
}