Scala algorithm: Least-recently used cache (MRU)

Published

Algorithm goal

A most-recently used cache (MRU) stores a set of key-value pairs in order of their most recent access but evicts the most-recently used one when space is needed. 'MRU' refers to the eviction policy in this case.

Implement an immutable MRU cache which returns the most recently touched key (candidate for eviction), get a value (and 'touches' it), and puts values ('touching' and possibly causing an eviction).

Test cases in Scala

assert(
  MRU.init(1)("X" -> 1).get("X").map(_._1).contains(1),
  "First put element in the cache remains there"
)
assert(
  MRU.init(1)("X" -> 1).maybeNewest.contains("X"),
  "First put element in the cache remains is the head"
)
assert(
  MRU.init(1)("X" -> 1).put("Y", 1).get("X").isEmpty,
  "Cache becomes full, so X is no longer there after putting Y"
)
assert(
  MRU
    .init(2)("X" -> 1, "Y" -> 2)
    .get("Y")
    .map(_._2.put("Z", 3))
    .flatMap(_.get("X"))
    .isEmpty,
  "For a cache of size 1, the least recently used element X gets evicted"
)
assert(
  MRU
    .init(2)("X" -> 1, "Y" -> 2)
    .get("Y")
    .map(_._2.put("Z", 3))
    .flatMap(_.get("Y"))
    .map(_._1)
    .contains(2),
  "For a cache of size 2, the most recently used element Y is not evicted"
)
assert(
  MRU
    .init(2)("X" -> 1, "Y" -> 2)
    .get("Y")
    .map(_._2.put("Z", 3))
    .flatMap(_.get("Y"))
    .flatMap(_._2.maybeNewest)
    .contains("Z"),
  "For a cache of size 2, the oldest element is Z, since X was evicted and the last access was Y"
)

Algorithm in Scala

59 lines of Scala (compatible versions 2.13 & 3.0).

Get the full algorithm Scala algorithms logo, maze part, which looks quirky!

or

'Unlimited Scala Algorithms' gives you access to all the 81 published & 11 upcoming Scala Algorithms (92 total)! Plenty to master your Scala algos skills!

Upon purchase, you will be able to Register an account to access all the algorithms on multiple devices.

Stripe logo

Explanation

MRU caches are typically mutable, implemented using mutable linked lists, however the approach similar to that in MakeQueueUsingMap can be used in order to create a linked list using immutable structures. While it is not typical to use an MRU that is immutable, this is extremely useful in immutable state machines, which otherwise would be more difficult and less performant to implement without immutable underlying structures.

In this approach, we create an explicit EmptyMRU class to make the implementation simpler (otherwise we would have to deal with `oldestKey` that is Optional - complicating computations. This class allows for a simple creation of a non-empty MRU. (this is © from www.scala-algorithms.com)

A Map is used to represent a linked list: we define the start and the end with 'newestKey' and 'oldestKey', and then the chain via 'newer' and 'older' Maps. Note that immutable maps in Scala are highly optimized for immutability.

Scala concepts & Hints

  1. foldLeft and foldRight

    A 'fold' allows you to perform the equivalent of a for-loop, but with a lot less code.

    def foldMutable[I, O](initialState: O)(items: List[I])(f: (O, I) => O): O =
      items.foldLeft(initialState)(f)
    
  2. Option Type

    The 'Option' type is used to describe a computation that either has a result or does not. In Scala, you can 'chain' Option processing, combine with lists and other data structures. For example, you can also turn a pattern-match into a function that return an Option, and vice-versa!

    assert(Option(1).flatMap(x => Option(x + 2)) == Option(3))
    
    assert(Option(1).flatMap(x => None) == None)
    
  3. Pattern Matching

    Pattern matching in Scala lets you quickly identify what you are looking for in a data, and also extract it.

    assert("Hello World".collect {
      case character if Character.isUpperCase(character) => character.toLower
    } == "hw")
    
  4. Stack Safety

    Stack safety is present where a function cannot crash due to overflowing the limit of number of recursive calls.

    This function will work for n = 5, but will not work for n = 2000 (crash with java.lang.StackOverflowError) - however there is a way to fix it :-)

    In Scala Algorithms, we try to write the algorithms in a stack-safe way, where possible, so that when you use the algorithms, they will not crash on large inputs. However, stack-safe implementations are often more complex, and in some cases, overly complex, for the task at hand.

    def sum(from: Int, until: Int): Int =
      if (from == until) until else from + sum(from + 1, until)
    
    def thisWillSucceed: Int = sum(1, 5)
    
    def thisWillFail: Int = sum(1, 300)
    

Scala Algorithms: The most comprehensive library of algorithms in standard pure-functional Scala

Study our 92 Scala Algorithms: 6 fully free, 81 published & 11 upcoming

