SimpleCounter iterators are in insertion order

fulcrumgenomics · Nov 1, 2021 · b862308 · b862308
1 parent b851fd3
commit b862308
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/main/scala/com/fulcrumgenomics/commons/util/SimpleCounter.scala b/src/main/scala/com/fulcrumgenomics/commons/util/SimpleCounter.scala
@@ -38,11 +38,12 @@ object SimpleCounter {
 
 /**
   * Super-simple class for counting occurrences of any kind of object. Will return
-  * zero for any item that has not been counted yet.
+  * zero for any item that has not been counted yet.  The iterator and all traversal
+  * methods of this class visit elements in the order they were inserted.
   */
 class SimpleCounter[T]extends Iterable[(T, Long)] {
-  /** Creates the map in which we store the counts. */
-  protected def makeMap(): mutable.Map[T, Long] = new mutable.HashMap()
+  /** Creates the map in which we store the counts, with iteration in insertion order. */
+  protected def makeMap(): mutable.Map[T, Long] = new mutable.LinkedHashMap()
 
   private val counts: mutable.Map[T, Long] = makeMap().withDefaultValue(0L)