it.unimi.dsi.fastutil.objects.Reference2BooleanSortedMaps Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/*
* Copyright (C) 2002-2021 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.objects;
import it.unimi.dsi.fastutil.objects.Reference2BooleanSortedMap.FastSortedEntrySet;
import java.util.Comparator;
import java.util.Map;
import java.util.SortedMap;
import java.util.NoSuchElementException;
/** A class providing static methods and objects that do useful things with type-specific sorted maps.
*
* @see java.util.Collections
*/
public final class Reference2BooleanSortedMaps {
private Reference2BooleanSortedMaps() {}
/** Returns a comparator for entries based on a given comparator on keys.
*
* @param comparator a comparator on keys.
* @return the associated comparator on entries.
*/
public static Comparator> entryComparator(final Comparator comparator) {
return (Comparator>) (x, y) -> comparator.compare((x.getKey()), (y.getKey()));
}
/** Returns a bidirectional iterator that will be {@linkplain FastSortedEntrySet fast}, if possible, on the {@linkplain Map#entrySet() entry set} of the provided {@code map}.
* @param map a map from which we will try to extract a (fast) bidirectional iterator on the entry set.
* @return a bidirectional iterator on the entry set of the given map that will be fast, if possible.
* @since 8.0.0
*/
@SuppressWarnings("unchecked")
public static ObjectBidirectionalIterator > fastIterator(Reference2BooleanSortedMap map) {
final ObjectSortedSet > entries = map.reference2BooleanEntrySet();
return entries instanceof Reference2BooleanSortedMap.FastSortedEntrySet ? ((Reference2BooleanSortedMap.FastSortedEntrySet ) entries).fastIterator() : entries.iterator();
}
/** Returns an iterable yielding a bidirectional iterator that will be {@linkplain FastSortedEntrySet fast}, if possible, on the {@linkplain Map#entrySet() entry set} of the provided {@code map}.
* @param map a map from which we will try to extract an iterable yielding a (fast) bidirectional iterator on the entry set.
* @return an iterable yielding a bidirectional iterator on the entry set of the given map that will be fast, if possible.
* @since 8.0.0
*/
@SuppressWarnings("unchecked")
public static ObjectBidirectionalIterable > fastIterable(Reference2BooleanSortedMap map) {
final ObjectSortedSet > entries = map.reference2BooleanEntrySet();
return entries instanceof Reference2BooleanSortedMap.FastSortedEntrySet ? ((Reference2BooleanSortedMap.FastSortedEntrySet )entries)::fastIterator : entries;
}
/** An immutable class representing an empty type-specific sorted map.
*
* This class may be useful to implement your own in case you subclass
* a type-specific sorted map.
*/
public static class EmptySortedMap extends Reference2BooleanMaps.EmptyMap implements Reference2BooleanSortedMap , java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected EmptySortedMap() {}
@Override
public Comparator comparator() { return null; }
@SuppressWarnings("unchecked")
@Override
public ObjectSortedSet > reference2BooleanEntrySet() { return ObjectSortedSets.EMPTY_SET; }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
@SuppressWarnings("unchecked")
public ObjectSortedSet> entrySet() { return ObjectSortedSets.EMPTY_SET; }
@SuppressWarnings("unchecked")
@Override
public ReferenceSortedSet keySet() { return ReferenceSortedSets.EMPTY_SET; }
@SuppressWarnings("unchecked")
@Override
public Reference2BooleanSortedMap subMap(final K from, final K to) { return EMPTY_MAP; }
@SuppressWarnings("unchecked")
@Override
public Reference2BooleanSortedMap headMap(final K to) { return EMPTY_MAP; }
@SuppressWarnings("unchecked")
@Override
public Reference2BooleanSortedMap tailMap(final K from) { return EMPTY_MAP; }
@Override
public K firstKey() { throw new NoSuchElementException(); }
@Override
public K lastKey() { throw new NoSuchElementException(); }
}
/** An empty sorted map (immutable). It is serializable and cloneable.
*/
@SuppressWarnings("rawtypes")
public static final EmptySortedMap EMPTY_MAP = new EmptySortedMap();
/** Returns an empty sorted map (immutable). It is serializable and cloneable.
*
* This method provides a typesafe access to {@link #EMPTY_MAP}.
* @return an empty sorted map (immutable).
*/
@SuppressWarnings("unchecked")
public static Reference2BooleanSortedMap emptyMap() {
return EMPTY_MAP;
}
/** An immutable class representing a type-specific singleton sorted map.
*
* This class may be useful to implement your own in case you subclass
* a type-specific sorted map.
*/
public static class Singleton extends Reference2BooleanMaps.Singleton implements Reference2BooleanSortedMap , java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Comparator comparator;
protected Singleton(final K key, final boolean value, Comparator comparator) {
super(key, value);
this.comparator = comparator;
}
protected Singleton(final K key, final boolean value) {
this(key, value, null);
}
@SuppressWarnings("unchecked")
final int compare(final K k1, final K k2) {
return comparator == null ? ( ((Comparable)(k1)).compareTo(k2) ) : comparator.compare(k1, k2);
}
@Override
public Comparator comparator() { return comparator; }
@SuppressWarnings("unchecked")
@Override
public ObjectSortedSet > reference2BooleanEntrySet() { if (entries == null) entries = ObjectSortedSets.singleton(new AbstractReference2BooleanMap.BasicEntry <>(key, value), entryComparator(comparator)); return (ObjectSortedSet >)entries; }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public ObjectSortedSet> entrySet() { return (ObjectSortedSet)reference2BooleanEntrySet(); }
@Override
public ReferenceSortedSet keySet() { if (keys == null) keys = ReferenceSortedSets.singleton(key, comparator); return (ReferenceSortedSet )keys; }
@SuppressWarnings("unchecked")
@Override
public Reference2BooleanSortedMap subMap(final K from, final K to) { if (compare(from, key) <= 0 && compare(key, to) < 0) return this; return EMPTY_MAP; }
@SuppressWarnings("unchecked")
@Override
public Reference2BooleanSortedMap headMap(final K to) { if (compare(key, to) < 0) return this; return EMPTY_MAP; }
@SuppressWarnings("unchecked")
@Override
public Reference2BooleanSortedMap tailMap(final K from) { if (compare(from, key) <= 0) return this; return EMPTY_MAP; }
@Override
public K firstKey() { return key; }
@Override
public K lastKey() { return key; }
}
/** Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted map is serializable and cloneable.
*
* Note that albeit the returned map is immutable, its default return value may be changed.
*
* @param key the only key of the returned sorted map.
* @param value the only value of the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair {@code <key,value>}.
*/
public static Reference2BooleanSortedMap singleton(final K key, Boolean value) { return new Singleton <>((key), (value).booleanValue());}
/** RETURNS a type-specific immutable sorted map containing only the specified pair. The returned sorted map is serializable and cloneable.
*
* Note that albeit the returned map is immutable, its default return value may be changed.
*
* @param key the only key of the returned sorted map.
* @param value the only value of the returned sorted map.
* @param comparator the comparator to use in the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair {@code <key,value>}.
*/
public static Reference2BooleanSortedMap singleton(final K key, Boolean value, Comparator comparator) { return new Singleton <>((key), (value).booleanValue(), comparator); }
/** Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted map is serializable and cloneable.
*
* Note that albeit the returned map is immutable, its default return value may be changed.
*
* @param key the only key of the returned sorted map.
* @param value the only value of the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair {@code <key,value>}.
*/
public static Reference2BooleanSortedMap singleton(final K key, final boolean value) {
return new Singleton <>(key, value);
}
/** Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted map is serializable and cloneable.
*
* Note that albeit the returned map is immutable, its default return value may be changed.
*
* @param key the only key of the returned sorted map.
* @param value the only value of the returned sorted map.
* @param comparator the comparator to use in the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair {@code <key,value>}.
*/
public static Reference2BooleanSortedMap singleton(final K key, final boolean value, Comparator comparator) {
return new Singleton <>(key, value, comparator);
}
/** A synchronized wrapper class for sorted maps. */
public static class SynchronizedSortedMap extends Reference2BooleanMaps.SynchronizedMap implements Reference2BooleanSortedMap , java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Reference2BooleanSortedMap sortedMap;
protected SynchronizedSortedMap(final Reference2BooleanSortedMap m, final Object sync) {
super(m, sync);
sortedMap = m;
}
protected SynchronizedSortedMap(final Reference2BooleanSortedMap m) {
super(m);
sortedMap = m;
}
@Override
public Comparator comparator() { synchronized(sync) { return sortedMap.comparator(); } }
@Override
public ObjectSortedSet > reference2BooleanEntrySet() { if (entries == null) entries = ObjectSortedSets.synchronize(sortedMap.reference2BooleanEntrySet(), sync); return (ObjectSortedSet >)entries; }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public ObjectSortedSet> entrySet() { return (ObjectSortedSet)reference2BooleanEntrySet(); }
@Override
public ReferenceSortedSet keySet() { if (keys == null) keys = ReferenceSortedSets.synchronize(sortedMap.keySet(), sync); return (ReferenceSortedSet )keys; }
@Override
public Reference2BooleanSortedMap subMap(final K from, final K to) { return new SynchronizedSortedMap <>(sortedMap.subMap(from, to), sync); }
@Override
public Reference2BooleanSortedMap headMap(final K to) { return new SynchronizedSortedMap <>(sortedMap.headMap(to), sync); }
@Override
public Reference2BooleanSortedMap tailMap(final K from) { return new SynchronizedSortedMap <>(sortedMap.tailMap(from), sync); }
@Override
public K firstKey() { synchronized(sync) { return sortedMap.firstKey(); } }
@Override
public K lastKey() { synchronized(sync) { return sortedMap.lastKey(); } }
}
/** Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.
*
* @param m the sorted map to be wrapped in a synchronized sorted map.
* @return a synchronized view of the specified sorted map.
* @see java.util.Collections#synchronizedSortedMap(SortedMap)
*/
public static Reference2BooleanSortedMap synchronize(final Reference2BooleanSortedMap m) { return new SynchronizedSortedMap <>(m); }
/** Returns a synchronized type-specific sorted map backed by the given type-specific sorted map, using an assigned object to synchronize.
*
* @param m the sorted map to be wrapped in a synchronized sorted map.
* @param sync an object that will be used to synchronize the access to the sorted sorted map.
* @return a synchronized view of the specified sorted map.
* @see java.util.Collections#synchronizedSortedMap(SortedMap)
*/
public static Reference2BooleanSortedMap synchronize(final Reference2BooleanSortedMap m, final Object sync) { return new SynchronizedSortedMap <>(m, sync); }
/** An unmodifiable wrapper class for sorted maps. */
public static class UnmodifiableSortedMap extends Reference2BooleanMaps.UnmodifiableMap implements Reference2BooleanSortedMap , java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Reference2BooleanSortedMap sortedMap;
protected UnmodifiableSortedMap(final Reference2BooleanSortedMap m) {
super(m);
sortedMap = m;
}
@Override
public Comparator comparator() { return sortedMap.comparator(); }
@SuppressWarnings({ "rawtypes", "unchecked" })
@Override
public ObjectSortedSet > reference2BooleanEntrySet() { if (entries == null) entries = ObjectSortedSets.unmodifiable((ObjectSortedSet)sortedMap.reference2BooleanEntrySet()); return (ObjectSortedSet >)entries; }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public ObjectSortedSet> entrySet() { return (ObjectSortedSet)reference2BooleanEntrySet(); }
@Override
public ReferenceSortedSet keySet() { if (keys == null) keys = ReferenceSortedSets.unmodifiable(sortedMap.keySet()); return (ReferenceSortedSet )keys; }
@Override
public Reference2BooleanSortedMap subMap(final K from, final K to) { return new UnmodifiableSortedMap <>(sortedMap.subMap(from, to)); }
@Override
public Reference2BooleanSortedMap headMap(final K to) { return new UnmodifiableSortedMap <>(sortedMap.headMap(to)); }
@Override
public Reference2BooleanSortedMap tailMap(final K from) { return new UnmodifiableSortedMap <>(sortedMap.tailMap(from)); }
@Override
public K firstKey() { return sortedMap.firstKey(); }
@Override
public K lastKey() { return sortedMap.lastKey(); }
}
/** Returns an unmodifiable type-specific sorted map backed by the given type-specific sorted map.
*
* @param m the sorted map to be wrapped in an unmodifiable sorted map.
* @return an unmodifiable view of the specified sorted map.
* @see java.util.Collections#unmodifiableSortedMap(SortedMap)
*/
public static Reference2BooleanSortedMap unmodifiable(final Reference2BooleanSortedMap m) { return new UnmodifiableSortedMap <>(m); }
}