Fully unit-tested, with explanations and relevant concepts; new algorithms published about once a week.

  1. Compute the length of longest valid parentheses
  2. Check a binary tree is balanced
  3. Make a queue using stacks (Lists in Scala)
  4. Find height of binary tree
  5. Single-elimination tournament tree
  6. Reverse Polish Notation calculator
  7. Quick Sort sorting algorithm in pure immutable Scala
  8. Find minimum missing positive number in a sequence
  9. Least-recently used cache (LRU)
  10. Count pairs of a given expected sum
  11. Compute a Roman numeral for an Integer, and vice-versa
  12. Compute keypad possibilities
  13. Matching parentheses algorithm with foldLeft and a state machine
  14. Traverse a tree Breadth-First, immutably
  15. Read a matrix as a spiral
  16. Remove duplicates from a sorted list (state machine)
  17. Merge Sort: stack-safe, tail-recursive, in pure immutable Scala, N-way
  18. Longest increasing sub-sequence length
  19. Reverse first n elements of a queue
  20. Binary search a generic Array
  21. Game of Life
  22. Merge Sort: in pure immutable Scala
  23. Make a queue using Maps
  24. Is an Array a permutation?
  25. Count number of contiguous countries by colors
  26. Add numbers without using addition (plus sign)
  27. Tic Tac Toe MinMax solve
  28. Run-length encoding (RLE) Encoder
  29. Print Alphabet Diamond
  30. Balanced parentheses algorithm with tail-call recursion optimisation
  31. Reverse a String's words efficiently
  32. Count number of changes (manipulations) needed to make an anagram with foldLeft and a MultiSet
  33. Count passing cars
  34. Establish execution order from dependencies
  35. Counting inversions of a sequence (array) using a Merge Sort
  36. Longest common prefix of strings
  37. Check if an array is a palindrome
  38. Check a directed graph has a routing between two nodes (depth-first search)
  39. Compute nth row of Pascal's triangle
  40. Run-length encoding (RLE) Decoder
  41. Check if a number is a palindrome
  42. In a range of numbers, count the numbers divisible by a specific integer
  43. Find the index of a substring ('indexOf')
  44. Reshape a matrix
  45. Compute modulo of an exponent without exponentiation
  46. Closest pair of coordinates in a 2D plane
  47. Find the contiguous slice with the minimum average
  48. Compute maximum sum of subarray (Kadane's algorithm)
  49. Pure-functional double linked list
  50. Binary search in a rotated sorted array
  51. Check if a directed graph has cycles
  52. Rotate Array right in pure-functional Scala - using an unusual immutable efficient approach
  53. Check a binary tree is a search tree
  54. Length of the longest common substring
  55. Sliding Window Rate Limiter
  56. Tic Tac Toe board check
  57. Find an unpaired number in an array
  58. Check if a String is a palindrome
  59. Count binary gap size of a number using tail recursion
  60. Remove duplicates from a sorted list (Sliding)
  61. Monitor success rate of a process that may fail
  62. Least-recently used cache (MRU)
  63. Find sub-array with the maximum sum
  64. Find the minimum absolute difference of two partitions
  65. Find maximum potential profit from an array of stock price
  66. Fibonacci in purely functional immutable Scala
  67. Fizz Buzz in purely functional immutable Scala
  68. Find triplets that sum to a target ('3Sum')
  69. Find combinations adding up to N (non-unique)
  70. Make a binary search tree (Red-Black tree)
  71. Remove duplicates from an unsorted List
  72. Mars Rover
  73. Find combinations adding up to N (unique)
  74. Find indices of tuples that sum to a target (Two Sum)
  75. Count factors/divisors of an integer
  76. Compute single-digit sum of digits
  77. Traverse a tree Depth-First
  78. Reverse bits of an integer
  79. Find k closest elements to a value in a sorted Array
  80. QuickSelect Selection Algorithm (kth smallest item/order statistic)
  81. Rotate a matrix by 90 degrees clockwise

Explore the 21 most useful Scala concepts

To save you going through various tutorials, we cherry-picked the most useful Scala concepts in a consistent form.

  1. Class Inside Class
  2. Class Inside Def
  3. Collect
  4. Def Inside Def
  5. Drop, Take, dropRight, takeRight
  6. foldLeft and foldRight
  7. For-comprehension
  8. Lazy List
  9. Option Type
  10. Ordering
  11. Partial Function
  12. Pattern Matching
  13. Range
  14. scanLeft and scanRight
  15. Sliding / Sliding Window
  16. Stack Safety
  17. State machine
  18. Tail Recursion
  19. Type Class
  20. View
  21. Zip

Register now (free)

 Register with GitHub    

How the algorithms look

  1. A description/goal of the algorithm.
  2. An explanation with both Scala and logical parts.
  3. A proof or a derivation, where appropriate.
  4. Links to Scala concepts used in this specific algorithm, also unit-tested.
  5. An implementation in pure-functional immutable Scala, with efficiency in mind (for most algorithms, this is for paid subscribers only).
  6. Unit tests, with a button to run them immediately in our in-browser IDE.
Screenshot of an example algorithm demonstrating the listed features