Instance Method

indexOfObjectWithOptions:passingTest:

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

Declaration

- (NSUInteger)indexOfObjectWithOptions:(NSEnumerationOptions)opts passingTest:(BOOL (^)(ObjectType obj, NSUInteger idx, BOOL *stop))predicate;

Parameters

opts

A bit mask 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 array.

The block takes three arguments:

obj

The element in the array.

idx

The index of the element in the array.

stop

A reference to a Boolean value. The block can set the value to YES to stop further enumeration of the array. If a block stops further enumeration, that block continues to run until it’s finished. When the NSEnumerationConcurrent enumeration option is specified, enumeration stops after all of the currently running blocks finish. The stop argument is an out-only argument. You should only ever set this Boolean to YES within the block.

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

Return Value

The index whose corresponding value in the array passes the test specified by predicate and opts. If the opts bit mask specifies reverse order, then the last item that matches is returned. Otherwise, the index of the first matching object is returned. If no objects in the array pass the test, returns NSNotFound.

Discussion

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

See Also

Finding Objects in an Array

- indexOfObject:

Returns the lowest index whose corresponding array value is equal to a given object.

- indexOfObject:inRange:

Returns the lowest index within a specified range whose corresponding array value is equal to a given object .

- indexOfObjectIdenticalTo:

Returns the lowest index whose corresponding array value is identical to a given object.

- indexOfObjectIdenticalTo:inRange:

Returns the lowest index within a specified range whose corresponding array value is equal to a given object .

- indexOfObjectPassingTest:

Returns the index of the first object in the array that passes a test in a given block.

- indexOfObjectAtIndexes:options:passingTest:

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

- indexesOfObjectsPassingTest:

Returns the indexes of objects in the array that pass a test in a given block.

- indexesOfObjectsWithOptions:passingTest:

Returns the indexes of objects in the array that pass a test in a given block for a given set of enumeration options.

- indexesOfObjectsAtIndexes:options:passingTest:

Returns the indexes, from a given set of indexes, of objects in the array that pass a test in a given block for a given set of enumeration options.

- indexOfObject:inSortedRange:options:usingComparator:

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