it.unimi.dsi.fastutil.shorts.ShortSets Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/*
* Copyright (C) 2002-2020 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 it.unimi.dsi.fastutil.shorts;
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 final class ShortSets {
private ShortSets() {
}
/**
* 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 extends ShortCollections.EmptyCollection
implements
ShortSet,
java.io.Serializable,
Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected EmptySet() {
}
@Override
public boolean remove(short 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();
}
@Deprecated
@Override
public boolean rem(final short k) {
return super.rem(k);
}
private Object readResolve() {
return EMPTY_SET;
}
}
/**
* An empty set (immutable). It is serializable and cloneable.
*/
public static final EmptySet EMPTY_SET = new EmptySet();
/**
* 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 extends AbstractShortSet implements java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected final short element;
protected Singleton(final short element) {
this.element = element;
}
@Override
public boolean contains(final short k) {
return ((k) == (element));
}
@Override
public boolean remove(final short k) {
throw new UnsupportedOperationException();
}
@Override
public ShortListIterator iterator() {
return ShortIterators.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();
}
@Override
public boolean addAll(final ShortCollection c) {
throw new UnsupportedOperationException();
}
@Override
public boolean removeAll(final ShortCollection c) {
throw new UnsupportedOperationException();
}
@Override
public boolean retainAll(final ShortCollection c) {
throw new UnsupportedOperationException();
}
@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 {@code element}.
*/
public static ShortSet singleton(final short element) {
return new Singleton(element);
}
/**
* 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 {@code element}.
*/
public static ShortSet singleton(final Short element) {
return new Singleton((element).shortValue());
}
/** A synchronized wrapper class for sets. */
public static class SynchronizedSet extends ShortCollections.SynchronizedCollection
implements
ShortSet,
java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected SynchronizedSet(final ShortSet s, final Object sync) {
super(s, sync);
}
protected SynchronizedSet(final ShortSet s) {
super(s);
}
@Override
public boolean remove(final short k) {
synchronized (sync) {
return collection.rem(k);
}
}
@Deprecated
@Override
public boolean rem(final short k) {
return super.rem(k);
}
}
/**
* 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 ShortSet synchronize(final ShortSet s) {
return new SynchronizedSet(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 ShortSet synchronize(final ShortSet s, final Object sync) {
return new SynchronizedSet(s, sync);
}
/** An unmodifiable wrapper class for sets. */
public static class UnmodifiableSet extends ShortCollections.UnmodifiableCollection
implements
ShortSet,
java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected UnmodifiableSet(final ShortSet s) {
super(s);
}
@Override
public boolean remove(final short 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();
}
@Deprecated
@Override
public boolean rem(final short k) {
return super.rem(k);
}
}
/**
* 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 ShortSet unmodifiable(final ShortSet s) {
return new UnmodifiableSet(s);
}
/**
* Returns an unmodifiable type-specific set containing elements in the given
* range.
*
* @param from
* the starting element (lower bound) of the set (inclusive).
* @param to
* the ending element (upper bound) of the set (exclusive).
* @return an unmodifiable set containing the elements in the given range.
*/
public static ShortSet fromTo(final short from, final short to) {
return new AbstractShortSet() {
@Override
public boolean contains(final short x) {
return x >= from && x < to;
}
@Override
public ShortIterator iterator() {
return ShortIterators.fromTo(from, to);
}
@Override
public int size() {
final long size = (long) to - (long) from;
return size >= 0 && size <= Integer.MAX_VALUE ? (int) size : Integer.MAX_VALUE;
}
};
}
/**
* Returns an unmodifiable type-specific set containing elements greater than or
* equal to a given element.
*
* @param from
* the starting element (lower bound) of the set (inclusive).
* @return an unmodifiable set containing the elements greater than or equal to
* {@code from}.
*/
public static ShortSet from(final short from) {
return new AbstractShortSet() {
@Override
public boolean contains(final short x) {
return x >= from;
}
@Override
public ShortIterator iterator() {
return ShortIterators.concat(new ShortIterator[]{ShortIterators.fromTo(from, Short.MAX_VALUE),
ShortSets.singleton(Short.MAX_VALUE).iterator()});
}
@Override
public int size() {
final long size = Short.MAX_VALUE - (long) from + 1;
return size >= 0 && size <= Integer.MAX_VALUE ? (int) size : Integer.MAX_VALUE;
}
};
}
/**
* Returns an unmodifiable type-specific set containing elements smaller than a
* given element.
*
* @param to
* the ending element (upper bound) of the set (exclusive).
* @return an unmodifiable set containing the elements smaller than {@code to}.
*/
public static ShortSet to(final short to) {
return new AbstractShortSet() {
@Override
public boolean contains(final short x) {
return x < to;
}
@Override
public ShortIterator iterator() {
return ShortIterators.fromTo(Short.MIN_VALUE, to);
}
@Override
public int size() {
final long size = (long) to - Short.MIN_VALUE;
return size >= 0 && size <= Integer.MAX_VALUE ? (int) size : Integer.MAX_VALUE;
}
};
}
}