# inside

#### Overview

The inside function searches the Vector argument {vector} for the match of the search object argument {obj} and returns the index where {obj} was found. If the {obj} was not found, false is returned. The inside function uses the isIdentical predicate.

### Structure

The inside function takes a key as an argument and a Structure as a second argument and returns the index where the key was found. If the key was not found, the inside function returns false. The inside function uses the isIdentical predicate.

### Dictionary

The inside function takes a key as an argument and a Dictionary as a second argument and returns the index where the key was found. If the key was not found, the inside function returns false. The inside function uses the isIdentical predicate.

### Directory

The inside function takes a key as an argument and a Directory as a second argument and returns the index where the key was found. If the key was not found, the inside function returns false. The inside function uses the isIdentical predicate.

### Matrix

The inside function searches the Matrix argument {matrix} for the match of the search object argument {obj} and returns the index where {obj} was found. If the {obj} was not found, false is returned. The member function uses the isIdentical predicate.

### NumMatrix

The inside function searches the NumMatrix argument {nummatrix} for the match of the search object argument {obj} and returns the index where {obj} was found. If the {obj} was not found, false is returned. The member function uses the isIdentical predicate.

### List

The inside function searches the List argument {list} for a match of the search object argument {obj} and returns the index where {obj} was found. If the {obj} was not found, false is returned. The isIdentical predicate is used to perform the comparison

Usage

The inside Function is used to find an object {obj} in a Vector {vector}. Since the inside function returns the location of the {obj}, the inside function makes it convenient to perform some operation on the {obj} . An alternate function, the isInside function, is used when a Boolean value of either true or false is sufficient.

### Structure

The inside function if you want to locate the position of a certain key in a Structure. If you just want to know if a member is in the Structure but do not care where it is located if it is found, use the isInside function, which returns a Boolean true or false.

### Dictionary

The inside function if you want to locate the position of a certain key in a Dictionary. If you just want to know if a member is in the Directory but do not care where it is located if it is found, use the isInside function, which returns a Boolean true or false.

### Directory

The inside function if you want to locate the position of a certain key in a Directory. If you just want to know if a member is in the Structure, Dictionary or Directory but do not care where it is located if it is found, use the isInside function, which returns a Boolean true or false.

### Matrix

The inside Function is used to find an object {obj} in a Matrix {matrix}. Since the inside function returns the location of the {obj}, the inside function makes it convenient to perform some operation on the {obj} . An alternate function, the isInside function, is used when a Boolean value of either true or false is sufficient.

### NumMatrix

The inside function is used to find an object {obj} in a NumMatrix {nummatrix}. Since the inside function returns the location of the {obj}, the inside function makes it convenient to perform some operation on the {obj} . An alternate function, the isInside function, is used when a Boolean value of either true or false is sufficient.

### Pair

The inside Function is used to find an object {obj} in a List {list}. Since the inside function returns the location of the {obj}, the inside function makes it convenient to perform some operation on the {obj} . An alternate function, the isInside function, is used when a Boolean value of either true or false is sufficient.

#### Syntax

Expression: (inside obj vector)

 Argument: Argument: Arguments Name Type Description obj Character String Symbol Vector BitVector ByteVector IntVector FltVector ObjVector Structure Dictionary Directory Matrix NumMatrix Integer Float Number Complex The search object. vector Vector BitVector ShortVector IntVector NumVector The Vector to be searched.

Returns: Returns false if the object is not present. If the object is present, returns an integer representing the index into the vector where the object was found.

Expression: (inside key struct)

 Argument: Argument: Arguments Name Type Description key String or Text The key (member) you wish to locate. struct Structure The structure to be searched.

Returns: Returns the index of the member if it is found, otherwise it returns false

Expression: (inside key dictionary)

 Argument: Argument: Arguments Name Type Description key String or Text The key (member) you wish to locate. dictionary Dictionary The Dictionary to be searched.

Returns: Returns the index of the member if it is found, otherwise it returns false

Expression: (inside key directory)

 Argument: Argument: Arguments Name Type Description key String or Text The key (member) you wish to locate. directory Directory The Directory to be searched.

Returns: Returns the index of the member if it is found, otherwise it returns false

Expression: (inside obj matrix)

 Argument: Argument: Arguments Name Type Description obj Character String Symbol Vector BitVector ByteVector IntVector FltVector ObjVector Structure Dictionary Directory Matrix NumMatrix Integer Float Number Complex The search object. matrix Matrix The Matrix to be searched.

Returns: Returns false if the object is not present. If the object is present, returns an integer representing the index into the matrix where the object was found.

Expression: (inside obj nummatrix)

 Argument: Argument: Arguments Name Type Description obj Character String Symbol Vector BitVector ByteVector IntVector FltVector ObjVector Structure Dictionary Directory Matrix NumMatrix Integer Float Number Complex The search object. nummatrix NumMatrix The NumMatrix to be searched.

Returns: Returns false if the object is not present. If the object is present, returns an integer representing the index into the matrix where the object was found.

Expression: (inside obj list )

 Argument: Argument: Arguments Name Type Description obj Character String Symbol Vector BitVector ByteVector IntVector FltVector ObjVector Structure Dictionary Directory Matrix NumMatrix Integer Float Number Complex The search object. list List The List to be searched.

Returns: Returns false if the object is not present. If the object is present, returns an integer representing the index into the list where the object was found.

#### Examples

Here are a number of links to Lambda coding examples which contain this instruction in various use cases.

#### Argument Types

Here are the links to the data types of the function arguments.

 Structure Dictionary Directory Integer Boolean Symbol Structure Dictionary Directory Integer Boolean Symbol Structure Dictionary Directory Integer Boolean Symbol Character String Symbol Vector BitVector ByteVector IntVector ShortVector FltVector ObjVector Structure Dictionary Directory Boolean Matrix NumMatrix Integer Float Number Complex

Here are also a number of links to functions having arguments with any of these data types.