it.unimi.dsi.fastutil.longs.Long2ByteSortedMaps 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 it.unimi.dsi.fastutil.longs;
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.longs.Long2ByteSortedMap.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 Long2ByteSortedMaps {
private Long2ByteSortedMaps() {
}
/**
* 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 LongComparator comparator) {
return (Comparator>) (x, y) -> comparator.compare((x.getKey()).longValue(),
(y.getKey()).longValue());
}
/**
* 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(Long2ByteSortedMap map) {
final ObjectSortedSet entries = map.long2ByteEntrySet();
return entries instanceof Long2ByteSortedMap.FastSortedEntrySet
? ((Long2ByteSortedMap.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(Long2ByteSortedMap map) {
final ObjectSortedSet entries = map.long2ByteEntrySet();
return entries instanceof Long2ByteSortedMap.FastSortedEntrySet
? ((Long2ByteSortedMap.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 Long2ByteMaps.EmptyMap
implements
Long2ByteSortedMap,
java.io.Serializable,
Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected EmptySortedMap() {
}
@Override
public LongComparator comparator() {
return null;
}
@SuppressWarnings("unchecked")
@Override
public ObjectSortedSet long2ByteEntrySet() {
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;
}
@Override
public LongSortedSet keySet() {
return LongSortedSets.EMPTY_SET;
}
@Override
public Long2ByteSortedMap subMap(final long from, final long to) {
return EMPTY_MAP;
}
@Override
public Long2ByteSortedMap headMap(final long to) {
return EMPTY_MAP;
}
@Override
public Long2ByteSortedMap tailMap(final long from) {
return EMPTY_MAP;
}
@Override
public long firstLongKey() {
throw new NoSuchElementException();
}
@Override
public long lastLongKey() {
throw new NoSuchElementException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap headMap(Long oto) {
return headMap((oto).longValue());
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap tailMap(Long ofrom) {
return tailMap((ofrom).longValue());
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap subMap(Long ofrom, Long oto) {
return subMap((ofrom).longValue(), (oto).longValue());
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long firstKey() {
return Long.valueOf(firstLongKey());
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long lastKey() {
return Long.valueOf(lastLongKey());
}
}
/**
* 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 Long2ByteMaps.Singleton
implements
Long2ByteSortedMap,
java.io.Serializable,
Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected final LongComparator comparator;
protected Singleton(final long key, final byte value, LongComparator comparator) {
super(key, value);
this.comparator = comparator;
}
protected Singleton(final long key, final byte value) {
this(key, value, null);
}
final int compare(final long k1, final long k2) {
return comparator == null ? (Long.compare((k1), (k2))) : comparator.compare(k1, k2);
}
@Override
public LongComparator comparator() {
return comparator;
}
@Override
public ObjectSortedSet long2ByteEntrySet() {
if (entries == null)
entries = ObjectSortedSets.singleton(new AbstractLong2ByteMap.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) long2ByteEntrySet();
}
@Override
public LongSortedSet keySet() {
if (keys == null)
keys = LongSortedSets.singleton(key, comparator);
return (LongSortedSet) keys;
}
@Override
public Long2ByteSortedMap subMap(final long from, final long to) {
if (compare(from, key) <= 0 && compare(key, to) < 0)
return this;
return EMPTY_MAP;
}
@Override
public Long2ByteSortedMap headMap(final long to) {
if (compare(key, to) < 0)
return this;
return EMPTY_MAP;
}
@Override
public Long2ByteSortedMap tailMap(final long from) {
if (compare(from, key) <= 0)
return this;
return EMPTY_MAP;
}
@Override
public long firstLongKey() {
return key;
}
@Override
public long lastLongKey() {
return key;
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap headMap(Long oto) {
return headMap((oto).longValue());
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap tailMap(Long ofrom) {
return tailMap((ofrom).longValue());
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap subMap(Long ofrom, Long oto) {
return subMap((ofrom).longValue(), (oto).longValue());
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long firstKey() {
return Long.valueOf(firstLongKey());
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long lastKey() {
return Long.valueOf(lastLongKey());
}
}
/**
* 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 Long2ByteSortedMap singleton(final Long key, Byte value) {
return new Singleton((key).longValue(), (value).byteValue());
}
/**
* 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 Long2ByteSortedMap singleton(final Long key, Byte value, LongComparator comparator) {
return new Singleton((key).longValue(), (value).byteValue(), 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 Long2ByteSortedMap singleton(final long key, final byte 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 Long2ByteSortedMap singleton(final long key, final byte value, LongComparator comparator) {
return new Singleton(key, value, comparator);
}
/** A synchronized wrapper class for sorted maps. */
public static class SynchronizedSortedMap extends Long2ByteMaps.SynchronizedMap
implements
Long2ByteSortedMap,
java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Long2ByteSortedMap sortedMap;
protected SynchronizedSortedMap(final Long2ByteSortedMap m, final Object sync) {
super(m, sync);
sortedMap = m;
}
protected SynchronizedSortedMap(final Long2ByteSortedMap m) {
super(m);
sortedMap = m;
}
@Override
public LongComparator comparator() {
synchronized (sync) {
return sortedMap.comparator();
}
}
@Override
public ObjectSortedSet long2ByteEntrySet() {
if (entries == null)
entries = ObjectSortedSets.synchronize(sortedMap.long2ByteEntrySet(), sync);
return (ObjectSortedSet) entries;
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
@SuppressWarnings({"rawtypes", "unchecked"})
public ObjectSortedSet> entrySet() {
return (ObjectSortedSet) long2ByteEntrySet();
}
@Override
public LongSortedSet keySet() {
if (keys == null)
keys = LongSortedSets.synchronize(sortedMap.keySet(), sync);
return (LongSortedSet) keys;
}
@Override
public Long2ByteSortedMap subMap(final long from, final long to) {
return new SynchronizedSortedMap(sortedMap.subMap(from, to), sync);
}
@Override
public Long2ByteSortedMap headMap(final long to) {
return new SynchronizedSortedMap(sortedMap.headMap(to), sync);
}
@Override
public Long2ByteSortedMap tailMap(final long from) {
return new SynchronizedSortedMap(sortedMap.tailMap(from), sync);
}
@Override
public long firstLongKey() {
synchronized (sync) {
return sortedMap.firstLongKey();
}
}
@Override
public long lastLongKey() {
synchronized (sync) {
return sortedMap.lastLongKey();
}
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long firstKey() {
synchronized (sync) {
return sortedMap.firstKey();
}
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long lastKey() {
synchronized (sync) {
return sortedMap.lastKey();
}
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap subMap(final Long from, final Long to) {
return new SynchronizedSortedMap(sortedMap.subMap(from, to), sync);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap headMap(final Long to) {
return new SynchronizedSortedMap(sortedMap.headMap(to), sync);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap tailMap(final Long 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 Long2ByteSortedMap synchronize(final Long2ByteSortedMap 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 Long2ByteSortedMap synchronize(final Long2ByteSortedMap m, final Object sync) {
return new SynchronizedSortedMap(m, sync);
}
/** An unmodifiable wrapper class for sorted maps. */
public static class UnmodifiableSortedMap extends Long2ByteMaps.UnmodifiableMap
implements
Long2ByteSortedMap,
java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Long2ByteSortedMap sortedMap;
protected UnmodifiableSortedMap(final Long2ByteSortedMap m) {
super(m);
sortedMap = m;
}
@Override
public LongComparator comparator() {
return sortedMap.comparator();
}
@Override
public ObjectSortedSet long2ByteEntrySet() {
if (entries == null)
entries = ObjectSortedSets.unmodifiable(sortedMap.long2ByteEntrySet());
return (ObjectSortedSet) entries;
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
@SuppressWarnings({"rawtypes", "unchecked"})
public ObjectSortedSet> entrySet() {
return (ObjectSortedSet) long2ByteEntrySet();
}
@Override
public LongSortedSet keySet() {
if (keys == null)
keys = LongSortedSets.unmodifiable(sortedMap.keySet());
return (LongSortedSet) keys;
}
@Override
public Long2ByteSortedMap subMap(final long from, final long to) {
return new UnmodifiableSortedMap(sortedMap.subMap(from, to));
}
@Override
public Long2ByteSortedMap headMap(final long to) {
return new UnmodifiableSortedMap(sortedMap.headMap(to));
}
@Override
public Long2ByteSortedMap tailMap(final long from) {
return new UnmodifiableSortedMap(sortedMap.tailMap(from));
}
@Override
public long firstLongKey() {
return sortedMap.firstLongKey();
}
@Override
public long lastLongKey() {
return sortedMap.lastLongKey();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long firstKey() {
return sortedMap.firstKey();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long lastKey() {
return sortedMap.lastKey();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap subMap(final Long from, final Long to) {
return new UnmodifiableSortedMap(sortedMap.subMap(from, to));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap headMap(final Long to) {
return new UnmodifiableSortedMap(sortedMap.headMap(to));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public Long2ByteSortedMap tailMap(final Long 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 Long2ByteSortedMap unmodifiable(final Long2ByteSortedMap m) {
return new UnmodifiableSortedMap(m);
}
}