aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firestore/third_party/Immutable/FSTImmutableSortedSet.h
blob: b432f98f57affef2f2f874c508c2888e2f66e33d (plain)
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
#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

/**
 * FSTImmutableSortedSet is a set. It is immutable, but has methods to create new sets that are
 * mutations of it, in an efficient way.
 */
@interface FSTImmutableSortedSet <KeyType> : NSObject

+ (FSTImmutableSortedSet<KeyType> *)setWithComparator:(NSComparator)comparator;

+ (FSTImmutableSortedSet<KeyType> *)setWithKeysFromDictionary:(NSDictionary<KeyType, id> *)array
                                                   comparator:(NSComparator)comparator;

- (BOOL)containsObject:(KeyType)object;

- (FSTImmutableSortedSet<KeyType> *)setByAddingObject:(KeyType)object;
- (FSTImmutableSortedSet<KeyType> *)setByRemovingObject:(KeyType)object;

- (KeyType)firstObject;
- (KeyType)lastObject;
- (NSUInteger)count;
- (BOOL)isEmpty;

/**
 * Returns the index of the object or NSNotFound if the object is not found.
 *
 * @param object The object to return the index for.
 * @return The index of the object, or NSNotFound if not found.
 */
- (NSUInteger)indexOfObject:(KeyType)object;

- (void)enumerateObjectsUsingBlock:(void (^)(KeyType obj, BOOL *stop))block;
- (void)enumerateObjectsFrom:(KeyType)start
                          to:(_Nullable KeyType)end
                  usingBlock:(void (^)(KeyType obj, BOOL *stop))block;
- (void)enumerateObjectsReverse:(BOOL)reverse usingBlock:(void (^)(KeyType obj, BOOL *stop))block;

- (NSEnumerator<KeyType> *)objectEnumerator;
- (NSEnumerator<KeyType> *)objectEnumeratorFrom:(KeyType)startKey;

@end

NS_ASSUME_NONNULL_END