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
|
/*
* 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 java.util.SortedSet;
import java.util.Collection;
/** A type-specific {@link SortedSet}; provides some additional methods that use polymorphism to avoid (un)boxing.
*
* <P>Additionally, this interface strengthens {@link #iterator()},
* {@link #comparator()} (for primitive types), {@link SortedSet#subSet(Object,Object)},
* {@link SortedSet#headSet(Object)} and {@link SortedSet#tailSet(Object)}.
*
* @see SortedSet
*/
public interface SORTED_SET KEY_GENERIC extends SET KEY_GENERIC, SortedSet<KEY_GENERIC_CLASS> {
/** Returns a type-specific {@link it.unimi.dsi.fastutil.BidirectionalIterator} on the elements in
* this set, starting from a given element of the domain (optional operation).
*
* <P>This method returns a type-specific bidirectional iterator with given
* starting point. The starting point is any element comparable to the
* elements of this set (even if it does not actually belong to the
* set). The next element of the returned iterator is the least element of
* the set that is greater than the starting point (if there are no
* elements greater than the starting point, {@link
* it.unimi.dsi.fastutil.BidirectionalIterator#hasNext() hasNext()} will return
* <code>false</code>). The previous element of the returned iterator is
* the greatest element of the set that is smaller than or equal to the
* starting point (if there are no elements smaller than or equal to the
* starting point, {@link it.unimi.dsi.fastutil.BidirectionalIterator#hasPrevious()
* hasPrevious()} will return <code>false</code>).
*
* <P>Note that passing the last element of the set as starting point and
* calling {@link it.unimi.dsi.fastutil.BidirectionalIterator#previous() previous()} you can traverse the
* entire set in reverse order.
*
* @param fromElement an element to start from.
* @return a bidirectional iterator on the element in this set, starting at the given element.
* @throws UnsupportedOperationException if this set does not support iterators with a starting point.
*/
KEY_BIDI_ITERATOR KEY_GENERIC iterator( KEY_GENERIC_TYPE fromElement );
/** Returns a type-specific {@link it.unimi.dsi.fastutil.BidirectionalIterator} iterator on the collection.
*
* <P>The iterator returned by the {@link #iterator()} method and by this
* method are identical; however, using this method you can save a type casting.
*
* Note that this specification strengthens the one given in the corresponding type-specific
* {@link Collection}.
*
* @deprecated As of <code>fastutil</code> 5, replaced by {@link #iterator()}.
*/
@Deprecated
KEY_BIDI_ITERATOR KEY_GENERIC KEY_ITERATOR_METHOD();
/** Returns a type-specific {@link it.unimi.dsi.fastutil.BidirectionalIterator} on the elements in
* this set.
*
* <P>This method returns a parameterised bidirectional iterator. The iterator
* can be moreover safely cast to a type-specific iterator.
*
* Note that this specification strengthens the one given in the corresponding type-specific
* {@link Collection}.
*
* @return a bidirectional iterator on the element in this set.
*/
KEY_BIDI_ITERATOR KEY_GENERIC iterator();
/** Returns a view of the portion of this sorted set whose elements range from <code>fromElement</code>, inclusive, to <code>toElement</code>, exclusive.
*
* <P>Note that this specification strengthens the one given in {@link SortedSet#subSet(Object,Object)}.
*
* @see SortedSet#subSet(Object,Object)
*/
SORTED_SET KEY_GENERIC subSet( KEY_GENERIC_CLASS fromElement, KEY_GENERIC_CLASS toElement) ;
/** Returns a view of the portion of this sorted set whose elements are strictly less than <code>toElement</code>.
*
* <P>Note that this specification strengthens the one given in {@link SortedSet#headSet(Object)}.
*
* @see SortedSet#headSet(Object)
*/
SORTED_SET KEY_GENERIC headSet( KEY_GENERIC_CLASS toElement );
/** Returns a view of the portion of this sorted set whose elements are greater than or equal to <code>fromElement</code>.
*
* <P>Note that this specification strengthens the one given in {@link SortedSet#tailSet(Object)}.
*
* @see SortedSet#tailSet(Object)
*/
SORTED_SET KEY_GENERIC tailSet( KEY_GENERIC_CLASS fromElement );
#if #keys(primitive)
/** Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
*
* <P>Note that this specification strengthens the one given in {@link SortedSet#comparator()}.
*
* @see SortedSet#comparator()
*/
KEY_COMPARATOR comparator();
/**
* @see SortedSet#subSet(Object,Object)
*/
SORTED_SET subSet( KEY_TYPE fromElement, KEY_TYPE toElement) ;
/**
* @see SortedSet#headSet(Object)
*/
SORTED_SET headSet( KEY_TYPE toElement );
/**
* @see SortedSet#tailSet(Object)
*/
SORTED_SET tailSet( KEY_TYPE fromElement );
/**
* @see SortedSet#first()
*/
KEY_TYPE FIRST();
/**
* @see SortedSet#last()
*/
KEY_TYPE LAST();
#endif
}
|
