drv.Sets.drv Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/*
* Copyright (C) 2002-2017 Sebastiano Vigna
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package PACKAGE;
import java.util.Collection;
import java.util.Set;
/** A class providing static methods and objects that do useful things with type-specific sets.
*
* @see java.util.Collections
*/
public class SETS {
private SETS() {}
/** An immutable class representing the empty set and implementing a type-specific set interface.
*
* This class may be useful to implement your own in case you subclass
* a type-specific set.
*/
public static class EmptySet KEY_GENERIC extends COLLECTIONS.EmptyCollection KEY_GENERIC implements SET KEY_GENERIC, java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected EmptySet() {}
@Override
public boolean remove(KEY_TYPE ok) { throw new UnsupportedOperationException(); }
@Override
public Object clone() { return EMPTY_SET; }
@Override
@SuppressWarnings("rawtypes")
public boolean equals(final Object o) { return o instanceof Set && ((Set)o).isEmpty(); }
#if KEYS_PRIMITIVE
@Deprecated
@Override
public boolean rem(final KEY_TYPE k) { return super.rem(k); }
#endif
private Object readResolve() { return EMPTY_SET; }
}
/** An empty set (immutable). It is serializable and cloneable.
*/
SUPPRESS_WARNINGS_KEY_RAWTYPES
public static final EmptySet EMPTY_SET = new EmptySet();
#if KEYS_REFERENCE
/** Returns an empty set (immutable). It is serializable and cloneable.
*
*
This method provides a typesafe access to {@link #EMPTY_SET}.
* @return an empty set (immutable).
*/
@SuppressWarnings("unchecked")
public static KEY_GENERIC SET KEY_GENERIC emptySet() {
return EMPTY_SET;
}
#endif
/** An immutable class representing a type-specific singleton set.
*
*
This class may be useful to implement your own in case you subclass
* a type-specific set. */
public static class Singleton KEY_GENERIC extends ABSTRACT_SET KEY_GENERIC implements java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected final KEY_GENERIC_TYPE element;
protected Singleton(final KEY_GENERIC_TYPE element) {
this.element = element;
}
@Override
public boolean contains(final KEY_TYPE k) { return KEY_EQUALS(k, element); }
@Override
public boolean remove(final KEY_TYPE k) { throw new UnsupportedOperationException(); }
@Override
public KEY_LIST_ITERATOR KEY_GENERIC iterator() { return ITERATORS.singleton(element); }
@Override
public int size() { return 1; }
@Override
public boolean addAll(final Collection c) { throw new UnsupportedOperationException(); }
@Override
public boolean removeAll(final Collection c) { throw new UnsupportedOperationException(); }
@Override
public boolean retainAll(final Collection c) { throw new UnsupportedOperationException(); }
#if KEYS_PRIMITIVE
@Override
public boolean addAll(final COLLECTION c) { throw new UnsupportedOperationException(); }
@Override
public boolean removeAll(final COLLECTION c) { throw new UnsupportedOperationException(); }
@Override
public boolean retainAll(final COLLECTION c) { throw new UnsupportedOperationException(); }
#endif
@Override
public Object clone() { return this; }
}
/** Returns a type-specific immutable set containing only the specified element. The returned set is serializable and cloneable.
*
* @param element the only element of the returned set.
* @return a type-specific immutable set containing just element.
*/
public static KEY_GENERIC SET KEY_GENERIC singleton(final KEY_GENERIC_TYPE element) {
return new Singleton KEY_GENERIC(element);
}
#if KEYS_PRIMITIVE
/** Returns a type-specific immutable set containing only the specified element. The returned set is serializable and cloneable.
*
* @param element the only element of the returned set.
* @return a type-specific immutable set containing just element.
*/
public static KEY_GENERIC SET KEY_GENERIC singleton(final KEY_GENERIC_CLASS element) {
return new Singleton KEY_GENERIC(KEY_CLASS2TYPE(element));
}
#endif
/** A synchronized wrapper class for sets. */
public static class SynchronizedSet KEY_GENERIC extends COLLECTIONS.SynchronizedCollection KEY_GENERIC implements SET KEY_GENERIC, java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected SynchronizedSet(final SET KEY_GENERIC s, final Object sync) {
super(s, sync);
}
protected SynchronizedSet(final SET KEY_GENERIC s) {
super(s);
}
@Override
public boolean remove(final KEY_TYPE k) { synchronized(sync) { return collection.REMOVE(k); } }
#if KEYS_PRIMITIVE
@Deprecated
@Override
public boolean rem(final KEY_TYPE k) { return super.rem(k); }
#endif
}
/** Returns a synchronized type-specific set backed by the given type-specific set.
*
* @param s the set to be wrapped in a synchronized set.
* @return a synchronized view of the specified set.
* @see java.util.Collections#synchronizedSet(Set)
*/
public static KEY_GENERIC SET KEY_GENERIC synchronize(final SET KEY_GENERIC s) { return new SynchronizedSet KEY_GENERIC(s); }
/** Returns a synchronized type-specific set backed by the given type-specific set, using an assigned object to synchronize.
*
* @param s the set to be wrapped in a synchronized set.
* @param sync an object that will be used to synchronize the access to the set.
* @return a synchronized view of the specified set.
* @see java.util.Collections#synchronizedSet(Set)
*/
public static KEY_GENERIC SET KEY_GENERIC synchronize(final SET KEY_GENERIC s, final Object sync) { return new SynchronizedSet KEY_GENERIC(s, sync); }
/** An unmodifiable wrapper class for sets. */
public static class UnmodifiableSet KEY_GENERIC extends COLLECTIONS.UnmodifiableCollection KEY_GENERIC implements SET KEY_GENERIC, java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected UnmodifiableSet(final SET KEY_GENERIC s) {
super(s);
}
@Override
public boolean remove(final KEY_TYPE k) { throw new UnsupportedOperationException(); }
@Override
public boolean equals(final Object o) { if (o == this) return true; return collection.equals(o); }
@Override
public int hashCode() { return collection.hashCode(); }
#if KEYS_PRIMITIVE
@Deprecated
@Override
public boolean rem(final KEY_TYPE k) { return super.rem(k); }
#endif
}
/** Returns an unmodifiable type-specific set backed by the given type-specific set.
*
* @param s the set to be wrapped in an unmodifiable set.
* @return an unmodifiable view of the specified set.
* @see java.util.Collections#unmodifiableSet(Set)
*/
public static KEY_GENERIC SET KEY_GENERIC unmodifiable(final SET KEY_GENERIC s) { return new UnmodifiableSet KEY_GENERIC(s); }
#ifdef TEST
private static KEY_TYPE genKey() {
#if KEY_CLASS_Byte || KEY_CLASS_Short || KEY_CLASS_Character
return (KEY_TYPE)(r.nextInt());
#elif KEYS_PRIMITIVE
return r.NEXT_KEY();
#elif KEY_CLASS_Object
return Integer.toBinaryString(r.nextInt());
#else
return new java.io.Serializable() {};
#endif
}
private static void test() {
int n = 100;
int c;
KEY_TYPE k = genKey();
Singleton m = new Singleton(k);
Set t = java.util.Collections.singleton(KEY2OBJ(k));
long ms;
boolean mThrowsIllegal, tThrowsIllegal, mThrowsNoElement, tThrowsNoElement, mThrowsIndex, tThrowsIndex, mThrowsUnsupp, tThrowsUnsupp;
boolean rt = false, rm = false;
/* Now we check that m and t are equal. */
if (!m.equals(t) || ! t.equals(m)) System.err.println("m: " + m + " t: " + t);
ensure(m.equals(t), "Error (" + seed + "): ! m.equals(t) at start");
ensure(t.equals(m), "Error (" + seed + "): ! t.equals(m) at start");
/* Now we check that m actually holds that data. */
for(java.util.Iterator i=t.iterator(); i.hasNext();) {
ensure(m.contains(i.next()), "Error (" + seed + "): m and t differ on an entry after insertion (iterating on t)");
}
/* Now we check that m actually holds that data, but iterating on m. */
for(java.util.Iterator i=m.iterator(); i.hasNext();) {
ensure(t.contains(i.next()), "Error (" + seed + "): m and t differ on an entry after insertion (iterating on m)");
}
/* Now we check that inquiries about random data give the same answer in m and t. For
m we use the polymorphic method. */
for(int i=0; i 1) r = new java.util.Random(seed = Long.parseLong(arg[1]));
try {
test();
} catch(Throwable e) {
e.printStackTrace(System.err);
System.err.println("seed: " + seed);
}
}
#endif
}