org.opencypher.okapi.testing.Bag.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of okapi-testing Show documentation

Okapi Test Utilities

There is a newer version: 1.0.0-beta7

/*
 * Copyright (c) 2016-2019 "Neo4j Sweden, AB" [https://neo4j.com]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Attribution Notice under the terms of the Apache License 2.0
 *
 * This work was created by the collective efforts of the openCypher community.
 * Without limiting the terms of Section 6, any Derivative Work that is not
 * approved by the public consensus process of the openCypher Implementers Group
 * should not be described as “Cypher” (and Cypher® is a registered trademark of
 * Neo4j Inc.) or as "openCypher". Extensions by implementers or prototypes or
 * proposals for change that have been documented or implemented should only be
 * described as "implementation extensions to Cypher" or as "proposed changes to
 * Cypher that are not yet approved by the openCypher community".
 */
package org.opencypher.okapi.testing

object Bag {

  // Name for the map representation that we use to check equality of results where the order does not matter.
  // Keys are the elements, the count is the number of times they appear.
  type Bag[T <: Any] = Map[T, Int]

  def apply[E](elements: E*): Bag[E] = {
    elements.groupBy(identity).mapValues(_.size)
  }

  implicit class TraversableToBag[E](val t: Traversable[E]) {
    def toBag: Bag[E] = Bag(t.toSeq: _*)
  }

  implicit class IteratorToBag[E](val i: Iterator[E]) {
    def toBag: Bag[E] = Bag(i.toSeq: _*)
  }

  implicit class ArrayToBag[E](val a: Array[E]) {
    def toBag: Bag[E] = Bag(a: _*)
  }

}