Up

# NSOrderedSet documentation

### Authors

Gregory John Casamento (`greg.casamento@gmail.com`)

Date: Generated at 2025-02-13 06:02:40 +0000

Copyright: (C) 2019 Free Software Foundation, Inc.

### Contents -

1. Software documentation for the NSMutableOrderedSet class
2. Software documentation for the NSOrderedSet class

# Software documentation for the NSMutableOrderedSet class

## NSMutableOrderedSet : NSOrderedSet

> Declared in:
>   Foundation/NSOrderedSet.h

Availability: MacOS-X 10.7.0
Description forthcoming.
Method summary

- +orderedSetWithCapacity:
- -addObject:
- -addObjects:count:
- -addObjectsFromArray:
- -exchangeObjectAtIndex:withObjectAtIndex:
- -filterUsingPredicate:
- -init
- -initWithCapacity:
- -initWithCoder:
- -insertObject:atIndex:
- -insertObjects:atIndexes:
- -intersectOrderedSet:
- -intersectSet:
- -minusOrderedSet:
- -minusSet:
- -moveObjectsAtIndexes:toIndex:
- -removeAllObjects
- -removeObject:
- -removeObjectAtIndex:
- -removeObjectsAtIndexes:
- -removeObjectsInArray:
- -removeObjectsInRange:
- -replaceObjectAtIndex:withObject:
- -replaceObjectsAtIndexes:withObjects:
- -replaceObjectsInRange:withObjects:count:
- -setObject:atIndex:
- -setObject:atIndexedSubscript:
- -sortRange:options:usingComparator:
- -sortUsingComparator:
- -sortUsingDescriptors:
- -sortWithOptions:usingComparator:
- -unionOrderedSet:
- -unionSet:

### orderedSetWithCapacity:

+ (instancetype) orderedSetWithCapacity: (NSUInteger)capacity;
Availability: MacOS-X 10.7.0
Description forthcoming.

### addObject:

- (void) addObject: (id)anObject;
Availability: MacOS-X 10.7.0
Description forthcoming.

### addObjects: count:

- (void) addObjects: (const id[])objects count: (NSUInteger)count;
Availability: MacOS-X 10.7.0
Description forthcoming.

### addObjectsFromArray:

- (void) addObjectsFromArray: (NSArray*)otherArray;
Availability: MacOS-X 10.7.0
Description forthcoming.

### exchangeObjectAtIndex: withObjectAtIndex:

- (void) exchangeObjectAtIndex: (NSUInteger)index withObjectAtIndex: (NSUInteger)otherIndex;
Availability: MacOS-X 10.7.0
Description forthcoming.

### filterUsingPredicate:

- (void) filterUsingPredicate: (NSPredicate*)predicate;
Availability: MacOS-X 10.7.0
Description forthcoming.

### init

- (instancetype) init;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithCapacity:

- (instancetype) initWithCapacity: (NSUInteger)capacity;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithCoder:

- (instancetype) initWithCoder: (NSCoder*)coder;
Availability: MacOS-X 10.7.0
Description forthcoming.

### insertObject: atIndex:

- (void) insertObject: (id)object atIndex: (NSUInteger)index;
Availability: MacOS-X 10.7.0
Description forthcoming.

### insertObjects: atIndexes:

- (void) insertObjects: (NSArray*)array atIndexes: (NSIndexSet*)indexes;
Availability: MacOS-X 10.7.0
Description forthcoming.

### intersectOrderedSet:

