scala-collection-contrib
API
Generated with
scala-collection-contrib/scala.collection/MultiSet

MultiSet

scala.collection.MultiSet
See theMultiSet companion object
trait MultiSet[A] extends Iterable[A], MultiSetOps[A, MultiSet, MultiSet[A]], Equals

A multiset is a set that can contain multiple occurrences of a same value.

Type parameters

A

the element type of the collection

Attributes

Companion
object
Graph
Supertypes
trait Equals
trait MultiSetOps[A, MultiSet, MultiSet[A]]
trait Iterable[A]
trait IterableFactoryDefaults[A, Iterable]
trait IterableOps[A, MultiSet, MultiSet[A]]
trait IterableOnceOps[A, MultiSet, MultiSet[A]]
trait IterableOnce[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait MultiSet[A]
class MultiSetImpl[A]
class SortedMultiSet[A]
trait MultiSet[A]
class MultiSetImpl[A]
class SortedMultiSet[A]
trait SortedMultiSet[A]
Show all

Members list

Value members

Concrete methods

def canEqual(that: Any): Boolean
override def empty: MultiSet[A]

Attributes

Definition Classes
IterableFactoryDefaults -> IterableOps
override def equals(o: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Equals -> Any
override def hashCode(): Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
override def iterableFactory: IterableFactory[MultiSet]

Attributes

Definition Classes
Iterable -> IterableOps

Inherited methods

final def ++[B >: A](suffix: IterableOnce[B]): MultiSet[B]

Attributes

Inherited from:
IterableOps
final def addString(b: StringBuilder): b.type

Attributes

Inherited from:
IterableOnceOps
final def addString(b: StringBuilder, sep: String): b.type

Attributes

Inherited from:
IterableOnceOps
def addString(b: StringBuilder, start: String, sep: String, end: String): b.type

Attributes

Inherited from:
IterableOnceOps
def collect[B](pf: PartialFunction[A, B]): MultiSet[B]

Attributes

Inherited from:
IterableOps
def collectFirst[B](pf: PartialFunction[A, B]): Option[B]

Attributes

Inherited from:
IterableOnceOps
def collectOccurrences[B](pf: PartialFunction[(A, Int), (B, Int)]): MultiSet[B]

Attributes

Inherited from:
MultiSetOps
def concat(that: IterableOnce[A]): MultiSet[A]

Value parameters

that

the collection of elements to add to this multiset

Attributes

Returns

a new multiset summing the occurrences of this multiset with the elements of that

Inherited from:
MultiSetOps
def concat[B >: A](suffix: IterableOnce[B]): MultiSet[B]

Attributes

Inherited from:
IterableOps
def concatOccurrences(that: Iterable[(A, Int)]): MultiSet[A]

Value parameters

that

the collection of occurrences to add to this multiset

Attributes

Returns

a new multiset summing the occurrences of this multiset and that collection of occurrences

Inherited from:
MultiSetOps
def contains(elem: A): Boolean

Value parameters

elem

the element to test

Attributes

Returns

Whether elem has at least one occurrence in this multiset or not

Inherited from:
MultiSetOps
def copyToArray[B >: A](xs: Array[B], start: Int, len: Int): Int

Attributes

Inherited from:
IterableOnceOps
def copyToArray[B >: A](xs: Array[B], start: Int): Int

Attributes

Inherited from:
IterableOnceOps
def copyToArray[B >: A](xs: Array[B]): Int

Attributes

Inherited from:
IterableOnceOps
def corresponds[B](that: IterableOnce[B])(p: (A, B) => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def count(p: A => Boolean): Int

Attributes

Inherited from:
IterableOnceOps
def drop(n: Int): MultiSet[A]

Attributes

Inherited from:
IterableOps
def dropRight(n: Int): MultiSet[A]

Attributes

Inherited from:
IterableOps
def dropWhile(p: A => Boolean): MultiSet[A]

Attributes

Inherited from:
IterableOps
def exists(p: A => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def filter(pred: A => Boolean): MultiSet[A]

Attributes

Inherited from:
IterableOps
def filterNot(pred: A => Boolean): MultiSet[A]

Attributes

Inherited from:
IterableOps
def filterOccurrences(p: ((A, Int)) => Boolean): MultiSet[A]

Attributes

Returns

a new multiset containing only the occurrences of elements of this multiset that satisfy the given predicate p

Inherited from:
MultiSetOps
def find(p: A => Boolean): Option[A]

Attributes

Inherited from:
IterableOnceOps
def flatMap[B](f: A => IterableOnce[B]): MultiSet[B]

Attributes

Inherited from:
IterableOps
def flatMapOccurrences[B](f: ((A, Int)) => IterableOnce[(B, Int)]): MultiSet[B]

Type parameters

B

the element type of the returned collection

Value parameters

f

the function to apply

Attributes

Returns

a new multiset resulting from applying the given function f to each pair of element and its number of occurrences of this multiset and concatenating the results

Inherited from:
MultiSetOps
def flatten[B](implicit asIterable: A => IterableOnce[B]): MultiSet[B]

Attributes

Inherited from:
IterableOps
def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1

Attributes

Inherited from:
IterableOnceOps
def foldLeft[B](z: B)(op: (B, A) => B): B

Attributes

Inherited from:
IterableOnceOps
def foldRight[B](z: B)(op: (A, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def forall(p: A => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def foreach[U](f: A => U): Unit

Attributes

Inherited from:
IterableOnceOps
protected def fromOccurrences[E](it: Iterable[(E, Int)]): MultiSet[E]

Attributes

Inherited from:
MultiSetOps
protected def fromSpecificOccurrences(it: Iterable[(A, Int)]): MultiSet[A]

Attributes

Inherited from:
MultiSetOps
def get(elem: A): Int

Value parameters

elem

Element to look up

Attributes

Returns

The number of occurrences of elem in this multiset

Inherited from:
MultiSetOps
def groupBy[K](f: A => K): Map[K, MultiSet[A]]

Attributes

Inherited from:
IterableOps
def groupMap[K, B](key: A => K)(f: A => B): Map[K, MultiSet[B]]

Attributes

Inherited from:
IterableOps
def groupMapReduce[K, B](key: A => K)(f: A => B)(reduce: (B, B) => B): Map[K, B]

Attributes

Inherited from:
IterableOps
def grouped(size: Int): Iterator[MultiSet[A]]

Attributes

Inherited from:
IterableOps
def head: A

Attributes

Inherited from:
IterableOps
def headOption: Option[A]

Attributes

Inherited from:
IterableOps
def init: MultiSet[A]

Attributes

Inherited from:
IterableOps
def inits: Iterator[MultiSet[A]]

Attributes

Inherited from:
IterableOps
def isEmpty: Boolean

Attributes

Inherited from:
IterableOnceOps
override def isTraversableAgain: Boolean

Attributes

Definition Classes
IterableOps -> IterableOnceOps
Inherited from:
IterableOps
def iterator: Iterator[A]

Attributes

Inherited from:
MultiSetOps
def knownSize: Int

Attributes

Inherited from:
IterableOnce
def last: A

Attributes

Inherited from:
IterableOps
def lastOption: Option[A]

Attributes

Inherited from:
IterableOps
def lazyZip[B](that: Iterable[B]): LazyZip2[A, B, Iterable.this.type]

Attributes

Inherited from:
Iterable
def map[B](f: A => B): MultiSet[B]

Attributes

Inherited from:
IterableOps
def mapOccurrences[B](f: ((A, Int)) => (B, Int)): MultiSet[B]

Type parameters

B

the element type of the returned collection

Value parameters

f

the function to apply

Attributes

Returns

a new multiset resulting from applying the given function f to each pair of element and its number of occurrences of this multiset and collecting the results

Inherited from:
MultiSetOps
def max[B >: A](implicit ord: Ordering[B]): A

Attributes

Inherited from:
IterableOnceOps
def maxBy[B](f: A => B)(implicit ord: Ordering[B]): A

Attributes

Inherited from:
IterableOnceOps
def maxByOption[B](f: A => B)(implicit ord: Ordering[B]): Option[A]

Attributes

Inherited from:
IterableOnceOps
def maxOption[B >: A](implicit ord: Ordering[B]): Option[A]

Attributes

Inherited from:
IterableOnceOps
def min[B >: A](implicit ord: Ordering[B]): A

Attributes

Inherited from:
IterableOnceOps
def minBy[B](f: A => B)(implicit ord: Ordering[B]): A

Attributes

Inherited from:
IterableOnceOps
def minByOption[B](f: A => B)(implicit ord: Ordering[B]): Option[A]

Attributes

Inherited from:
IterableOnceOps
def minOption[B >: A](implicit ord: Ordering[B]): Option[A]

Attributes

Inherited from:
IterableOnceOps
final def mkString: String

Attributes

Inherited from:
IterableOnceOps
final def mkString(sep: String): String

Attributes

Inherited from:
IterableOnceOps
final def mkString(start: String, sep: String, end: String): String

Attributes

Inherited from:
IterableOnceOps
def nonEmpty: Boolean

Attributes

Inherited from:
IterableOnceOps
def partition(p: A => Boolean): (MultiSet[A], MultiSet[A])

Attributes

Inherited from:
IterableOps
def partitionMap[A1, A2](f: A => Either[A1, A2]): (MultiSet[A1], MultiSet[A2])

Attributes

Inherited from:
IterableOps
def product[B >: A](implicit num: Numeric[B]): B

Attributes

Inherited from:
IterableOnceOps
def reduce[B >: A](op: (B, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceLeft[B >: A](op: (B, A) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceLeftOption[B >: A](op: (B, A) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
def reduceOption[B >: A](op: (B, B) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
def reduceRight[B >: A](op: (A, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceRightOption[B >: A](op: (A, B) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
protected def reversed: Iterable[A]

Attributes

Inherited from:
IterableOnceOps
def scan[B >: A](z: B)(op: (B, B) => B): MultiSet[B]

Attributes

Inherited from:
IterableOps
def scanLeft[B](z: B)(op: (B, A) => B): MultiSet[B]

Attributes

Inherited from:
IterableOps
def scanRight[B](z: B)(op: (A, B) => B): MultiSet[B]

Attributes

Inherited from:
IterableOps
def size: Int

Attributes

Inherited from:
IterableOnceOps
def sizeCompare(that: Iterable[_]): Int

Attributes

Inherited from:
IterableOps
def sizeCompare(otherSize: Int): Int

Attributes

Inherited from:
IterableOps
final def sizeIs: SizeCompareOps

Attributes

Inherited from:
IterableOps
def slice(from: Int, until: Int): MultiSet[A]

Attributes

Inherited from:
IterableOps
def sliding(size: Int, step: Int): Iterator[MultiSet[A]]

Attributes

Inherited from:
IterableOps
def sliding(size: Int): Iterator[MultiSet[A]]

Attributes

Inherited from:
IterableOps
def span(p: A => Boolean): (MultiSet[A], MultiSet[A])

Attributes

Inherited from:
IterableOps
override def splitAt(n: Int): (MultiSet[A], MultiSet[A])

Attributes

Definition Classes
IterableOps -> IterableOnceOps
Inherited from:
IterableOps
def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

Attributes

Inherited from:
IterableOnce
def sum[B >: A](implicit num: Numeric[B]): B

Attributes

Inherited from:
IterableOnceOps
def tail: MultiSet[A]

Attributes

Inherited from:
IterableOps
def tails: Iterator[MultiSet[A]]

Attributes

Inherited from:
IterableOps
def take(n: Int): MultiSet[A]

Attributes

Inherited from:
IterableOps
def takeRight(n: Int): MultiSet[A]

Attributes

Inherited from:
IterableOps
def takeWhile(p: A => Boolean): MultiSet[A]

Attributes

Inherited from:
IterableOps
override def tapEach[U](f: A => U): MultiSet[A]

Attributes

Definition Classes
IterableOps -> IterableOnceOps
Inherited from:
IterableOps
def to[C1](factory: Factory[A, C1]): C1

Attributes

Inherited from:
IterableOnceOps
def toArray[B >: A : ClassTag]: Array[B]

Attributes

Inherited from:
IterableOnceOps
final def toBuffer[B >: A]: Buffer[B]

Attributes

Inherited from:
IterableOnceOps
def toIndexedSeq: IndexedSeq[A]

Attributes

Inherited from:
IterableOnceOps
def toList: List[A]

Attributes

Inherited from:
IterableOnceOps
def toMap[K, V](implicit ev: A <:< (K, V)): Map[K, V]

Attributes

Inherited from:
IterableOnceOps
def toSeq: Seq[A]

Attributes

Inherited from:
IterableOnceOps
def toSet[B >: A]: Set[B]

Attributes

Inherited from:
IterableOnceOps
override def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Iterable -> Any
Inherited from:
Iterable
def toVector: Vector[A]

Attributes

Inherited from:
IterableOnceOps
def transpose[B](implicit asIterable: A => Iterable[B]): MultiSet[MultiSet[B]]

Attributes

Inherited from:
IterableOps
def unzip[A1, A2](implicit asPair: A => (A1, A2)): (MultiSet[A1], MultiSet[A2])

Attributes

Inherited from:
IterableOps
def unzip3[A1, A2, A3](implicit asTriple: A => (A1, A2, A3)): (MultiSet[A1], MultiSet[A2], MultiSet[A3])

Attributes

Inherited from:
IterableOps
def view: View[A]

Attributes

Inherited from:
IterableOps
def withFilter(p: A => Boolean): WithFilter[A, MultiSet]

Attributes

Inherited from:
IterableOps
def zip[B](that: IterableOnce[B]): MultiSet[(A, B)]

Attributes

Inherited from:
IterableOps
def zipAll[A1 >: A, B](that: Iterable[B], thisElem: A1, thatElem: B): MultiSet[(A1, B)]

Attributes

Inherited from:
IterableOps
def zipWithIndex: MultiSet[(A, Int)]

Attributes

Inherited from:
IterableOps

Inherited and Abstract methods

def occurrences: Map[A, Int]

Attributes

Returns

All the elements contained in this multiset and their number of occurrences

Inherited from:
MultiSetOps

Deprecated and Inherited methods

def ++:[B >: A](that: IterableOnce[B]): MultiSet[B]

Attributes

Deprecated
[Since version 2.13.0] Use ++ instead of ++: for collections of type Iterable
Inherited from:
IterableOps
final def /:[B](z: B)(op: (B, A) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldLeft instead of /:
Inherited from:
IterableOnceOps
final def :\[B](z: B)(op: (A, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldRight instead of :\\
Inherited from:
IterableOnceOps
def aggregate[B](z: => B)(seqop: (B, A) => B, combop: (B, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] For sequential collections, prefer `foldLeft(z)(seqop)`. For parallel collections, use `ParIterableLike#aggregate`.
Inherited from:
IterableOnceOps
def companion: IterableFactory[MultiSet]

Attributes

Deprecated
[Since version 2.13.0] Use iterableFactory instead
Inherited from:
IterableOps
final def copyToBuffer[B >: A](dest: Buffer[B]): Unit

Attributes

Deprecated
[Since version 2.13.0] Use `dest ++= coll` instead
Inherited from:
IterableOnceOps
def hasDefiniteSize: Boolean

Attributes

Deprecated
[Since version 2.13.0] Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)
Inherited from:
IterableOnceOps
final def repr: MultiSet[A]

Attributes

Deprecated
[Since version 2.13.0] Use coll instead of repr in a collection implementation, use the collection value itself from the outside
Inherited from:
IterableOps
def seq: Iterable.this.type

Attributes

Deprecated
[Since version 2.13.0] Iterable.seq always returns the iterable itself
Inherited from:
Iterable
final def toIterable: Iterable.this.type

Attributes

Deprecated
[Since version 2.13.7] toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
Iterable
final def toIterator: Iterator[A]

Attributes

Deprecated
[Since version 2.13.0] Use .iterator instead of .toIterator
Inherited from:
IterableOnceOps
final def toStream: Stream[A]

Attributes

Deprecated
[Since version 2.13.0] Use .to(LazyList) instead of .toStream
Inherited from:
IterableOnceOps
final def toTraversable: Iterable[A]

Attributes

Deprecated
[Since version 2.13.0] toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
IterableOps
def view(from: Int, until: Int): View[A]

Attributes

Deprecated
[Since version 2.13.0] Use .view.slice(from, until) instead of .view(from, until)
Inherited from:
IterableOps
Generated with