Instance Method

index(of:in:)

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

Declaration

func index(of anObject: Any, in range: NSRange) -> Int

Parameters

anObject

An object.

range

The range of indexes in the array within which to search for anObject.

Return Value

The lowest index within range whose corresponding array value is equal to anObject. If none of the objects within range is equal to anObject, returns NSNotFound.

Discussion

Starting at range.location, each element of the array is passed as an argument to an isEqual(_:) message sent to anObject until a match is found or the end of the range is reached. Objects are considered equal if isEqual(_:) returns true.

This method raises an rangeException exception if the range parameter represents a range that doesn’t exist in the array.

See Also

Finding Objects in an Array

func index(of: Any)

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

func indexOfObjectIdentical(to: Any)

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

func indexOfObjectIdentical(to: Any, in: NSRange)

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

func indexOfObject(passingTest: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool)

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

func indexOfObject(options: NSEnumerationOptions = [], passingTest: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool)

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

func indexOfObject(at: IndexSet, options: NSEnumerationOptions = [], passingTest: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool)

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.

func indexesOfObjects(passingTest: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool)

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

func indexesOfObjects(options: NSEnumerationOptions = [], passingTest: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool)

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

func indexesOfObjects(at: IndexSet, options: NSEnumerationOptions = [], passingTest: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool)

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.

func index(of: Any, inSortedRange: NSRange, options: NSBinarySearchingOptions = [], usingComparator: (Any, Any) -> ComparisonResult)

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