OFSet Class Reference

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

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFSet:

Instance Methods
(instancetype)	- init
	Initializes an already allocated set to be empty.
(instancetype)	- initWithSet:
	Initializes an already allocated set with the specified set.
(instancetype)	- initWithArray:
	Initializes an already allocated set with the specified array.
(instancetype)	- initWithObjects:
	Initializes an already allocated set with the specified objects.
(instancetype)	- initWithObject:arguments:
	Initializes an already allocated set with the specified object and va_list.
(instancetype)	- initWithObjects:count:
	Initializes an already allocated set with the specified objects.
(OFEnumerator *)	- objectEnumerator
	Returns an OFEnumerator to enumerate through all objects of the set.
(bool)	- isSubsetOfSet:
	Returns whether the receiver is a subset of the specified set.
(bool)	- intersectsSet:
	Returns whether the receiver and the specified set have at least one object in common.
(OFSet *)	- setByAddingObjectsFromSet:
	Creates a new set by creating the union of the receiver and the specified set.
(bool)	- containsObject:
	Checks whether the set contains an object equal to the specified object.
(nullable id)	- valueForKey:
	Returns the value for the specified key.
(void)	- setValue:forKey:
	Set the value for the specified key.
(void)	- enumerateObjectsUsingBlock:
	Executes a block for each object in the set.
(OFSet *)	- filteredSetUsingBlock:
	Creates a new set, only containing the objects for which the block returns true.
Instance Methods inherited from OFObject
(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.
(void)	- dealloc
	Deallocates the object.
(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.
(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.
(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.
(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.
(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.
(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.
(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.
(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(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.
(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.
Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.
(unsigned int)	- retainCount
	Returns the retain count.
(bool)	- isProxy
	Returns whether the object is a proxy object.
(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.
(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.
(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.
(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.
(nullable id)	- performSelector:
	Performs the specified selector.
(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.
(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.
(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.
(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.
(bool)	- isEqual:
	Checks two objects for equality.
(instancetype)	- retain
	Increases the retain count.
(void)	- release
	Decreases the retain count.
(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.
(instancetype)	- self
	Returns the receiver.
(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.
(bool)	- retainWeakReference
	Retain a weak reference to this object.
Instance Methods inherited from <OFCollection>
(bool)	- containsObject:
	Checks whether the collection contains an object equal to the specified object.
Instance Methods inherited from <OFEnumeration>
Instance Methods inherited from <OFFastEnumeration>
(int)	- countByEnumeratingWithState:objects:count:
	A method which is called by the code produced by the compiler when doing a fast enumeration.
Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object.
Instance Methods inherited from <OFMutableCopying>
(id)	- mutableCopy
	Creates a mutable copy of the object.

Class Methods
(instancetype)	+ set
	Creates a new set.
(instancetype)	+ setWithSet:
	Creates a new set with the specified set.
(instancetype)	+ setWithArray:
	Creates a new set with the specified array.
(instancetype)	+ setWithObjects:
	Creates a new set with the specified objects.
(instancetype)	+ setWithObjects:count:
	Creates a new set with the specified objects.
Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.
(void)	+ unload
	A method which is called when the class is unloaded from the runtime.
(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.
(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.
(Class)	+ class
	Returns the class.
(OFString *)	+ className
	Returns the name of the class as a string.
(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.
(nullable Class)	+ superclass
	Returns the superclass of the class.
(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.
(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.
(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.
(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.
(OFString *)	+ description
	Returns a description for the class, which is usually the class name.
(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.
(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.
(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.
(bool)	+ resolveClassMethod:
	Try to resolve the specified class method.
(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.
(id)	+ copy
	Returns the class.

Properties
OFArray *	allObjects
	An array of all objects in the set.
ObjectType	anyObject
	An arbitrary object in the set.
Properties inherited from OFObject
OFString *	className
	The name of the object's class.
OFString *	description
	A description for the object.
Properties inherited from <OFCollection>
size_t	count
	The number of objects in the collection.

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!

Note

Subclasses must implement count, containsObject: (OFSet) and objectEnumerator (OFSet).

Method Documentation

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:

(OFSetEnumerationBlock)

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:

(OFSetFilterBlock)

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

init

- (instancetype) init

Initializes an already allocated set to be empty.

Returns

An initialized set

Reimplemented from OFObject.

Reimplemented in OFMutableSet.

initWithArray:

- (instancetype) 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:

- (instancetype) 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:

- (instancetype) 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:

- (instancetype) initWithObjects:		(ObjectType const *)	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:

- (instancetype) 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

Reimplemented from <OFEnumeration>.

set

+ (instancetype) set

Creates a new set.

Returns

A new, autoreleased set

setByAddingObjectsFromSet:

- (OFSet *) setByAddingObjectsFromSet:

(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

setValue:forKey:

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

Set the value for the specified key.

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 *)	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.

A new set with the value for the specified key for each object is returned.

The special key @count can be used to retrieve the count as an OFNumber.

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