An abstract class for an unordered set of unique objects. More...

#import <ObjFW/OFSet.h>

Inheritance diagram for OFSet:

Instance Methods
(id)	- initWithSet:
	Initializes an already allocated set with the specified set. More...

(id)	- initWithArray:
	Initializes an already allocated set with the specified array. More...

(id)	- initWithObjects:
	Initializes an already allocated set with the specified objects. More...

(id)	- initWithObjects:count:
	Initializes an already allocated set with the specified objects. More...

(id)	- initWithObject:arguments:
	Initializes an already allocated set with the specified object and va_list. More...

(bool)	- isSubsetOfSet:
	Returns whether the receiver is a subset of the specified set. More...

(bool)	- intersectsSet:
	Returns whether the receiver and the specified set have at least one object in common. More...

(OFSet *)	- setBySubtractingSet:
	Creates a new set which contains the objects which are in the receiver, but not in the specified set. More...

(OFSet *)	- setByIntersectingWithSet:
	Creates a new set by creating the intersection of the receiver and the specified set. More...

(OFSet *)	- setByAddingSet:
	Creates a new set by creating the union of the receiver and the specified set. More...

(OFArray *)	- allObjects
	Returns an array of all objects in the set. More...

(nullable ObjectType)	- anyObject
	Returns an arbitrary object in the set. More...

(bool)	- containsObject:
	Checks whether the set contains an object equal to the specified object. More...

(nullable id)	- valueForKey:
	Returns the value for the specified key. More...

(void)	- setValue:forKey:
	Set the value for the specified key. More...

(OFEnumerator *)	- objectEnumerator
	Returns an OFEnumerator to enumerate through all objects of the set. More...

(void)	- enumerateObjectsUsingBlock:
	Executes a block for each object in the set. More...

(OFSet *)	- filteredSetUsingBlock:
	Creates a new set, only containing the objects for which the block returns true. More...

Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object. More...

(OFString *)	- className
	Returns the name of the object's class. More...

(OFString *)	- description
	Returns a description for the object. More...