- (void) intersectOrderedSet: (NSOrderedSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### intersectSet:

- (void) intersectSet: (NSSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### minusOrderedSet:

- (void) minusOrderedSet: (NSOrderedSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### minusSet:

- (void) minusSet: (NSSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### moveObjectsAtIndexes: toIndex:

- (void) moveObjectsAtIndexes: (NSIndexSet*)indexes toIndex: (NSUInteger)index;
Availability: MacOS-X 10.7.0
Description forthcoming.

### removeAllObjects

- (void) removeAllObjects;
Availability: MacOS-X 10.7.0
Description forthcoming.

### removeObject:

- (void) removeObject: (id)object;
Availability: MacOS-X 10.7.0
Description forthcoming.

### removeObjectAtIndex:

- (void) removeObjectAtIndex: (NSUInteger)index;
Availability: MacOS-X 10.7.0
Description forthcoming.

### removeObjectsAtIndexes:

- (void) removeObjectsAtIndexes: (NSIndexSet*)indexes;
Availability: MacOS-X 10.7.0
Description forthcoming.

### removeObjectsInArray:

- (void) removeObjectsInArray: (NSArray*)otherArray;
Availability: MacOS-X 10.7.0
Description forthcoming.

### removeObjectsInRange:

- (void) removeObjectsInRange: (NSRange)range;
Availability: MacOS-X 10.7.0
Description forthcoming.

### replaceObjectAtIndex: withObject:

- (void) replaceObjectAtIndex: (NSUInteger)index withObject: (id)object;
Availability: MacOS-X 10.7.0
Description forthcoming.

### replaceObjectsAtIndexes: withObjects:

- (void) replaceObjectsAtIndexes: (NSIndexSet*)indexes withObjects: (NSArray*)objects;
Availability: MacOS-X 10.7.0
Description forthcoming.

### replaceObjectsInRange: withObjects: count:

- (void) replaceObjectsInRange: (NSRange)range withObjects: (const id[])objects count: (NSUInteger)count;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setObject: atIndex:

- (void) setObject: (id)object atIndex: (NSUInteger)index;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setObject: atIndexedSubscript:

- (void) setObject: (id)object atIndexedSubscript: (NSUInteger)index;
Availability: MacOS-X 10.7.0
Description forthcoming.

### sortRange: options: usingComparator:

- (void) sortRange: (NSRange)range options: (NSSortOptions)options usingComparator: (NSComparator)comparator;
Availability: MacOS-X 10.7.0
Description forthcoming.

### sortUsingComparator:

- (void) sortUsingComparator: (NSComparator)comparator;
Availability: MacOS-X 10.7.0
Description forthcoming.

### sortUsingDescriptors:

- (void) sortUsingDescriptors: (NSArray*)descriptors;
Availability: MacOS-X 10.7.0
Description forthcoming.

### sortWithOptions: usingComparator:

- (void) sortWithOptions: (NSSortOptions)options usingComparator: (NSComparator)comparator;
Availability: MacOS-X 10.7.0
Description forthcoming.

### unionOrderedSet:

- (void) unionOrderedSet: (NSOrderedSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### unionSet:

- (void) unionSet: (NSSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

# Software documentation for the NSOrderedSet class

## NSOrderedSet : NSObject

> Declared in:
>   Foundation/NSOrderedSet.h

> Conforms to:
>   NSCoding
>   NSCopying
>   NSMutableCopying
>   NSFastEnumeration

Availability: MacOS-X 10.7.0
Description forthcoming.
Method summary

- +orderedSet
- +orderedSetWithArray:
- +orderedSetWithArray:range:copyItems:
- +orderedSetWithObject:
- +orderedSetWithObjects:,...
- +orderedSetWithObjects:count:
- +orderedSetWithOrderedSet:
- +orderedSetWithSet:
- +orderedSetWithSet:copyItems:
- -array
- -containsObject:
- -count
- -description
- -descriptionWithLocale:
- -descriptionWithLocale:indent:
- -enumerateObjectsAtIndexes:options:usingBlock:
- -enumerateObjectsUsingBlock:
- -enumerateObjectsWithOptions:usingBlock:
- -filteredOrderedSetUsingPredicate:
- -firstObject
- -getObjects:range:
- -indexOfObject:
- -indexOfObject:inSortedRange:options:usingComparator:
- -indexOfObjectAtIndexes:options:passingTest:
- -indexOfObjectPassingTest:
- -indexOfObjectWithOptions:passingTest:
- -indexesOfObjectsAtIndexes:options:passingTest:
- -indexesOfObjectsPassingTest:
- -indexesOfObjectsWithOptions:passingTest:
- -init
- -initWithArray:
- -initWithArray:copyItems:
- -initWithArray:range:copyItems:
- -initWithObject:
- -initWithObjects:,...
- -initWithObjects:count:
- -initWithOrderedSet:
- -initWithOrderedSet:copyItems:
- -initWithOrderedSet:range:copyItems:
- -initWithSet:
- -initWithSet:copyItems:
- -intersectsOrderedSet:
- -intersectsSet:
- -isEqualToOrderedSet:
- -isSubsetOfOrderedSet:
- -isSubsetOfSet:
- -lastObject
- -objectAtIndex:
- -objectAtIndexedSubscript:
- -objectEnumerator
- -objectsAtIndexes:
- -reverseObjectEnumerator
- -reversedOrderedSet
- -set
- -setValue:forKey:
- -sortedArrayUsingComparator:
- -sortedArrayUsingDescriptors:
- -sortedArrayWithOptions:usingComparator:
- -valueForKey:

### orderedSet

+ (instancetype) orderedSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### orderedSetWithArray:

+ (instancetype) orderedSetWithArray: (NSArray*)objects;
Availability: MacOS-X 10.7.0
Description forthcoming.

### orderedSetWithArray: range: copyItems:

+ (instancetype) orderedSetWithArray: (NSArray*)objects range: (NSRange)range copyItems: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### orderedSetWithObject:

+ (instancetype) orderedSetWithObject: (id)anObject;
Availability: MacOS-X 10.7.0
Description forthcoming.

### orderedSetWithObjects: ,...

+ (instancetype) orderedSetWithObjects: (id)firstObject,...;
Availability: MacOS-X 10.7.0
Description forthcoming.

### orderedSetWithObjects: count:

+ (instancetype) orderedSetWithObjects: (const id[])objects count: (NSUInteger)count;
Availability: MacOS-X 10.7.0
Description forthcoming.

### orderedSetWithOrderedSet:

+ (instancetype) orderedSetWithOrderedSet: (NSOrderedSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### orderedSetWithSet:

+ (instancetype) orderedSetWithSet: (NSSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### orderedSetWithSet: copyItems:

+ (instancetype) orderedSetWithSet: (NSSet*)aSet copyItems: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### array

- (NSArray*) array;
Availability: MacOS-X 10.7.0
Description forthcoming.

### containsObject:

- (BOOL) containsObject: (id)anObject;
Availability: MacOS-X 10.7.0
Description forthcoming.

### count

- (NSUInteger) count;
Availability: MacOS-X 10.7.0
Description forthcoming.

### description

- (NSString*) description;
Availability: MacOS-X 10.7.0
Description forthcoming.

### descriptionWithLocale:

- (NSString*) descriptionWithLocale: (NSLocale*)locale;
Availability: MacOS-X 10.7.0
Description forthcoming.

### descriptionWithLocale: indent:

- (NSString*) descriptionWithLocale: (NSLocale*)locale indent: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### enumerateObjectsAtIndexes: options: usingBlock:

- (void) enumerateObjectsAtIndexes: (NSIndexSet*)indexSet options: (NSEnumerationOptions)opts usingBlock: (GSEnumeratorBlock)aBlock;
Availability: MacOS-X 10.7.0
Description forthcoming.

### enumerateObjectsUsingBlock:

- (void) enumerateObjectsUsingBlock: (GSEnumeratorBlock)aBlock;
Availability: MacOS-X 10.7.0
Description forthcoming.

### enumerateObjectsWithOptions: usingBlock:

- (void) enumerateObjectsWithOptions: (NSEnumerationOptions)opts usingBlock: (GSEnumeratorBlock)aBlock;
Availability: MacOS-X 10.7.0
Description forthcoming.

### filteredOrderedSetUsingPredicate:

- (NSOrderedSet*) filteredOrderedSetUsingPredicate: (NSPredicate*)predicate;
Availability: MacOS-X 10.7.0
Description forthcoming.

### firstObject

- (id) firstObject;
Availability: MacOS-X 10.7.0
Description forthcoming.

### getObjects: range:

- (void) getObjects: (__unsafe_unretained id[])aBuffer range: (NSRange)aRange;
Availability: MacOS-X 10.7.0
Description forthcoming.

### indexOfObject:

- (NSUInteger) indexOfObject: (id)objects;
Availability: MacOS-X 10.7.0
Description forthcoming.

### indexOfObject: inSortedRange: options: usingComparator:

- (NSUInteger) indexOfObject: (id)key inSortedRange: (NSRange)range options: (NSBinarySearchingOptions)options usingComparator: (NSComparator)comparator;
Availability: MacOS-X 10.7.0
Description forthcoming.

### indexOfObjectAtIndexes: options: passingTest:

- (NSUInteger) indexOfObjectAtIndexes: (NSIndexSet*)indexSet options: (NSEnumerationOptions)opts passingTest: (GSPredicateBlock)predicate;
Availability: MacOS-X 10.7.0
Description forthcoming.

### indexOfObjectPassingTest:

- (NSUInteger) indexOfObjectPassingTest: (GSPredicateBlock)predicate;
Availability: MacOS-X 10.7.0
Description forthcoming.

### indexOfObjectWithOptions: passingTest:

- (NSUInteger) indexOfObjectWithOptions: (NSEnumerationOptions)opts passingTest: (GSPredicateBlock)predicate;
Availability: MacOS-X 10.7.0
Description forthcoming.

### indexesOfObjectsAtIndexes: options: passingTest:

- (NSIndexSet*) indexesOfObjectsAtIndexes: (NSIndexSet*)indexSet options: (NSEnumerationOptions)opts passingTest: (GSPredicateBlock)predicate;
Availability: MacOS-X 10.7.0
Description forthcoming.

### indexesOfObjectsPassingTest:

- (NSIndexSet*) indexesOfObjectsPassingTest: (GSPredicateBlock)predicate;
Availability: MacOS-X 10.7.0
Description forthcoming.

### indexesOfObjectsWithOptions: passingTest:

- (NSIndexSet*) indexesOfObjectsWithOptions: (NSEnumerationOptions)opts passingTest: (GSPredicateBlock)predicate;
Availability: MacOS-X 10.7.0
Description forthcoming.

### init

- (instancetype) init;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithArray:

- (instancetype) initWithArray: (NSArray*)array;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithArray: copyItems:

- (instancetype) initWithArray: (NSArray*)array copyItems: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithArray: range: copyItems:

- (instancetype) initWithArray: (NSArray*)array range: (NSRange)range copyItems: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithObject:

- (instancetype) initWithObject: (id)object;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithObjects: ,...

- (instancetype) initWithObjects: (id)firstObject,...;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithObjects: count:

- (instancetype) initWithObjects: (const id[])objects count: (NSUInteger)count;
Availability: MacOS-X 10.7.0
This is a designated initialiser for the class.
Subclasses must override this method.
Initialize to contain (unique elements of) objects.
Calls -init (which does nothing but maintain MacOS-X compatibility), and needs to be re-implemented in subclasses in order to have all other initialisers work.

### initWithOrderedSet:

- (instancetype) initWithOrderedSet: (NSOrderedSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithOrderedSet: copyItems:

- (instancetype) initWithOrderedSet: (NSOrderedSet*)aSet copyItems: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithOrderedSet: range: copyItems:

- (instancetype) initWithOrderedSet: (NSOrderedSet*)aSet range: (NSRange)range copyItems: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithSet:

- (instancetype) initWithSet: (NSSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### initWithSet: copyItems:

- (instancetype) initWithSet: (NSSet*)aSet copyItems: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### intersectsOrderedSet:

- (BOOL) intersectsOrderedSet: (NSOrderedSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### intersectsSet:

- (BOOL) intersectsSet: (NSSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### isEqualToOrderedSet:

- (BOOL) isEqualToOrderedSet: (NSOrderedSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### isSubsetOfOrderedSet:

- (BOOL) isSubsetOfOrderedSet: (NSOrderedSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### isSubsetOfSet:

- (BOOL) isSubsetOfSet: (NSSet*)aSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### lastObject

- (id) lastObject;
Availability: MacOS-X 10.7.0
Description forthcoming.

### objectAtIndex:

- (id) objectAtIndex: (NSUInteger)index;
Availability: MacOS-X 10.7.0
Description forthcoming.

### objectAtIndexedSubscript:

- (id) objectAtIndexedSubscript: (NSUInteger)index;
Availability: MacOS-X 10.7.0
Description forthcoming.

### objectEnumerator

- (NSEnumerator*) objectEnumerator;
Availability: MacOS-X 10.7.0
Description forthcoming.

### objectsAtIndexes:

- (NSArray*) objectsAtIndexes: (NSIndexSet*)indexes;
Availability: MacOS-X 10.7.0
Description forthcoming.

### reverseObjectEnumerator

- (NSEnumerator*) reverseObjectEnumerator;
Availability: MacOS-X 10.7.0
Description forthcoming.

### reversedOrderedSet

- (NSOrderedSet*) reversedOrderedSet;
Availability: MacOS-X 10.7.0
Description forthcoming.

### set

- (NSSet*) set;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setValue: forKey:

- (void) setValue: (id)value forKey: (NSString*)key;
Availability: MacOS-X 10.7.0
Description forthcoming.

### sortedArrayUsingComparator:

- (NSArray*) sortedArrayUsingComparator: (NSComparator)comparator;
Availability: MacOS-X 10.7.0
Description forthcoming.

### sortedArrayUsingDescriptors:

- (NSArray*) sortedArrayUsingDescriptors: (NSArray*)sortDescriptors;
Availability: MacOS-X 10.7.0
Description forthcoming.

### sortedArrayWithOptions: usingComparator:

- (NSArray*) sortedArrayWithOptions: (NSSortOptions)options usingComparator: (NSComparator)comparator;
Availability: MacOS-X 10.7.0
Description forthcoming.

### valueForKey:

- (id) valueForKey: (NSString*)key;
Availability: MacOS-X 10.7.0
Description forthcoming.

Up