eu.simuline.util

Class HashMultiSet<T>

java.lang.Object

eu.simuline.util.AbstractMultiSet<Map<T,MultiSet.Multiplicity>,T>

eu.simuline.util.HashMultiSet<T>

Type Parameters:

T - the class of the elements of this multi-set.

All Implemented Interfaces:

MultiSet<T>, Iterable<T>

public final class HashMultiSet<T>
extends AbstractMultiSet<Map<T,MultiSet.Multiplicity>,T>
implements MultiSet<T>

Represents a set with multiplicities based on a HashMap. Mathematically this is something between a set and a family. Note that this kind of set does support null elements.

Version:

1.0

Author:

Ernst Reissner

Nested Class Summary

Nested classes/interfaces inherited from class eu.simuline.util.AbstractMultiSet

AbstractMultiSet.MultiplicityImpl, AbstractMultiSet.MultiSetIteratorImpl<T>

Nested classes/interfaces inherited from interface eu.simuline.util.MultiSet

MultiSet.Multiplicity

Field Summary

Fields inherited from class eu.simuline.util.AbstractMultiSet

obj2mult

Constructor Summary

Constructors

Modifier	Constructor and Description
	HashMultiSet() Creates a new, empty MultiSet.
private	HashMultiSet(Map<T,MultiSet.Multiplicity> t2mult)
	HashMultiSet(MultiSet<? extends T> other) Copy constructor.
	HashMultiSet(Set<? extends T> sSet) Creates a multi set with the elements of sSet and all elements with multiplicity 1.

Method Summary

Modifier and Type	Method and Description
Map<T,MultiSet.Multiplicity>	getMap() Returns a view of the underlying map of this MultiSet as a map mapping each entry to its multiplicity.
Set<T>	getSet() Returns a view of the underlying set of this MultiSet.
String	toString()

Methods inherited from class eu.simuline.util.AbstractMultiSet

add, addAll, addAll, addWithMult, addWithMult, clear, contains, containsAll, equals, getMaxMult, getMultiplicity, getMultiplicityObj, getObjWithMaxMult, getSetWithMults, hashCode, isEmpty, iterator, remove, removeAll, removeWithMult, removeWithMult, retainAll, setMultiplicity, size, sizeWithMult, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface eu.simuline.util.MultiSet

add, addAll, addAll, addWithMult, addWithMult, clear, contains, containsAll, equals, getMaxMult, getMultiplicity, getMultiplicityObj, getObjWithMaxMult, getSetWithMults, hashCode, isEmpty, iterator, remove, removeAll, removeWithMult, removeWithMult, retainAll, setMultiplicity, size, sizeWithMult, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HashMultiSet

private HashMultiSet(Map<T,MultiSet.Multiplicity> t2mult)

HashMultiSet

public HashMultiSet()

Creates a new, empty MultiSet.

HashMultiSet

public HashMultiSet(MultiSet<? extends T> other)

Copy constructor.

Parameters:

other - another MultiSet instance.

HashMultiSet

public HashMultiSet(Set<? extends T> sSet)

Creates a multi set with the elements of sSet and all elements with multiplicity 1.

Parameters:

sSet - some instance of a sorted set.

Method Detail

getSet

public Set<T> getSet()

Returns a view of the underlying set of this MultiSet. For certain implementations, this set is immutable to prevent implicit modification of this MultiSet.

Specified by:

getSet in interface MultiSet<T>

Returns:

the Set containing exactly the objects with strictly positive multiplicity in this MultiSet.

getMap

public Map<T,MultiSet.Multiplicity> getMap()

Returns a view of the underlying map of this MultiSet as a map mapping each entry to its multiplicity.

Specified by:

getMap in interface MultiSet<T>

toString

public String toString()

Specified by:

toString in interface MultiSet<T>

Overrides:

toString in class Object