Instance Method

indexInRange:options:passingTest:

Returns the index of the first object in the specified range that passes the predicate Block test.

Declaration

- (NSUInteger)indexInRange:(NSRange)range options:(NSEnumerationOptions)opts passingTest:(BOOL (^)(NSUInteger idx, BOOL *stop))predicate;

Parameters

range

The range of indexes to test.

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). See NSEnumerationOptions for the supported values.

predicate

The Block to apply to elements in the set.

The Block takes two arguments:

idx

The index of the object.

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 Boolean to YES within the Block.

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

Return Value

The index of the first object that passes the predicate test.

See Also

Querying Index Sets

- containsIndex:

Indicates whether the index set contains a specific index.

- containsIndexes:

Indicates whether the receiving index set contains a superset of the indexes in another index set.

- containsIndexesInRange:

Indicates whether the index set contains the indexes represented by an index range.

- intersectsIndexesInRange:

Indicates whether the index set contains any of the indexes in a range.

count

The number of indexes in the index set.

- countOfIndexesInRange:

Returns the number of indexes in the index set that are members of a given range.

- indexPassingTest:

Returns the index of the first object that passes the predicate Block test.

- indexesPassingTest:

Returns an NSIndexSet containing the receiving index set’s objects that pass the Block test.

- indexWithOptions:passingTest:

Returns the index of the first object that passes the predicate Block test using the specified enumeration options.

- indexesWithOptions:passingTest:

Returns an NSIndexSet containing the receiving index set’s objects that pass the Block test using the specified enumeration options.

- indexesInRange:options:passingTest:

Returns an NSIndexSet containing the receiving index set’s objects in the specified range that pass the Block test.