A class storing a set of indexes as sorted ranges. More...

#include <OFIndexSet.h>

Inheritance diagram for OFIndexSet:

Instance Methods
(instancetype)	- init
	Initializes an empty index set.
(instancetype)	- initWithIndexSet:
	Initializes an index set from the specified index set.
(instancetype)	- initWithIndex:
	Initializes an index set to only contain the specified index.
(instancetype)	- initWithIndexesInRange:
	Initializes an index set to contain the indexes in the specified range.
(bool)	- containsIndex:
	Returns whether the specified index is in the index set.
(bool)	- containsIndexesInRange:
	Returns whether the specified range of indexes is in the index set.
(size_t)	- indexGreaterThanIndex:
	Returns the closest index greater than the specified index or OFNotFound.
(size_t)	- indexGreaterThanOrEqualToIndex:
	Returns the closest index greater than or equal to the specified index or OFNotFound.
(size_t)	- indexLessThanIndex:
	Returns the closest index less than the specified index or OFNotFound.
(size_t)	- indexLessThanOrEqualToIndex:
	Returns the closest index less than or equal to the specified index or OFNotFound.
(size_t)	- getIndexes:maxCount:inIndexRange:
	Copies the indexes in the specified range to the specified buffer.
(size_t)	- countOfIndexesInRange:
	Returns the number of indexes in the specified range.
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 <OFCopying>
(id)	- copy
	Copies the object.
Instance Methods inherited from <OFMutableCopying>
(id)	- mutableCopy
	Creates a mutable copy of the object.

Class Methods
(instancetype)	+ indexSet
	Creates a new empty index set.
(instancetype)	+ indexSetWithIndexSet:
	Creates a new index set from the specified index set.
(instancetype)	+ indexSetWithIndex:
	Creates a new index set only containing the specified index.
(instancetype)	+ indexSetWithIndexesInRange:
	Creates a new index set containing the indexes in the specified range.
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
size_t	count
	The number of indexes in the set.
size_t	firstIndex
	The first index in the index set or OFNotFound.
size_t	lastIndex
	The last index in the index set or OFNotFound.
Properties inherited from OFObject
OFString *	className
	The name of the object's class.
OFString *	description
	A description for the object.

Detailed Description

A class storing a set of indexes as sorted ranges.

Method Documentation

◆ containsIndex:

- (bool) containsIndex: (size_t) idx

Returns whether the specified index is in the index set.

Parameters

idx	The index to check the index set for

Returns: Whether the specified index is in the index set

◆ containsIndexesInRange:

- (bool) containsIndexesInRange: (OFRange) range

Returns whether the specified range of indexes is in the index set.

Parameters

range The range of indexes to check the index set for

Returns: Whether the specified range of indexes is in the index set

◆ countOfIndexesInRange:

- (size_t) countOfIndexesInRange: (OFRange) range

Returns the number of indexes in the specified range.

Returns: The number of indexes in the specified range

◆ getIndexes:maxCount:inIndexRange:

- (size_t) getIndexes:	(size_t *)	indexes
maxCount:	(size_t)	maxCount
inIndexRange:	(nullable OFRange *)	range

Copies the indexes in the specified range to the specified buffer.

Parameters

indexes	A pointer to an array of indexes
maxCount	The maximum number of indexes to copy
range	The range the copied indexes should be in

Returns: The number of indexes copied

◆ indexGreaterThanIndex:

- (size_t) indexGreaterThanIndex: (size_t) idx

Returns the closest index greater than the specified index or OFNotFound.

Parameters

idx	The index for which to find an index that is greater

Returns: The closest index greater than the specified index or OFNotFound

◆ indexGreaterThanOrEqualToIndex:

- (size_t) indexGreaterThanOrEqualToIndex: (size_t) idx

Returns the closest index greater than or equal to the specified index or OFNotFound.

Parameters

idx	The index for which to find an index that is greater or equal

Returns: The closest index greater than or equal to the specified index or OFNotFound

◆ indexLessThanIndex:

- (size_t) indexLessThanIndex: (size_t) idx

Returns the closest index less than the specified index or OFNotFound.

Parameters

idx	The index for which to find an index that is less

Returns: The closest index less than the specified index or OFNotFound

◆ indexLessThanOrEqualToIndex:

- (size_t) indexLessThanOrEqualToIndex: (size_t) idx

Returns the closest index less than or equal to the specified index or OFNotFound.

Parameters

idx	The index for which to find an index that is less or equal

Returns: The closest index less than or equal to the specified index or OFNotFound

◆ indexSet

+ (instancetype) indexSet

Creates a new empty index set.

Returns: A new empty index set

◆ indexSetWithIndex:

+ (instancetype) indexSetWithIndex: (size_t) idx

Creates a new index set only containing the specified index.

Parameters

idx	The index the index set should contain

Returns: A new index set only containing the specified index

◆ indexSetWithIndexesInRange:

+ (instancetype) indexSetWithIndexesInRange: (OFRange) range

Creates a new index set containing the indexes in the specified range.

Parameters

range The range of indexes the index set should contain

Returns: A new index set containing the indexes in the specified range

◆ indexSetWithIndexSet:

+ (instancetype) indexSetWithIndexSet: (OFIndexSet *) indexSet

Creates a new index set from the specified index set.

Parameters

indexSet The index set to create a new index set from

Returns: A new index set created from the specified index set

◆ init

- (instancetype) init

Initializes an empty index set.

Returns: An initialized empty index set

Reimplemented from OFObject.

◆ initWithIndex:

- (instancetype) initWithIndex: (size_t) idx

Initializes an index set to only contain the specified index.

Parameters

idx	The index the index set should contain

Returns: An initialized index set only containing the specified index

◆ initWithIndexesInRange:

- (instancetype) initWithIndexesInRange: (OFRange) range

Initializes an index set to contain the indexes in the specified range.

Parameters

range The range of indexes the index set should contain

Returns: An initialized index set containing the indexes in the specified range

◆ initWithIndexSet:

- (instancetype) initWithIndexSet: (OFIndexSet *) indexSet

Initializes an index set from the specified index set.

Parameters

indexSet The index set to initialize the index set from

Returns: An index set initialized from the specified index set

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

src/OFIndexSet.h
src/OFIndexSet.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ containsIndex:

◆ containsIndexesInRange:

◆ countOfIndexesInRange:

◆ getIndexes:maxCount:inIndexRange:

◆ indexGreaterThanIndex:

◆ indexGreaterThanOrEqualToIndex:

◆ indexLessThanIndex:

◆ indexLessThanOrEqualToIndex:

◆ indexSet

◆ indexSetWithIndex:

◆ indexSetWithIndexesInRange:

◆ indexSetWithIndexSet:

◆ init

◆ initWithIndex:

◆ initWithIndexesInRange:

◆ initWithIndexSet: