it.unimi.dsi.fastutil.bytes.Byte2IntSortedMaps Maven / Gradle / Ivy
/*
* Copyright (C) 2002-2022 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.bytes;
import it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterable;
import it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator;
import it.unimi.dsi.fastutil.objects.ObjectSortedSet;
import it.unimi.dsi.fastutil.objects.ObjectSortedSets;
import it.unimi.dsi.fastutil.bytes.Byte2IntSortedMap.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 Byte2IntSortedMaps {
private Byte2IntSortedMaps() {}
/** 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 ByteComparator comparator) {
return (Comparator>) (x, y) -> comparator.compare((x.getKey()).byteValue(), (y.getKey()).byteValue());
}
/** 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
*/
public static ObjectBidirectionalIterator fastIterator(Byte2IntSortedMap map) {
final ObjectSortedSet entries = map.byte2IntEntrySet();
return entries instanceof Byte2IntSortedMap.FastSortedEntrySet ? ((Byte2IntSortedMap.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
*/
public static ObjectBidirectionalIterable fastIterable(Byte2IntSortedMap map) {
final ObjectSortedSet entries = map.byte2IntEntrySet();
return entries instanceof Byte2IntSortedMap.FastSortedEntrySet ? ((Byte2IntSortedMap.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 Byte2IntMaps.EmptyMap implements Byte2IntSortedMap , java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected EmptySortedMap() {}
@Override
public ByteComparator comparator() { return null; }
@Override
public ObjectSortedSet byte2IntEntrySet() { return ObjectSortedSets.EMPTY_SET; }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public ObjectSortedSet> entrySet() { return ObjectSortedSets.EMPTY_SET; }
@Override
public ByteSortedSet keySet() { return ByteSortedSets.EMPTY_SET; }
@Override
public Byte2IntSortedMap subMap(final byte from, final byte to) { return EMPTY_MAP; }
@Override
public Byte2IntSortedMap headMap(final byte to) { return EMPTY_MAP; }
@Override
public Byte2IntSortedMap tailMap(final byte from) { return EMPTY_MAP; }
@Override
public byte firstByteKey() { throw new NoSuchElementException(); }
@Override
public byte lastByteKey() { throw new NoSuchElementException(); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap headMap(Byte oto) { return headMap((oto).byteValue()); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap tailMap(Byte ofrom) { return tailMap((ofrom).byteValue()); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap subMap(Byte ofrom, Byte oto) { return subMap((ofrom).byteValue(), (oto).byteValue()); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte firstKey() { return Byte.valueOf(firstByteKey()); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte lastKey() { return Byte.valueOf(lastByteKey()); }
}
/** An empty sorted map (immutable). It is serializable and cloneable.
*/
public static final EmptySortedMap EMPTY_MAP = new EmptySortedMap();
/** 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 Byte2IntMaps.Singleton implements Byte2IntSortedMap , java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected final ByteComparator comparator;
protected Singleton(final byte key, final int value, ByteComparator comparator) {
super(key, value);
this.comparator = comparator;
}
protected Singleton(final byte key, final int value) {
this(key, value, null);
}
final int compare(final byte k1, final byte k2) {
return comparator == null ? ( Byte.compare((k1),(k2)) ) : comparator.compare(k1, k2);
}
@Override
public ByteComparator comparator() { return comparator; }
@Override
public ObjectSortedSet byte2IntEntrySet() { if (entries == null) entries = ObjectSortedSets.singleton(new AbstractByte2IntMap.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)byte2IntEntrySet(); }
@Override
public ByteSortedSet keySet() { if (keys == null) keys = ByteSortedSets.singleton(key, comparator); return (ByteSortedSet )keys; }
@Override
public Byte2IntSortedMap subMap(final byte from, final byte to) { if (compare(from, key) <= 0 && compare(key, to) < 0) return this; return EMPTY_MAP; }
@Override
public Byte2IntSortedMap headMap(final byte to) { if (compare(key, to) < 0) return this; return EMPTY_MAP; }
@Override
public Byte2IntSortedMap tailMap(final byte from) { if (compare(from, key) <= 0) return this; return EMPTY_MAP; }
@Override
public byte firstByteKey() { return key; }
@Override
public byte lastByteKey() { return key; }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap headMap(Byte oto) { return headMap((oto).byteValue()); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap tailMap(Byte ofrom) { return tailMap((ofrom).byteValue()); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap subMap(Byte ofrom, Byte oto) { return subMap((ofrom).byteValue(), (oto).byteValue()); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte firstKey() { return Byte.valueOf(firstByteKey()); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte lastKey() { return Byte.valueOf(lastByteKey()); }
}
/** 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 Byte2IntSortedMap singleton(final Byte key, Integer value) { return new Singleton ((key).byteValue(), (value).intValue());}
/** 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 Byte2IntSortedMap singleton(final Byte key, Integer value, ByteComparator comparator) { return new Singleton ((key).byteValue(), (value).intValue(), 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 Byte2IntSortedMap singleton(final byte key, final int 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 Byte2IntSortedMap singleton(final byte key, final int value, ByteComparator comparator) {
return new Singleton (key, value, comparator);
}
/** A synchronized wrapper class for sorted maps. */
public static class SynchronizedSortedMap extends Byte2IntMaps.SynchronizedMap implements Byte2IntSortedMap , java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Byte2IntSortedMap sortedMap;
protected SynchronizedSortedMap(final Byte2IntSortedMap m, final Object sync) {
super(m, sync);
sortedMap = m;
}
protected SynchronizedSortedMap(final Byte2IntSortedMap m) {
super(m);
sortedMap = m;
}
@Override
public ByteComparator comparator() { synchronized(sync) { return sortedMap.comparator(); } }
@Override
public ObjectSortedSet byte2IntEntrySet() { if (entries == null) entries = ObjectSortedSets.synchronize(sortedMap.byte2IntEntrySet(), sync); return (ObjectSortedSet)entries; }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public ObjectSortedSet> entrySet() { return (ObjectSortedSet)byte2IntEntrySet(); }
@Override
public ByteSortedSet keySet() { if (keys == null) keys = ByteSortedSets.synchronize(sortedMap.keySet(), sync); return (ByteSortedSet )keys; }
@Override
public Byte2IntSortedMap subMap(final byte from, final byte to) { return new SynchronizedSortedMap (sortedMap.subMap(from, to), sync); }
@Override
public Byte2IntSortedMap headMap(final byte to) { return new SynchronizedSortedMap (sortedMap.headMap(to), sync); }
@Override
public Byte2IntSortedMap tailMap(final byte from) { return new SynchronizedSortedMap (sortedMap.tailMap(from), sync); }
@Override
public byte firstByteKey() { synchronized(sync) { return sortedMap.firstByteKey(); } }
@Override
public byte lastByteKey() { synchronized(sync) { return sortedMap.lastByteKey(); } }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte firstKey() { synchronized(sync) { return sortedMap.firstKey(); } }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte lastKey() { synchronized(sync) { return sortedMap.lastKey(); } }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap subMap(final Byte from, final Byte to) { return new SynchronizedSortedMap (sortedMap.subMap(from, to), sync); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap headMap(final Byte to) { return new SynchronizedSortedMap (sortedMap.headMap(to), sync); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap tailMap(final Byte from) { return new SynchronizedSortedMap (sortedMap.tailMap(from), sync); }
}
/** 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 Byte2IntSortedMap synchronize(final Byte2IntSortedMap 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 Byte2IntSortedMap synchronize(final Byte2IntSortedMap m, final Object sync) { return new SynchronizedSortedMap (m, sync); }
/** An unmodifiable wrapper class for sorted maps. */
public static class UnmodifiableSortedMap extends Byte2IntMaps.UnmodifiableMap implements Byte2IntSortedMap , java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Byte2IntSortedMap sortedMap;
protected UnmodifiableSortedMap(final Byte2IntSortedMap m) {
super(m);
sortedMap = m;
}
@Override
public ByteComparator comparator() { return sortedMap.comparator(); }
@SuppressWarnings({ "rawtypes", "unchecked" })
@Override
public ObjectSortedSet byte2IntEntrySet() { if (entries == null) entries = ObjectSortedSets.unmodifiable((ObjectSortedSet)sortedMap.byte2IntEntrySet()); return (ObjectSortedSet)entries; }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public ObjectSortedSet> entrySet() { return (ObjectSortedSet)byte2IntEntrySet(); }
@Override
public ByteSortedSet keySet() { if (keys == null) keys = ByteSortedSets.unmodifiable(sortedMap.keySet()); return (ByteSortedSet )keys; }
@Override
public Byte2IntSortedMap subMap(final byte from, final byte to) { return new UnmodifiableSortedMap (sortedMap.subMap(from, to)); }
@Override
public Byte2IntSortedMap headMap(final byte to) { return new UnmodifiableSortedMap (sortedMap.headMap(to)); }
@Override
public Byte2IntSortedMap tailMap(final byte from) { return new UnmodifiableSortedMap (sortedMap.tailMap(from)); }
@Override
public byte firstByteKey() { return sortedMap.firstByteKey(); }
@Override
public byte lastByteKey() { return sortedMap.lastByteKey(); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte firstKey() { return sortedMap.firstKey(); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte lastKey() { return sortedMap.lastKey(); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap subMap(final Byte from, final Byte to) { return new UnmodifiableSortedMap (sortedMap.subMap(from, to)); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap headMap(final Byte to) { return new UnmodifiableSortedMap (sortedMap.headMap(to)); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public Byte2IntSortedMap tailMap(final Byte from) { return new UnmodifiableSortedMap (sortedMap.tailMap(from)); }
}
/** 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 Byte2IntSortedMap unmodifiable(final Byte2IntSortedMap m) { return new UnmodifiableSortedMap (m); }
}