it.unimi.dsi.fastutil.chars
Class CharArraySet

java.lang.Object
  extended by java.util.AbstractCollection<java.lang.Character>
      extended by it.unimi.dsi.fastutil.chars.AbstractCharCollection
          extended by it.unimi.dsi.fastutil.chars.AbstractCharSet
              extended by it.unimi.dsi.fastutil.chars.CharArraySet
All Implemented Interfaces:
CharCollection, CharIterable, CharSet, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.Set<java.lang.Character>

public class CharArraySet
extends AbstractCharSet
implements java.io.Serializable, java.lang.Cloneable

A simple, brute-force implementation of a set based on a backing array.

The main purpose of this implementation is that of wrapping cleanly the brute-force approach to the storage of a very small number of items: just put them into an array and scan linearly to find an item.

See Also:
Serialized Form

Constructor Summary
CharArraySet()
          Creates a new empty array set.
CharArraySet(char[] a)
          Creates a new array set using the given backing array.
CharArraySet(char[] a, int size)
          Creates a new array set using the given backing array and the given number of elements of the array.
CharArraySet(CharCollection c)
          Creates a new array set copying the contents of a given collection.
CharArraySet(java.util.Collection<? extends java.lang.Character> c)
          Creates a new array set copying the contents of a given set.
CharArraySet(int capacity)
          Creates a new empty array set of given initial capacity.
 
Method Summary
 boolean add(char k)
           
 void clear()
           
 CharArraySet clone()
          Returns a deep copy of this set.
 boolean contains(char k)
           
 boolean isEmpty()
           
 CharIterator iterator()
          Returns a type-specific iterator on the elements of this collection.
 boolean remove(char k)
          Removes an element from this set.
 int size()
           
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharSet
equals, hashCode, rem, remove
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection
add, addAll, addAll, charIterator, contains, containsAll, containsAll, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toCharArray, toCharArray, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection
addAll, charIterator, containsAll, removeAll, retainAll, toArray, toArray, toCharArray, toCharArray
 
Methods inherited from interface java.util.Set
add, addAll, contains, containsAll, removeAll, retainAll, toArray, toArray
 

Constructor Detail

CharArraySet

public CharArraySet(char[] a)
Creates a new array set using the given backing array. The resulting set will have as many elements as the array.

It is responsibility of the caller that the elements of a are distinct.

Parameters:
a - the backing array.

CharArraySet

public CharArraySet()
Creates a new empty array set.


CharArraySet

public CharArraySet(int capacity)
Creates a new empty array set of given initial capacity.

Parameters:
capacity - the initial capacity.

CharArraySet

public CharArraySet(CharCollection c)
Creates a new array set copying the contents of a given collection.

Parameters:
c - a collection.

CharArraySet

public CharArraySet(java.util.Collection<? extends java.lang.Character> c)
Creates a new array set copying the contents of a given set.

Parameters:
c - a collection.

CharArraySet

public CharArraySet(char[] a,
                    int size)
Creates a new array set using the given backing array and the given number of elements of the array.

It is responsibility of the caller that the first size elements of a are distinct.

Parameters:
a - the backing array.
size - the number of valid elements in a.
Method Detail

iterator

public CharIterator iterator()
Description copied from interface: CharCollection
Returns a type-specific iterator on the elements of this collection.

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

Specified by:
iterator in interface CharCollection
Specified by:
iterator in interface CharIterable
Specified by:
iterator in interface CharSet
Specified by:
iterator in interface java.lang.Iterable<java.lang.Character>
Specified by:
iterator in interface java.util.Collection<java.lang.Character>
Specified by:
iterator in interface java.util.Set<java.lang.Character>
Specified by:
iterator in class AbstractCharSet
Returns:
a type-specific iterator on the elements of this collection.

contains

public boolean contains(char k)
Specified by:
contains in interface CharCollection
Overrides:
contains in class AbstractCharCollection
See Also:
Collection.contains(Object)

size

public int size()
Specified by:
size in interface java.util.Collection<java.lang.Character>
Specified by:
size in interface java.util.Set<java.lang.Character>
Specified by:
size in class java.util.AbstractCollection<java.lang.Character>

remove

public boolean remove(char k)
Description copied from interface: CharSet
Removes an element from this set.

Note that the corresponding method of the type-specific collection is rem(). This unfortunate situation is caused by the clash with the similarly named index-based method in the List interface.

Specified by:
remove in interface CharSet
Overrides:
remove in class AbstractCharSet
See Also:
Collection.remove(Object)

add

public boolean add(char k)
Specified by:
add in interface CharCollection
Overrides:
add in class AbstractCharCollection
See Also:
Collection.add(Object)

clear

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

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Collection<java.lang.Character>
Specified by:
isEmpty in interface java.util.Set<java.lang.Character>
Overrides:
isEmpty in class AbstractCharCollection

clone

public CharArraySet clone()
Returns a deep copy of this set.

This method performs a deep copy of this hash set; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

Overrides:
clone in class java.lang.Object
Returns:
a deep copy of this set.