ObjFW
OFMutableSet.h
1 /*
2  * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
3  *
4  * All rights reserved.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License version 3.0 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
13  * version 3.0 for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * version 3.0 along with this program. If not, see
17  * <https://www.gnu.org/licenses/>.
18  */
19 
20 #import "OFSet.h"
21 
22 OF_ASSUME_NONNULL_BEGIN
23 
32 @interface OFMutableSet OF_GENERIC(ObjectType): OFSet OF_GENERIC(ObjectType)
33 #if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
34 # define ObjectType id
35 #endif
36 
43 + (instancetype)setWithCapacity: (size_t)capacity;
44 
50 - (instancetype)init OF_DESIGNATED_INITIALIZER;
51 
59 - (instancetype)initWithCapacity: (size_t)capacity OF_DESIGNATED_INITIALIZER;
60 
66 - (void)addObject: (ObjectType)object;
67 
73 - (void)removeObject: (ObjectType)object;
74 
80 - (void)minusSet: (OFSet OF_GENERIC(ObjectType) *)set;
81 
88 - (void)intersectSet: (OFSet OF_GENERIC(ObjectType) *)set;
89 
95 - (void)unionSet: (OFSet OF_GENERIC(ObjectType) *)set;
96 
100 - (void)removeAllObjects;
101 
105 - (void)makeImmutable;
106 #if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
107 # undef ObjectType
108 #endif
109 @end
110 
111 OF_ASSUME_NONNULL_END
An abstract class for a mutable unordered set of unique objects.
Definition: OFMutableSet.h:32
An abstract class for an unordered set of unique objects.
Definition: OFSet.h:68
instancetype init()
Initializes an already allocated OFMutableSet to be empty.
Definition: OFMutableSet.m:114
void removeAllObjects()
Removes all objects from the set.
Definition: OFMutableSet.m:191
void makeImmutable()
Converts the mutable set to an immutable set.
Definition: OFMutableSet.m:202