Instance Method

indexesOfObjectsAtIndexes:options:passingTest:

Returns the index, from a given set of indexes, of the object in the ordered set that passes a test in a given block for a given set of enumeration options.

Declaration

- (NSIndexSet *)indexesOfObjectsAtIndexes:(NSIndexSet *)s options:(NSEnumerationOptions)opts passingTest:(BOOL (^)(ObjectType obj, NSUInteger idx, BOOL *stop))predicate;

Parameters

indexSet

The indexes of the objects over which to enumerate.

opts

A bitmask that specifies the options for the enumeration (whether it should be performed concurrently and whether it should be performed in reverse order).

predicate

The block to apply to elements in the ordered set.

The block takes three arguments:

obj

The element in the ordered set.

idx

The index of the element in the ordered set.

stop

A reference to a Boolean value. The block can set the value to YES to stop further processing of the set. The stop argument is an out-only argument. You should only ever set this value to YES within the block.

The block returns a Boolean value that indicates whether obj passed the test.

Return Value

The index of the corresponding value in the ordered set that passes the test specified by predicate. If no objects in the ordered set pass the test, returns NSNotFound.

Discussion

By default, the enumeration starts with the first object and continues serially through the ordered set to the last object. You can specify NSEnumerationConcurrent and/or NSEnumerationReverse as enumeration options to modify this behavior.

See Also

Accessing Set Members

- containsObject:

Returns a Boolean value that indicates whether a given object is present in the ordered set.

- enumerateObjectsAtIndexes:options:usingBlock:

Executes a given block using the objects in the ordered set at the specified indexes.

- enumerateObjectsUsingBlock:

Executes a given block using each object in the ordered set.

- enumerateObjectsWithOptions:usingBlock:

Executes a given block using each object in the set, using the specified enumeration options.

firstObject

The first object in the ordered set.

lastObject

The last object in the ordered set.

- objectAtIndex:

Returns the object at the specified index of the set.

- objectAtIndexedSubscript:

Returns the object at the specified index of the set.

- objectsAtIndexes:

Returns the objects in the ordered set at the specified indexes.

- indexOfObject:

Returns the index of the specified object.

- indexOfObject:inSortedRange:options:usingComparator:

Returns the index, within a specified range, of an object compared with elements in the ordered set using a given NSComparator block.

- indexOfObjectAtIndexes:options:passingTest:

Returns the index, from a given set of indexes, of the object in the ordered set that passes a test in a given block for a given set of enumeration options.

- indexOfObjectPassingTest:

Returns the index of the object in the ordered set that passes a test in a given block.

- indexOfObjectWithOptions:passingTest:

Returns the index of an object in the ordered set that passes a test in a given block for a given set of enumeration options.

- indexesOfObjectsPassingTest:

Returns the index of the object in the ordered set that passes a test in a given block.

- indexesOfObjectsWithOptions:passingTest:

Returns the index of an object in the ordered set that passes a test in a given block for a given set of enumeration options.

- objectEnumerator

Returns an enumerator object that lets you access each object in the ordered set.

- reverseObjectEnumerator

Returns an enumerator object that lets you access each object in the ordered set.

reversedOrderedSet

An ordered set in the reverse order.

- getObjects:range:

Copies the objects contained in the ordered set that fall within the specified range to objects.