---

NSMutableIndexSet Class Reference

Overview

The NSMutableIndexSet class represents a mutable collection of unique unsigned integers, known as indexes because of the way they are used. This collection is referred to as a mutable index set.

The values in a mutable index set are always sorted, so the order in which values are added is irrelevant.

You must not subclass the NSMutableIndexSet class.

Tasks

Adding Indexes

• – addIndex:
• – addIndexes:
• – addIndexesInRange:

Removing Indexes

• – removeIndex:
• – removeIndexes:
• – removeAllIndexes
• – removeIndexesInRange:

Shifting Index Groups

• – shiftIndexesStartingAtIndex:by:

Instance Methods

addIndex:

Adds an index to the receiver.

- (void)addIndex:(NSUInteger)index

Parameters

index

Index to add.

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – addIndexes:
• – addIndexesInRange:

Related Sample Code

• Core Data HTML Store

Declared In

NSIndexSet.h

addIndexes:

Adds the indexes in an index set to the receiver.

- (void)addIndexes:(NSIndexSet *)indexSet

Parameters

indexSet

Index set to add.

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – addIndex:
• – addIndexesInRange:

Declared In

NSIndexSet.h

addIndexesInRange:

Adds the indexes in an index range to the receiver.

- (void)addIndexesInRange:(NSRange)indexRange

Parameters

indexRange

Index range to add. Must include only indexes representable as unsigned integers.

Discussion

This method raises an NSRangeException when indexRange would add an index that exceeds the maximum allowed value for unsigned integers.

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – addIndex:
• – addIndexes:

Declared In

NSIndexSet.h

removeAllIndexes

Removes the receiver’s indexes.

- (void)removeAllIndexes

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – removeIndex:
• – removeIndexes:
• – removeIndexesInRange:

Declared In

NSIndexSet.h

removeIndex:

Removes an index from the receiver.

- (void)removeIndex:(NSUInteger)index

Parameters

index

Index to remove.

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – removeAllIndexes
• – removeIndexes:
• – removeIndexesInRange:

Declared In

NSIndexSet.h

removeIndexes:

Removes the indexes in an index set from the receiver.

- (void)removeIndexes:(NSIndexSet *)indexSet

Parameters

indexSet

Index set to remove.

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – removeIndex:
• – removeAllIndexes
• – removeIndexesInRange:

Declared In

NSIndexSet.h

removeIndexesInRange:

Removes the indexes in an index range from the receiver.

- (void)removeIndexesInRange:(NSRange)indexRange

Parameters

indexRange

Index range to remove.

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – removeIndex:
• – removeIndexes:
• – removeAllIndexes

Declared In

NSIndexSet.h

shiftIndexesStartingAtIndex:by:

Shifts a group of indexes to the left or the right within the receiver.

- (void)shiftIndexesStartingAtIndex:(NSUInteger)startIndex by:(NSInteger)delta

Parameters

startIndex

Head of the group of indexes to shift.

delta

Amount and direction of the shift. Positive integers shift the indexes to the right. Negative integers shift the indexes to the left.

Discussion

The group of indexes shifted is made up by startIndex and the indexes that follow it in the receiver.

A left shift deletes the indexes in the range (startIndex-delta,delta) from the receiver.

A right shift inserts empty space in the range (indexStart,delta) in the receiver.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

NSIndexSet.h

---