/*
	* Copyright (C) 2002-2019 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.doubles;
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.doubles.Double2ShortSortedMap.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 Also:
  • Collections
/** * A class providing static methods and objects that do useful things with * type-specific sorted maps. * * @see java.util.Collections */
public final class Double2ShortSortedMaps { private Double2ShortSortedMaps() { }
Returns a comparator for entries based on a given comparator on keys.
Params:
  • comparator – a comparator on keys.
Returns:the associated comparator on entries.
/** * 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<? super Map.Entry<Double, ?>> entryComparator(final DoubleComparator comparator) { return (Comparator<Map.Entry<Double, ?>>) (x, y) -> comparator.compare((x.getKey()).doubleValue(), (y.getKey()).doubleValue()); }
Returns a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.
Params:
  • map – a map from which we will try to extract a (fast) bidirectional iterator on the entry set.
Returns:a bidirectional iterator on the entry set of the given map that will be fast, if possible.
Since:8.0.0
/** * 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<Double2ShortMap.Entry> fastIterator(Double2ShortSortedMap map) { final ObjectSortedSet<Double2ShortMap.Entry> entries = map.double2ShortEntrySet(); return entries instanceof Double2ShortSortedMap.FastSortedEntrySet ? ((Double2ShortSortedMap.FastSortedEntrySet) entries).fastIterator() : entries.iterator(); }
Returns an iterable yielding a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.
Params:
  • map – a map from which we will try to extract an iterable yielding a (fast) bidirectional iterator on the entry set.
Returns:an iterable yielding a bidirectional iterator on the entry set of the given map that will be fast, if possible.
Since:8.0.0
/** * 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<Double2ShortMap.Entry> fastIterable(Double2ShortSortedMap map) { final ObjectSortedSet<Double2ShortMap.Entry> entries = map.double2ShortEntrySet(); return entries instanceof Double2ShortSortedMap.FastSortedEntrySet ? ((Double2ShortSortedMap.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.

/** * An immutable class representing an empty type-specific sorted map. * * <p> * This class may be useful to implement your own in case you subclass a * type-specific sorted map. */
public static class EmptySortedMap extends Double2ShortMaps.EmptyMap implements Double2ShortSortedMap, java.io.Serializable, Cloneable { private static final long serialVersionUID = -7046029254386353129L; protected EmptySortedMap() { } @Override public DoubleComparator comparator() { return null; } @SuppressWarnings("unchecked") @Override public ObjectSortedSet<Double2ShortMap.Entry> double2ShortEntrySet() { return ObjectSortedSets.EMPTY_SET; }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override @SuppressWarnings("unchecked") public ObjectSortedSet<Map.Entry<Double, Short>> entrySet() { return ObjectSortedSets.EMPTY_SET; } @Override public DoubleSortedSet keySet() { return DoubleSortedSets.EMPTY_SET; } @Override public Double2ShortSortedMap subMap(final double from, final double to) { return EMPTY_MAP; } @Override public Double2ShortSortedMap headMap(final double to) { return EMPTY_MAP; } @Override public Double2ShortSortedMap tailMap(final double from) { return EMPTY_MAP; } @Override public double firstDoubleKey() { throw new NoSuchElementException(); } @Override public double lastDoubleKey() { throw new NoSuchElementException(); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap headMap(Double oto) { return headMap((oto).doubleValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap tailMap(Double ofrom) { return tailMap((ofrom).doubleValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap subMap(Double ofrom, Double oto) { return subMap((ofrom).doubleValue(), (oto).doubleValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double firstKey() { return Double.valueOf(firstDoubleKey()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double lastKey() { return Double.valueOf(lastDoubleKey()); } }
An empty sorted map (immutable). It is serializable and cloneable.
/** * 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.

/** * An immutable class representing a type-specific singleton sorted map. * * <p> * This class may be useful to implement your own in case you subclass a * type-specific sorted map. */
public static class Singleton extends Double2ShortMaps.Singleton implements Double2ShortSortedMap, java.io.Serializable, Cloneable { private static final long serialVersionUID = -7046029254386353129L; protected final DoubleComparator comparator; protected Singleton(final double key, final short value, DoubleComparator comparator) { super(key, value); this.comparator = comparator; } protected Singleton(final double key, final short value) { this(key, value, null); } final int compare(final double k1, final double k2) { return comparator == null ? (Double.compare((k1), (k2))) : comparator.compare(k1, k2); } @Override public DoubleComparator comparator() { return comparator; } @Override public ObjectSortedSet<Double2ShortMap.Entry> double2ShortEntrySet() { if (entries == null) entries = ObjectSortedSets.singleton(new AbstractDouble2ShortMap.BasicEntry(key, value), entryComparator(comparator)); return (ObjectSortedSet<Double2ShortMap.Entry>) entries; }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override @SuppressWarnings({"rawtypes", "unchecked"}) public ObjectSortedSet<Map.Entry<Double, Short>> entrySet() { return (ObjectSortedSet) double2ShortEntrySet(); } @Override public DoubleSortedSet keySet() { if (keys == null) keys = DoubleSortedSets.singleton(key, comparator); return (DoubleSortedSet) keys; } @Override public Double2ShortSortedMap subMap(final double from, final double to) { if (compare(from, key) <= 0 && compare(key, to) < 0) return this; return EMPTY_MAP; } @Override public Double2ShortSortedMap headMap(final double to) { if (compare(key, to) < 0) return this; return EMPTY_MAP; } @Override public Double2ShortSortedMap tailMap(final double from) { if (compare(from, key) <= 0) return this; return EMPTY_MAP; } @Override public double firstDoubleKey() { return key; } @Override public double lastDoubleKey() { return key; }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap headMap(Double oto) { return headMap((oto).doubleValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap tailMap(Double ofrom) { return tailMap((ofrom).doubleValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap subMap(Double ofrom, Double oto) { return subMap((ofrom).doubleValue(), (oto).doubleValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double firstKey() { return Double.valueOf(firstDoubleKey()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double lastKey() { return Double.valueOf(lastDoubleKey()); } }
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.

Params:
  • key – the only key of the returned sorted map.
  • value – the only value of the returned sorted map.
Returns:a type-specific immutable sorted map containing just the pair &lt;key,value&gt;.
/** * Returns a type-specific immutable sorted map containing only the specified * pair. The returned sorted map is serializable and cloneable. * * <p> * 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 &lt;key,value&gt;}. */
public static Double2ShortSortedMap singleton(final Double key, Short value) { return new Singleton((key).doubleValue(), (value).shortValue()); }
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.

Params:
  • key – the only key of the returned sorted map.
  • value – the only value of the returned sorted map.
  • comparator – the comparator to use in the returned sorted map.
Returns:a type-specific immutable sorted map containing just the pair &lt;key,value&gt;.
/** * RETURNS a type-specific immutable sorted map containing only the specified * pair. The returned sorted map is serializable and cloneable. * * <p> * 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 &lt;key,value&gt;}. */
public static Double2ShortSortedMap singleton(final Double key, Short value, DoubleComparator comparator) { return new Singleton((key).doubleValue(), (value).shortValue(), 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.

Params:
  • key – the only key of the returned sorted map.
  • value – the only value of the returned sorted map.
Returns:a type-specific immutable sorted map containing just the pair &lt;key,value&gt;.
/** * Returns a type-specific immutable sorted map containing only the specified * pair. The returned sorted map is serializable and cloneable. * * <p> * 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 &lt;key,value&gt;}. */
public static Double2ShortSortedMap singleton(final double key, final short 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.

Params:
  • key – the only key of the returned sorted map.
  • value – the only value of the returned sorted map.
  • comparator – the comparator to use in the returned sorted map.
Returns:a type-specific immutable sorted map containing just the pair &lt;key,value&gt;.
/** * Returns a type-specific immutable sorted map containing only the specified * pair. The returned sorted map is serializable and cloneable. * * <p> * 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 &lt;key,value&gt;}. */
public static Double2ShortSortedMap singleton(final double key, final short value, DoubleComparator comparator) { return new Singleton(key, value, comparator); }
A synchronized wrapper class for sorted maps.
/** A synchronized wrapper class for sorted maps. */
public static class SynchronizedSortedMap extends Double2ShortMaps.SynchronizedMap implements Double2ShortSortedMap, java.io.Serializable { private static final long serialVersionUID = -7046029254386353129L; protected final Double2ShortSortedMap sortedMap; protected SynchronizedSortedMap(final Double2ShortSortedMap m, final Object sync) { super(m, sync); sortedMap = m; } protected SynchronizedSortedMap(final Double2ShortSortedMap m) { super(m); sortedMap = m; } @Override public DoubleComparator comparator() { synchronized (sync) { return sortedMap.comparator(); } } @Override public ObjectSortedSet<Double2ShortMap.Entry> double2ShortEntrySet() { if (entries == null) entries = ObjectSortedSets.synchronize(sortedMap.double2ShortEntrySet(), sync); return (ObjectSortedSet<Double2ShortMap.Entry>) entries; }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override @SuppressWarnings({"rawtypes", "unchecked"}) public ObjectSortedSet<Map.Entry<Double, Short>> entrySet() { return (ObjectSortedSet) double2ShortEntrySet(); } @Override public DoubleSortedSet keySet() { if (keys == null) keys = DoubleSortedSets.synchronize(sortedMap.keySet(), sync); return (DoubleSortedSet) keys; } @Override public Double2ShortSortedMap subMap(final double from, final double to) { return new SynchronizedSortedMap(sortedMap.subMap(from, to), sync); } @Override public Double2ShortSortedMap headMap(final double to) { return new SynchronizedSortedMap(sortedMap.headMap(to), sync); } @Override public Double2ShortSortedMap tailMap(final double from) { return new SynchronizedSortedMap(sortedMap.tailMap(from), sync); } @Override public double firstDoubleKey() { synchronized (sync) { return sortedMap.firstDoubleKey(); } } @Override public double lastDoubleKey() { synchronized (sync) { return sortedMap.lastDoubleKey(); } }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double firstKey() { synchronized (sync) { return sortedMap.firstKey(); } }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double lastKey() { synchronized (sync) { return sortedMap.lastKey(); } }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap subMap(final Double from, final Double to) { return new SynchronizedSortedMap(sortedMap.subMap(from, to), sync); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap headMap(final Double to) { return new SynchronizedSortedMap(sortedMap.headMap(to), sync); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap tailMap(final Double from) { return new SynchronizedSortedMap(sortedMap.tailMap(from), sync); } }
Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.
Params:
  • m – the sorted map to be wrapped in a synchronized sorted map.
See Also:
Returns:a synchronized view of the specified sorted map.
/** * 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 Double2ShortSortedMap synchronize(final Double2ShortSortedMap 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.
Params:
  • m – the sorted map to be wrapped in a synchronized sorted map.
  • sync – an object that will be used to synchronize the access to the sorted sorted map.
See Also:
Returns:a synchronized view of the specified sorted map.
/** * 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 Double2ShortSortedMap synchronize(final Double2ShortSortedMap m, final Object sync) { return new SynchronizedSortedMap(m, sync); }
An unmodifiable wrapper class for sorted maps.
/** An unmodifiable wrapper class for sorted maps. */
public static class UnmodifiableSortedMap extends Double2ShortMaps.UnmodifiableMap implements Double2ShortSortedMap, java.io.Serializable { private static final long serialVersionUID = -7046029254386353129L; protected final Double2ShortSortedMap sortedMap; protected UnmodifiableSortedMap(final Double2ShortSortedMap m) { super(m); sortedMap = m; } @Override public DoubleComparator comparator() { return sortedMap.comparator(); } @Override public ObjectSortedSet<Double2ShortMap.Entry> double2ShortEntrySet() { if (entries == null) entries = ObjectSortedSets.unmodifiable(sortedMap.double2ShortEntrySet()); return (ObjectSortedSet<Double2ShortMap.Entry>) entries; }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override @SuppressWarnings({"rawtypes", "unchecked"}) public ObjectSortedSet<Map.Entry<Double, Short>> entrySet() { return (ObjectSortedSet) double2ShortEntrySet(); } @Override public DoubleSortedSet keySet() { if (keys == null) keys = DoubleSortedSets.unmodifiable(sortedMap.keySet()); return (DoubleSortedSet) keys; } @Override public Double2ShortSortedMap subMap(final double from, final double to) { return new UnmodifiableSortedMap(sortedMap.subMap(from, to)); } @Override public Double2ShortSortedMap headMap(final double to) { return new UnmodifiableSortedMap(sortedMap.headMap(to)); } @Override public Double2ShortSortedMap tailMap(final double from) { return new UnmodifiableSortedMap(sortedMap.tailMap(from)); } @Override public double firstDoubleKey() { return sortedMap.firstDoubleKey(); } @Override public double lastDoubleKey() { return sortedMap.lastDoubleKey(); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double firstKey() { return sortedMap.firstKey(); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double lastKey() { return sortedMap.lastKey(); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap subMap(final Double from, final Double to) { return new UnmodifiableSortedMap(sortedMap.subMap(from, to)); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap headMap(final Double to) { return new UnmodifiableSortedMap(sortedMap.headMap(to)); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Double2ShortSortedMap tailMap(final Double from) { return new UnmodifiableSortedMap(sortedMap.tailMap(from)); } }
Returns an unmodifiable type-specific sorted map backed by the given type-specific sorted map.
Params:
  • m – the sorted map to be wrapped in an unmodifiable sorted map.
See Also:
Returns:an unmodifiable view of the specified sorted map.
/** * 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 Double2ShortSortedMap unmodifiable(final Double2ShortSortedMap m) { return new UnmodifiableSortedMap(m); } }