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:
java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>
Direct Known Subclasses:
CliqueAlgorithm.CliqueImpl, IndependentSetAlgorithm.IndependentSetImpl, SpannerAlgorithm.SpannerImpl, VertexCoverAlgorithm.VertexCoverImpl
public class WeightedUnmodifiableSet<E>
extends java.util.AbstractSet<E>
implements java.io.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
    java.util.Set<E> backingSet  
    double weight  

  • Constructor Summary

    Constructors 
    Constructor Description
    WeightedUnmodifiableSet​(java.util.Set<E> backingSet)
    Constructs a WeightedUnmodifiableSet instance
    WeightedUnmodifiableSet​(java.util.Set<E> backingSet, double weight)
    Constructs a WeightedUnmodifiableSet instance

  • Method Summary

    Modifier and Type Method Description
    boolean add​(E v)  
    boolean addAll​(java.util.Collection<? extends E> c)  
    void clear()  
    boolean contains​(java.lang.Object o)  
    boolean containsAll​(java.util.Collection<?> c)  
    boolean equals​(java.lang.Object o)  
    double getWeight()
    Returns the weight of the set.
    int hashCode()  
    boolean isEmpty()  
    java.util.Iterator<E> iterator()  
    boolean remove​(java.lang.Object o)  
    boolean removeAll​(java.util.Collection<?> c)  
    boolean retainAll​(java.util.Collection<?> c)  
    int size()  
    java.lang.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 java.util.Set<E> backingSet

    • weight

      public final double weight

  • Constructor Details

    • WeightedUnmodifiableSet

      public WeightedUnmodifiableSet​(java.util.Set<E> backingSet)
      Constructs a WeightedUnmodifiableSet instance
      Parameters:
      backingSet - underlying set

    • WeightedUnmodifiableSet

      public WeightedUnmodifiableSet​(java.util.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 java.util.Collection<E>
      Specified by:
      size in interface java.util.Set<E>
      Specified by:
      size in class java.util.AbstractCollection<E>

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface java.util.Collection<E>
      Specified by:
      isEmpty in interface java.util.Set<E>
      Overrides:
      isEmpty in class java.util.AbstractCollection<E>

    • contains

      public boolean contains​(java.lang.Object o)
      Specified by:
      contains in interface java.util.Collection<E>
      Specified by:
      contains in interface java.util.Set<E>
      Overrides:
      contains in class java.util.AbstractCollection<E>

    • iterator

      public java.util.Iterator<E> iterator()
      Specified by:
      iterator in interface java.util.Collection<E>
      Specified by:
      iterator in interface java.lang.Iterable<E>
      Specified by:
      iterator in interface java.util.Set<E>
      Specified by:
      iterator in class java.util.AbstractCollection<E>

    • toArray

      public java.lang.Object[] toArray()
      Specified by:
      toArray in interface java.util.Collection<E>
      Specified by:
      toArray in interface java.util.Set<E>
      Overrides:
      toArray in class java.util.AbstractCollection<E>

    • toArray

      public <T> T[] toArray​(T[] a)
      Specified by:
      toArray in interface java.util.Collection<E>
      Specified by:
      toArray in interface java.util.Set<E>
      Overrides:
      toArray in class java.util.AbstractCollection<E>

    • add

      public boolean add​(E v)
      Specified by:
      add in interface java.util.Collection<E>
      Specified by:
      add in interface java.util.Set<E>
      Overrides:
      add in class java.util.AbstractCollection<E>

    • remove

      public boolean remove​(java.lang.Object o)
      Specified by:
      remove in interface java.util.Collection<E>
      Specified by:
      remove in interface java.util.Set<E>
      Overrides:
      remove in class java.util.AbstractCollection<E>

    • containsAll

      public boolean containsAll​(java.util.Collection<?> c)
      Specified by:
      containsAll in interface java.util.Collection<E>
      Specified by:
      containsAll in interface java.util.Set<E>
      Overrides:
      containsAll in class java.util.AbstractCollection<E>

    • addAll

      public boolean addAll​(java.util.Collection<? extends E> c)
      Specified by:
      addAll in interface java.util.Collection<E>
      Specified by:
      addAll in interface java.util.Set<E>
      Overrides:
      addAll in class java.util.AbstractCollection<E>

    • retainAll

      public boolean retainAll​(java.util.Collection<?> c)
      Specified by:
      retainAll in interface java.util.Collection<E>
      Specified by:
      retainAll in interface java.util.Set<E>
      Overrides:
      retainAll in class java.util.AbstractCollection<E>

    • removeAll

      public boolean removeAll​(java.util.Collection<?> c)
      Specified by:
      removeAll in interface java.util.Collection<E>
      Specified by:
      removeAll in interface java.util.Set<E>
      Overrides:
      removeAll in class java.util.AbstractSet<E>

    • clear

      public void clear()
      Specified by:
      clear in interface java.util.Collection<E>
      Specified by:
      clear in interface java.util.Set<E>
      Overrides:
      clear in class java.util.AbstractCollection<E>

    • equals

      public boolean equals​(java.lang.Object o)
      Specified by:
      equals in interface java.util.Collection<E>
      Specified by:
      equals in interface java.util.Set<E>
      Overrides:
      equals in class java.util.AbstractSet<E>

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface java.util.Collection<E>
      Specified by:
      hashCode in interface java.util.Set<E>
      Overrides:
      hashCode in class java.util.AbstractSet<E>