(nullable void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool. More...

(nullable void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool. More...

(nullable void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size. More...

(nullable void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size. More...

(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool. More...

(void)	- dealloc
	Deallocates the object. More...

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay. More...

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay. More...

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay. More...

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread. More...

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object. More...

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects. More...

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread. More...

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object. More...

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects. More...

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay. More...

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay. More...

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay. More...

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. More...

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver. More...

(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver. More...

Instance Methods inherited from <OFObject>
(bool)	- isKindOfClass:
	Returns a boolean whether the object of the specified kind. More...

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class. More...

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector. More...

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector. More...

(nullable const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector. More...

(nullable id)	- performSelector:
	Performs the specified selector. More...

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object. More...

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects. More...

(bool)	- isEqual:
	Checks two objects for equality. More...

(uint32_t)	- hash
	Calculates a hash for the object. More...

(id)	- retain
	Increases the retain count. More...

(unsigned int)	- retainCount
	Returns the retain count. More...

(void)	- release
	Decreases the retain count. More...

(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...

(id)	- self
	Returns the receiver. More...

(bool)	- isProxy
	Returns whether the object is a proxy object. More...

(bool)	- allowsWeakReference
	Returns whether the class allows weak references. More...

(bool)	- retainWeakReference
	Retain a weak reference to this object. More...

Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object. More...

Instance Methods inherited from <OFMutableCopying>
(id)	- mutableCopy
	Creates a mutable copy of the object. More...

Instance Methods inherited from <OFSerialization>
(id)	- initWithSerialization:
	Initializes the object with the specified XML element serialization. More...

(OFXMLElement *)	- XMLElementBySerializing
	Serializes the object into an XML element. More...

Class Methods
(instancetype)	+ set
	Creates a new set. More...

(instancetype)	+ setWithSet:
	Creates a new set with the specified set. More...

(instancetype)	+ setWithArray:
	Creates a new set with the specified array. More...

(instancetype)	+ setWithObjects:
	Creates a new set with the specified objects. More...

(instancetype)	+ setWithObjects:count:
	Creates a new set with the specified objects. More...

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime. More...

(void)	+ unload
	A method which is called when the class is unloaded from the runtime. More...

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made. More...

(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object. More...

(id)	+ new
	Allocates memory for a new instance and calls init on it. More...

(Class)	+ class
	Returns the class. More...

(OFString *)	+ className
	Returns the name of the class as a string. More...

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class. More...

(nullable Class)	+ superclass
	Returns the superclass of the class. More...

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector. More...

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol. More...

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector. More...

(nullable const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector. More...

(OFString *)	+ description
	Returns a description for the class, which is usually the class name. More...

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class. More...

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class. More...

(nullable IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method. More...

(nullable IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method. More...

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver. More...

(BOOL)	+ resolveClassMethod:
	Try to resolve the specified class method. More...

(BOOL)	+ resolveInstanceMethod:
	Try to resolve the specified instance method. More...

(id)	+ copy
	Returns the class. More...

Detailed Description

An abstract class for an unordered set of unique objects.

Warning: Do not mutate objects that are in a set! Changing the hash of objects in a set breaks the internal representation of the set!

Method Documentation

◆ allObjects()

- (OFArray *) allObjects

Returns an array of all objects in the set.

Returns: An array of all objects in the set

◆ anyObject()

- (id) anyObject

Returns an arbitrary object in the set.

Returns: An arbitrary object in the set

◆ containsObject:()

- (bool) containsObject: (ObjectType) object

Checks whether the set contains an object equal to the specified object.

Parameters

object The object which is checked for being in the set

Returns: A boolean whether the set contains the specified object

◆ enumerateObjectsUsingBlock:()

- (void) enumerateObjectsUsingBlock: (of_set_enumeration_block_t) block

Executes a block for each object in the set.

Parameters

block The block to execute for each object in the set

◆ filteredSetUsingBlock:()

- (OFSet *) filteredSetUsingBlock: (of_set_filter_block_t) block

Creates a new set, only containing the objects for which the block returns true.

Parameters

block A block which determines if the object should be in the new set

Returns: A new, autoreleased OFSet

◆ initWithArray:()

- (id) initWithArray: (OFArray *) array

Initializes an already allocated set with the specified array.

Parameters

array The array to initialize the set with

Returns: An initialized set with the specified array

◆ initWithObject:arguments:()

- (id) initWithObject:	(ObjectType)	firstObject
arguments:	(va_list)	arguments

Initializes an already allocated set with the specified object and va_list.

Parameters

firstObject	The first object for the set
arguments	A va_list with the other objects

Returns: An initialized set with the specified object and va_list

◆ initWithObjects:()

- (id) initWithObjects:	(ObjectType)	firstObject
,		...

Initializes an already allocated set with the specified objects.

Parameters

firstObject The first object for the set

Returns: An initialized set with the specified objects

◆ initWithObjects:count:()

- (id) initWithObjects:	(ObjectType const _Nonnull *_Nonnull)	objects
count:	(size_t)	count

Initializes an already allocated set with the specified objects.

Parameters

objects	An array of objects for the set
count	The number of objects in the specified array

Returns: An initialized set with the specified objects

◆ initWithSet:()

- (id) initWithSet: (OFSet *) set

Initializes an already allocated set with the specified set.

Parameters

set	The set to initialize the set with

Returns: An initialized set with the specified set

◆ intersectsSet:()

- (bool) intersectsSet: (OFSet *) set

Returns whether the receiver and the specified set have at least one object in common.

Returns: Whether the receiver and the specified set have at least one object in common

◆ isSubsetOfSet:()

- (bool) isSubsetOfSet: (OFSet *) set

Returns whether the receiver is a subset of the specified set.

Returns: Whether the receiver is a subset of the specified set

◆ objectEnumerator()

- (OFEnumerator *) objectEnumerator

Returns an OFEnumerator to enumerate through all objects of the set.

Returns: An OFEnumerator to enumerate through all objects of the set

◆ set()

+ (instancetype) set

Creates a new set.

Returns: A new, autoreleased set

◆ setByAddingSet:()

- (OFSet *) setByAddingSet: (OFSet *) set

Creates a new set by creating the union of the receiver and the specified set.

Parameters

set	The set to create the union with

◆ setByIntersectingWithSet:()

- (OFSet *) setByIntersectingWithSet: (OFSet *) set

Creates a new set by creating the intersection of the receiver and the specified set.

Parameters

set	The set to intersect with

◆ setBySubtractingSet:()

- (OFSet *) setBySubtractingSet: (OFSet *) set

Creates a new set which contains the objects which are in the receiver, but not in the specified set.

Parameters

set	The set whose objects will not be in the new set

◆ setValue:forKey:()

- (void) setValue:	(id)	value
forKey:	(OFString *)	key

Set the value for the specified key.

If the key starts with an @, the @ is stripped and [super setValue:forKey:] is called. If the key does not start with an @, setValue:forKey: is called for each object.

Note: A OFNull value is translated to nil!

Parameters

value	The value for the specified key
key	The key of the value to set

◆ setWithArray:()

+ (instancetype) setWithArray: (OFArray *) array

Creates a new set with the specified array.

Parameters

array The array to initialize the set with

Returns: A new, autoreleased set with the specified array

◆ setWithObjects:()

+ (instancetype) setWithObjects:	(ObjectType)	firstObject
,		...

Creates a new set with the specified objects.

Parameters

firstObject The first object for the set

Returns: A new, autoreleased set with the specified objects

◆ setWithObjects:count:()

+ (instancetype) setWithObjects:	(ObjectType const _Nonnull *_Nonnull)	objects
count:	(size_t)	count

Creates a new set with the specified objects.

Parameters

objects	An array of objects for the set
count	The number of objects in the specified array

Returns: A new, autoreleased set with the specified objects

◆ setWithSet:()

+ (instancetype) setWithSet: (OFSet *) set

Creates a new set with the specified set.

Parameters

set	The set to initialize the set with

Returns: A new, autoreleased set with the specified set

◆ valueForKey:()

- (id) valueForKey: (OFString *) key

Returns the value for the specified key.

If the key starts with an @, the @ is stripped and [super valueForKey:] is called. If the key does not start with an @, a new set with the value for the specified key for each object is returned.

Note: Unlike with OFArray, any nil values are removed!

Parameters

key	The key of the value to return

Returns: The value for the specified key

The documentation for this class was generated from the following files:

src/OFSet.h
src/OFSet.m

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ allObjects()

◆ anyObject()

◆ containsObject:()

◆ enumerateObjectsUsingBlock:()

◆ filteredSetUsingBlock:()

◆ initWithArray:()

◆ initWithObject:arguments:()

◆ initWithObjects:()

◆ initWithObjects:count:()

◆ initWithSet:()

◆ intersectsSet:()

◆ isSubsetOfSet:()

◆ objectEnumerator()

◆ set()

◆ setByAddingSet:()

◆ setByIntersectingWithSet:()

◆ setBySubtractingSet:()

◆ setValue:forKey:()

◆ setWithArray:()

◆ setWithObjects:()

◆ setWithObjects:count:()

◆ setWithSet:()

◆ valueForKey:()