/*
	* 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.objects;
import it.unimi.dsi.fastutil.objects.ReferenceCollection;
import it.unimi.dsi.fastutil.objects.ObjectSortedSet;
import it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator;
import java.util.Map;
import java.util.SortedMap;
import java.util.Comparator;
A type-specific SortedMap; provides some additional methods that use polymorphism to avoid (un)boxing. 
 Additionally, this interface strengthens entrySet(), keySet(), values(), comparator(), SortedMap.subMap(Object, Object), SortedMap.headMap(Object) and SortedMap.tailMap(Object). 
See Also:
SortedMap/**
 * A type-specific {@link SortedMap}; provides some additional methods that use
 * polymorphism to avoid (un)boxing.
 *
 * <p>
 * Additionally, this interface strengthens {@link #entrySet()},
 * {@link #keySet()}, {@link #values()}, {@link #comparator()},
 * {@link SortedMap#subMap(Object,Object)}, {@link SortedMap#headMap(Object)}
 * and {@link SortedMap#tailMap(Object)}.
 *
 * @see SortedMap
 */
public interface Reference2ReferenceSortedMap<K, V> extends Reference2ReferenceMap<K, V>, SortedMap<K, V> {
	
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive. 
 Note that this specification strengthens the one given in SortedMap.subMap(Object, Object). 
See Also:
SortedMap.subMap(Object, Object)/**
	 * Returns a view of the portion of this sorted map whose keys range from
	 * {@code fromKey}, inclusive, to {@code toKey}, exclusive.
	 *
	 * <p>
	 * Note that this specification strengthens the one given in
	 * {@link SortedMap#subMap(Object,Object)}.
	 *
	 * @see SortedMap#subMap(Object,Object)
	 */
	@Override
	Reference2ReferenceSortedMap<K, V> subMap(K fromKey, K toKey);
	
Returns a view of the portion of this sorted map whose keys are strictly less than toKey. 
 Note that this specification strengthens the one given in SortedMap.headMap(Object). 
See Also:
SortedMap.headMap(Object)/**
	 * Returns a view of the portion of this sorted map whose keys are strictly less
	 * than {@code toKey}.
	 *
	 * <p>
	 * Note that this specification strengthens the one given in
	 * {@link SortedMap#headMap(Object)}.
	 *
	 * @see SortedMap#headMap(Object)
	 */
	@Override
	Reference2ReferenceSortedMap<K, V> headMap(K toKey);
	
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey. 
 Note that this specification strengthens the one given in SortedMap.tailMap(Object). 
See Also:
SortedMap.tailMap(Object)/**
	 * Returns a view of the portion of this sorted map whose keys are greater than
	 * or equal to {@code fromKey}.
	 *
	 * <p>
	 * Note that this specification strengthens the one given in
	 * {@link SortedMap#tailMap(Object)}.
	 *
	 * @see SortedMap#tailMap(Object)
	 */
	@Override
	Reference2ReferenceSortedMap<K, V> tailMap(K fromKey);
	
A sorted entry set providing fast iteration.
 In some cases (e.g., hash-based classes) iteration over an entry set requires the creation of a large number of entry objects. Some fastutil maps might return entry set objects of type FastSortedEntrySet: in this case, 
fastIterator() will return an iterator that is guaranteed not to create a large number of objects, possibly by returning always the same entry
(of course, mutated).
/**
	 * A sorted entry set providing fast iteration.
	 *
	 * <p>
	 * In some cases (e.g., hash-based classes) iteration over an entry set requires
	 * the creation of a large number of entry objects. Some {@code fastutil} maps
	 * might return {@linkplain #entrySet() entry set} objects of type
	 * {@code FastSortedEntrySet}: in this case, {@link #fastIterator()
	 * fastIterator()} will return an iterator that is guaranteed not to create a
	 * large number of objects, <em>possibly by returning always the same entry</em>
	 * (of course, mutated).
	 */
	interface FastSortedEntrySet<K, V> extends ObjectSortedSet<Reference2ReferenceMap.Entry<K, V>>, FastEntrySet<K, V> {
		
{@inheritDoc}
/**
		 * {@inheritDoc}
		 */
		@Override
		ObjectBidirectionalIterator<Reference2ReferenceMap.Entry<K, V>> fastIterator();
		
Returns a fast iterator over this entry set, starting from a given element of
the domain (optional operation); the iterator might return always the same
entry instance, suitably mutated.
Params:
from – 
           an element to start from.
Returns:
a fast iterator over this sorted entry set starting at from; the iterator might return always the same entry object, suitably mutated./**
		 * Returns a fast iterator over this entry set, starting from a given element of
		 * the domain (optional operation); the iterator might return always the same
		 * entry instance, suitably mutated.
		 *
		 * @param from
		 *            an element to start from.
		 * @return a fast iterator over this sorted entry set starting at {@code from};
		 *         the iterator might return always the same entry object, suitably
		 *         mutated.
		 */
		ObjectBidirectionalIterator<Reference2ReferenceMap.Entry<K, V>> fastIterator(
				Reference2ReferenceMap.Entry<K, V> from);
	}
	
Returns a sorted-set view of the mappings contained in this map.

Note that this specification strengthens the one given in the corresponding
type-specific unsorted map.
See Also:
Map.entrySet()
Returns:
a sorted-set view of the mappings contained in this map./**
	 * Returns a sorted-set view of the mappings contained in this map.
	 * <p>
	 * Note that this specification strengthens the one given in the corresponding
	 * type-specific unsorted map.
	 *
	 * @return a sorted-set view of the mappings contained in this map.
	 * @see Map#entrySet()
	 */
	@SuppressWarnings({"unchecked", "rawtypes"})
	@Override
	default ObjectSortedSet<Map.Entry<K, V>> entrySet() {
		return (ObjectSortedSet) reference2ReferenceEntrySet();
	}
	
Returns a type-specific sorted-set view of the mappings contained in this
map.

Note that this specification strengthens the one given in the corresponding
type-specific unsorted map.
See Also:
entrySet()
Returns:
a type-specific sorted-set view of the mappings contained in this
        map./**
	 * Returns a type-specific sorted-set view of the mappings contained in this
	 * map.
	 * <p>
	 * Note that this specification strengthens the one given in the corresponding
	 * type-specific unsorted map.
	 *
	 * @return a type-specific sorted-set view of the mappings contained in this
	 *         map.
	 * @see #entrySet()
	 */
	@Override
	ObjectSortedSet<Reference2ReferenceMap.Entry<K, V>> reference2ReferenceEntrySet();
	
Returns a type-specific sorted-set view of the keys contained in this map.

Note that this specification strengthens the one given in the corresponding
type-specific unsorted map.
See Also:
SortedMap.keySet()
Returns:
a sorted-set view of the keys contained in this map./**
	 * Returns a type-specific sorted-set view of the keys contained in this map.
	 * <p>
	 * Note that this specification strengthens the one given in the corresponding
	 * type-specific unsorted map.
	 *
	 * @return a sorted-set view of the keys contained in this map.
	 * @see SortedMap#keySet()
	 */
	@Override
	ReferenceSortedSet<K> keySet();
	
Returns a type-specific set view of the values contained in this map.
 Note that this specification strengthens the one given in Map.values(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends SortedMap. 
See Also:
SortedMap.values()
Returns:
a set view of the values contained in this map./**
	 * Returns a type-specific set view of the values contained in this map.
	 * <p>
	 * Note that this specification strengthens the one given in
	 * {@link Map#values()}, which was already strengthened in the corresponding
	 * type-specific class, but was weakened by the fact that this interface extends
	 * {@link SortedMap}.
	 *
	 * @return a set view of the values contained in this map.
	 * @see SortedMap#values()
	 */
	@Override
	ReferenceCollection<V> values();
	
Returns the comparator associated with this sorted set, or null if it uses
its keys' natural ordering.
 Note that this specification strengthens the one given in SortedMap.comparator(). 
See Also:
SortedMap.comparator()/**
	 * Returns the comparator associated with this sorted set, or null if it uses
	 * its keys' natural ordering.
	 *
	 * <p>
	 * Note that this specification strengthens the one given in
	 * {@link SortedMap#comparator()}.
	 *
	 * @see SortedMap#comparator()
	 */
	@Override
	Comparator<? super K> comparator();
}