Scala algorithm: Maximum wait at a fuel station
Published
Algorithm goal
Given a list of pump capacities, and a list of cars needing certain capacities (both in litres), determine the maximum waiting time for the cars at the gas station.
Test cases in Scala
assert(Pump(1, Some(1)).consume == Pump(0))
assert(Pump(2, Some(2)).consume == Pump(1, Some(1)))
assert(maxWaitingTime(List(1), Vector(0)) == None)
assert(maxWaitingTime(List(1), Vector(1)) == Some(0))
assert(maxWaitingTime(List(1, 1), Vector(1)) == None)
assert(maxWaitingTime(List(1, 1), Vector(2)) == Some(1))
assert(
maxWaitingTime(List(1, 2, 1), Vector(2, 1)) == None,
"The sequence of cars cannot be fulfilled, as there is 1 litre extra needed"
)
assert(maxWaitingTime(List(1, 1, 2), Vector(4)) == Some(2))
assert(maxWaitingTime(List(1, 1, 1, 2), Vector(4)) == None)
assert(
maxWaitingTime(List(2, 8, 4, 3, 2), Vector(7, 11, 3)) == Some(8),
"Key example works"
)
assert(
Station(List(1), Vector(Pump(1))).tryCar
.contains(Station(Nil, Vector(Pump(1, Some(1))))),
"A car can be dequeued to an available pump"
)
assert(
Station(List(1), Vector(Pump(1))).tryCars ==
Station(Nil, Vector(Pump(1, Some(1)))),
"A car can be dequeued to an available pump for tryCars"
)
assert(
Station(List(1), Vector(Pump(1, Some(1)))).tryCar.isEmpty,
"A car cannot be dequeued when a pump is busy"
)
assert(
Station(List(2), Vector(Pump(1, None))).tryCar.isEmpty,
"A car cannot be dequeued when a pump does not have enough"
)
assert(
Station(List(1), Vector(Pump(1, Some(1)), Pump(1, None))).tryCar
.contains(Station(Nil, Vector(Pump(1, Some(1)), Pump(1, Some(1))))),
"A car be dequeued to another available pump"
)
Algorithm in Scala
50 lines of Scala (compatible versions 2.13 & 3.0).
Explanation
We start test-first, by implement some basic expectations for 'maxWaitingTime'. Upon setting these up, we determine that this function is going to depend on the state of a 'Station' and the different 'Pumps' that are there.
'maxWaitingTime' assumes that cars will go to the first available fuel pump (they don't know how much is available, so try the first pump available). (this is © from www.scala-algorithms.com)
This algorithm is not so much a logical algorithm as it is a modeling problem, so it is highly recommended to go through each line of code, and then give it a go in implementing your own code against the unit tests for 'maxWaitingTime'.
Scala concepts & Hints
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!
Pattern Matching
Pattern matching in Scala lets you quickly identify what you are looking for in a data, and also extract it.
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.
Tail Recursion
In Scala, tail recursion enables you to rewrite a mutable structure such as a while-loop, into an immutable algorithm.
View
The
.view
syntax creates a structure that mirrors another structure, until "forced" by an eager operation like .toList, .foreach, .forall, .count.