Module org.jgrapht.core

Package org.jgrapht.util

Class WeightedUnmodifiableSet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

org.jgrapht.util.WeightedUnmodifiableSet<E>

Type Parameters:

E - element type

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Set<E>

Direct Known Subclasses:

CliqueAlgorithm.CliqueImpl, IndependentSetAlgorithm.IndependentSetImpl, SpannerAlgorithm.SpannerImpl, VertexCoverAlgorithm.VertexCoverImpl

public class WeightedUnmodifiableSet<E>
extends AbstractSet<E>
implements Serializable

Implementation of a weighted, unmodifiable set. This class can for instance be used to store a weighted vertex cover. The hashCode() and equals() methods are identical to those of a normal set, i.e. they are independent of the weight of this class. All methods are delegated to the underlying set.

Author:

Joris Kinable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final Set<E>	backingSet
final double	weight

Constructor Summary

Constructors

Constructor	Description
WeightedUnmodifiableSet(Set<E> backingSet)	Constructs a WeightedUnmodifiableSet instance
WeightedUnmodifiableSet(Set<E> backingSet, double weight)	Constructs a WeightedUnmodifiableSet instance

Method Summary

Modifier and Type	Method	Description
boolean	add(E v)
boolean	addAll(Collection<? extends E> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
double	getWeight()	Returns the weight of the set.
int	hashCode()
boolean	isEmpty()
Iterator<E>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

spliterator

Field Details

backingSet

public final Set<E> backingSet

weight

public final double weight

Constructor Details

WeightedUnmodifiableSet

public WeightedUnmodifiableSet(Set<E> backingSet)

Constructs a WeightedUnmodifiableSet instance

Parameters:

backingSet - underlying set

WeightedUnmodifiableSet

public WeightedUnmodifiableSet(Set<E> backingSet,
 double weight)

Constructs a WeightedUnmodifiableSet instance

Parameters:

backingSet - underlying set

weight - weight of the set

Method Details

getWeight

public double getWeight()

Returns the weight of the set.

Returns:

weight of the set

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

Overrides:

isEmpty in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in class AbstractCollection<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class AbstractCollection<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class AbstractCollection<E>

add

public boolean add(E v)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

Overrides:

add in class AbstractCollection<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

Overrides:

remove in class AbstractCollection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

Overrides:

containsAll in class AbstractCollection<E>

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface Set<E>

Overrides:

addAll in class AbstractCollection<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface Set<E>

Overrides:

retainAll in class AbstractCollection<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface Set<E>

Overrides:

removeAll in class AbstractSet<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

Overrides:

clear in class AbstractCollection<E>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface Set<E>

Overrides:

equals in class AbstractSet<E>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface Set<E>

Overrides:

hashCode in class AbstractSet<E>