1 // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
12 //! A cache that holds a limited number of key-value pairs. When the
13 //! capacity of the cache is exceeded, the least-recently-used
14 //! (where "used" means a look-up or putting the pair into the cache)
15 //! pair is automatically removed.
20 //! use collections::LruCache;
22 //! let mut cache: LruCache<int, int> = LruCache::new(2);
26 //! assert!(cache.get(&1).is_none());
27 //! assert_eq!(*cache.get(&2).unwrap(), 20);
28 //! assert_eq!(*cache.get(&3).unwrap(), 30);
31 //! assert_eq!(*cache.get(&2).unwrap(), 22);
34 //! assert!(cache.get(&3).is_none());
36 //! cache.change_capacity(1);
37 //! assert!(cache.get(&2).is_none());
40 use std::container::Container;
41 use std::hashmap::HashMap;
42 use std::to_bytes::Cb;
46 struct KeyRef<K> { k: *K }
48 struct LruEntry<K, V> {
51 next: *mut LruEntry<K, V>,
52 prev: *mut LruEntry<K, V>,
56 pub struct LruCache<K, V> {
57 priv map: HashMap<KeyRef<K>, ~LruEntry<K, V>>,
59 priv head: *mut LruEntry<K, V>,
60 priv tail: *mut LruEntry<K, V>,
63 impl<K: IterBytes> IterBytes for KeyRef<K> {
64 fn iter_bytes(&self, lsb0: bool, f: Cb) -> bool {
65 unsafe{ (*self.k).iter_bytes(lsb0, f) }
69 impl<K: Eq> Eq for KeyRef<K> {
70 fn eq(&self, other: &KeyRef<K>) -> bool {
71 unsafe{ (*self.k).eq(&*other.k) }
75 impl<K, V> LruEntry<K, V> {
76 fn new() -> LruEntry<K, V> {
80 next: ptr::mut_null(),
81 prev: ptr::mut_null(),
85 fn with_key_value(k: K, v: V) -> LruEntry<K, V> {
89 next: ptr::mut_null(),
90 prev: ptr::mut_null(),
95 impl<K: IterBytes + Eq, V> LruCache<K, V> {
96 /// Create an LRU Cache that holds at most `capacity` items.
97 pub fn new(capacity: uint) -> LruCache<K, V> {
98 let cache = LruCache {
101 head: unsafe{ cast::transmute(~LruEntry::<K, V>::new()) },
102 tail: unsafe{ cast::transmute(~LruEntry::<K, V>::new()) },
105 (*cache.head).next = cache.tail;
106 (*cache.tail).prev = cache.head;
111 /// Put a key-value pair into cache.
112 pub fn put(&mut self, k: K, v: V) {
113 let mut key_existed = false;
114 let (node_ptr, node_opt) = match self.map.find_mut(&KeyRef{k: &k}) {
117 node.value = Some(v);
118 let node_ptr: *mut LruEntry<K, V> = &mut **node;
122 let mut node = ~LruEntry::with_key_value(k, v);
123 let node_ptr: *mut LruEntry<K, V> = &mut *node;
124 (node_ptr, Some(node))
128 self.detach(node_ptr);
129 self.attach(node_ptr);
131 let keyref = unsafe { (*node_ptr).key.as_ref().unwrap() };
132 self.map.swap(KeyRef{k: keyref}, node_opt.unwrap());
133 self.attach(node_ptr);
134 if self.len() > self.capacity() {
140 /// Return a value corresponding to the key in the cache.
141 pub fn get<'a>(&'a mut self, k: &K) -> Option<&'a V> {
142 let (value, node_ptr_opt) = match self.map.find_mut(&KeyRef{k: k}) {
143 None => (None, None),
145 let node_ptr: *mut LruEntry<K, V> = &mut **node;
147 match (*node_ptr).value {
148 None => (None, None),
149 Some(ref value) => (Some(value), Some(node_ptr))
157 self.detach(node_ptr);
158 self.attach(node_ptr);
164 /// Remove and return a value corresponding to the key from the cache.
165 pub fn pop(&mut self, k: &K) -> Option<V> {
166 match self.map.pop(&KeyRef{k: k}) {
168 Some(lru_entry) => lru_entry.value
172 /// Return the maximum number of key-value pairs the cache can hold.
173 pub fn capacity(&self) -> uint {
177 /// Change the number of key-value pairs the cache can hold. Remove
178 /// least-recently-used key-value pairs if necessary.
179 pub fn change_capacity(&mut self, capacity: uint) {
180 for _ in range(capacity, self.len()) {
183 self.max_size = capacity;
187 fn remove_lru(&mut self) {
189 let lru = unsafe { (*self.tail).prev };
194 Some(ref k) => { self.map.pop(&KeyRef{k: k}); }
201 fn detach(&mut self, node: *mut LruEntry<K, V>) {
203 (*(*node).prev).next = (*node).next;
204 (*(*node).next).prev = (*node).prev;
209 fn attach(&mut self, node: *mut LruEntry<K, V>) {
211 (*node).next = (*self.head).next;
212 (*node).prev = self.head;
213 (*self.head).next = node;
214 (*(*node).next).prev = node;
219 impl<A: ToStr + IterBytes + Eq, B: ToStr> ToStr for LruCache<A, B> {
220 /// Return a string that lists the key-value pairs from most-recently
221 /// used to least-recently used.
223 fn to_str(&self) -> ~str {
225 let mut cur = self.head;
226 for i in range(0, self.len()) {
233 // should never print nil
234 None => acc.push_str("nil"),
235 Some(ref k) => acc.push_str(k.to_str())
241 // should never print nil
242 None => acc.push_str("nil"),
243 Some(ref value) => acc.push_str(value.to_str())
252 impl<K: IterBytes + Eq, V> Container for LruCache<K, V> {
253 /// Return the number of key-value pairs in the cache.
254 fn len(&self) -> uint {
259 impl<K: IterBytes + Eq, V> Mutable for LruCache<K, V> {
260 /// Clear the cache of all key-value pairs.
261 fn clear(&mut self) {
267 impl<K, V> Drop for LruCache<K, V> {
270 let _: ~LruEntry<K, V> = cast::transmute(self.head);
271 let _: ~LruEntry<K, V> = cast::transmute(self.tail);
280 fn assert_opt_eq<V: Eq>(opt: Option<&V>, v: V) {
281 assert!(opt.is_some());
282 assert_eq!(opt.unwrap(), &v);
286 fn test_put_and_get() {
287 let mut cache: LruCache<int, int> = LruCache::new(2);
290 assert_opt_eq(cache.get(&1), 10);
291 assert_opt_eq(cache.get(&2), 20);
292 assert_eq!(cache.len(), 2);
296 fn test_put_update() {
297 let mut cache: LruCache<~str, ~[u8]> = LruCache::new(1);
298 cache.put(~"1", ~[10, 10]);
299 cache.put(~"1", ~[10, 19]);
300 assert_opt_eq(cache.get(&~"1"), ~[10, 19]);
301 assert_eq!(cache.len(), 1);
305 fn test_expire_lru() {
306 let mut cache: LruCache<~str, ~str> = LruCache::new(2);
307 cache.put(~"foo1", ~"bar1");
308 cache.put(~"foo2", ~"bar2");
309 cache.put(~"foo3", ~"bar3");
310 assert!(cache.get(&~"foo1").is_none());
311 cache.put(~"foo2", ~"bar2update");
312 cache.put(~"foo4", ~"bar4");
313 assert!(cache.get(&~"foo3").is_none());
318 let mut cache: LruCache<int, int> = LruCache::new(2);
321 assert_eq!(cache.len(), 2);
322 let opt1 = cache.pop(&1);
323 assert!(opt1.is_some());
324 assert_eq!(opt1.unwrap(), 10);
325 assert!(cache.get(&1).is_none());
326 assert_eq!(cache.len(), 1);
330 fn test_change_capacity() {
331 let mut cache: LruCache<int, int> = LruCache::new(2);
332 assert_eq!(cache.capacity(), 2);
335 cache.change_capacity(1);
336 assert!(cache.get(&1).is_none());
337 assert_eq!(cache.capacity(), 1);
342 let mut cache: LruCache<int, int> = LruCache::new(3);
346 assert_eq!(cache.to_str(), ~"{3: 30, 2: 20, 1: 10}");
348 assert_eq!(cache.to_str(), ~"{2: 22, 3: 30, 1: 10}");
350 assert_eq!(cache.to_str(), ~"{6: 60, 2: 22, 3: 30}");
352 assert_eq!(cache.to_str(), ~"{3: 30, 6: 60, 2: 22}");
353 cache.change_capacity(2);
354 assert_eq!(cache.to_str(), ~"{3: 30, 6: 60}");
359 let mut cache: LruCache<int, int> = LruCache::new(2);
363 assert!(cache.get(&1).is_none());
364 assert!(cache.get(&2).is_none());
365 assert_eq!(cache.to_str(), ~"{}");