1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/*
* Copyright (C) 2002-2014 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 PACKAGE;
import VALUE_PACKAGE.VALUE_COLLECTION;
import it.unimi.dsi.fastutil.objects.ObjectSortedSet;
import it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator;
import java.util.Map;
import java.util.SortedMap;
#if #keys(reference)
import java.util.Comparator;
#endif
/** 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 SORTED_MAP KEY_VALUE_GENERIC extends MAP KEY_VALUE_GENERIC, SortedMap<KEY_GENERIC_CLASS, VALUE_GENERIC_CLASS> {
/** 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</code>
* maps might return {@linkplain #entrySet() entry set} objects of type <code>FastSortedEntrySet</code>: 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).
*/
public interface FastSortedEntrySet KEY_VALUE_GENERIC extends ObjectSortedSet<MAP.Entry KEY_VALUE_GENERIC>, FastEntrySet KEY_VALUE_GENERIC {
/** Returns a fast iterator over this sorted entry set; the iterator might return always the same entry object, suitably mutated.
*
* @return a fast iterator over this sorted entry set; the iterator might return always the same entry object, suitably mutated.
*/
public ObjectBidirectionalIterator<MAP.Entry KEY_VALUE_GENERIC> fastIterator( MAP.Entry KEY_VALUE_GENERIC 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.
*
* @return a sorted-set view of the mappings contained in this map.
* @see Map#entrySet()
*/
ObjectSortedSet<Map.Entry<KEY_GENERIC_CLASS, VALUE_GENERIC_CLASS>> entrySet();
/** 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.
*
* @return a type-specific sorted-set view of the mappings contained in this map.
* @see #entrySet()
*/
ObjectSortedSet<MAP.Entry KEY_VALUE_GENERIC> ENTRYSET();
/** Returns a 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.
*
* @return a sorted-set view of the keys contained in this map.
* @see Map#keySet()
*/
SORTED_SET KEY_GENERIC keySet();
/** Returns a 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 Map#values()
*/
VALUE_COLLECTION VALUE_GENERIC values();
/** 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()
*/
KEY_COMPARATOR KEY_SUPER_GENERIC comparator();
/** Returns a view of the portion of this sorted map whose keys range from <code>fromKey</code>, inclusive, to <code>toKey</code>, exclusive.
*
* <P>Note that this specification strengthens the one given in {@link SortedMap#subMap(Object,Object)}.
*
* @see SortedMap#subMap(Object,Object)
*/
SORTED_MAP KEY_VALUE_GENERIC subMap(KEY_GENERIC_CLASS fromKey, KEY_GENERIC_CLASS toKey);
/** Returns a view of the portion of this sorted map whose keys are strictly less than <code>toKey</code>.
*
* <P>Note that this specification strengthens the one given in {@link SortedMap#headMap(Object)}.
*
* @see SortedMap#headMap(Object)
*/
SORTED_MAP KEY_VALUE_GENERIC headMap(KEY_GENERIC_CLASS toKey);
/** Returns a view of the portion of this sorted map whose keys are greater than or equal to <code>fromKey</code>.
*
* <P>Note that this specification strengthens the one given in {@link SortedMap#tailMap(Object)}.
*
* @see SortedMap#tailMap(Object)
*/
SORTED_MAP KEY_VALUE_GENERIC tailMap(KEY_GENERIC_CLASS fromKey);
#if #keys(primitive)
/** Returns a view of the portion of this sorted map whose keys range from <code>fromKey</code>, inclusive, to <code>toKey</code>, exclusive.
* @see SortedMap#subMap(Object,Object)
*/
SORTED_MAP KEY_VALUE_GENERIC subMap(KEY_TYPE fromKey, KEY_TYPE toKey);
/** Returns a view of the portion of this sorted map whose keys are strictly less than <code>toKey</code>.
* @see SortedMap#headMap(Object)
*/
SORTED_MAP KEY_VALUE_GENERIC headMap(KEY_TYPE toKey);
/** Returns a view of the portion of this sorted map whose keys are greater than or equal to <code>fromKey</code>.
* @see SortedMap#tailMap(Object)
*/
SORTED_MAP KEY_VALUE_GENERIC tailMap(KEY_TYPE fromKey);
/**
* @see SortedMap#firstKey()
*/
KEY_TYPE FIRST_KEY();
/**
* @see SortedMap#lastKey()
*/
KEY_TYPE LAST_KEY();
#endif
}
|
