Array Object

The Array object contains a one-dimensional set of numbers. An Array with N elements is indexed by n = 0,1,2...N-1. The number of elements in an Array can be set when the Array is created using square brackets. The length of the Array can be changed after the Array is first created. Array elements are accessed using square brackets. See the Matrix, Array, and Variable Math Script Reference for more information. This example shows how to create an array with three elements and assign the first element a value of five:

This example shows how to create an Array and make it a 4-element array containing the values 2, 4, 6, 8:

Note: In millisecond mode, if the number of elements is not specified, the Array will have ten elements.

Available In Editions:

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Signatures	Description
Array()	Creates a new Array object using the default Array length (10).
Array(Variable dimension)	Creates a new Array object using the length specified by dimension.

Name	Description	Attributes
Back	Used to get or set the numeric value of the last element in the array.	Type: Variable Access: Read/Write
Capacity	The amount of memory that is reserved for the Array in units of number of elements. The Capacity will equal the maximum Dimension that the Array has had, unless it is set to a different value. The capacity can never be smaller than the current Array Dimension.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Dimension	The number of elements (N) that the Array contains.	Type: Variable Access: Read/Write
Element	The values of the data elements of the array, where the Array index (n) starts at 0 and goes up to (N-1) (where N is the Dimension of the Array). The number of elements in an array is limited only by the memory available on the host computer.	Type: Array Access: Read/Write
Front	Used to get or set the numeric value of the first element in the array.	Type: Variable Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Pop	Returns the numeric value of the last element in the Array. After the value is returned, the value is removed from the Array, reducing the Array Dimension by 1.	Type: Variable Access: Read-Only
PopBack	Returns the numeric value of the last element in the Array. After the value is returned, the value is removed from the Array, reducing the Array Dimension by 1.	Type: Variable Access: Read-Only
PopFront	Returns the value of the first element in the Array. After the value is returned, the value is removed from the Array, reducing the Array Dimension by 1.	Type: Variable Access: Read-Only
Top	Used to get or set the numeric value of the last element in the array.	Type: Variable Access: Read/Write

Name	Description
Add	Adds the value of the specified argument to the end of the Array, increasing the dimension of the Array by one. Returns the new dimension of the Array.
ClearArray	Deletes all elements of the Array, changing the Array Dimension to Zero (0).
ClearSavedStates	Clears previous saved states for this object.
CrossProduct	Computes the cross product with the specified vector.
DotProduct	Computes the dot product with the specified vector.
Erase	Removes the specified element from the Array, decreasing the dimension of the Array by one.
Fill	Loads the specified value into each element of the array.
FillLinspace	Fills the array with evenly spaced values between and including the specified min and max.
FillRandom	Fills the array with random values from a uniform distribution.
Format	Converts the numeric values contained within the calling Array into a string based on the format specifiers given by formatString. The format specifiers are standard C/C++ specifiers as used with the sprintf function. The Format method converts a double precision floating point value to a string; the IFormat method should be used to convert an integer value to a string.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetShuffledElements	Returns a copy of the calling Array where the elements have been randomly shuffled. Calling SeedNoise will set the seed for this method.
GetUniqueElements	Returns an Array containing the unique elements of the calling Array in the order in which they appeared in the calling Array.
IFormat	Converts the numeric values contained within the calling Array into a string based on the format specifiers given by formatString. The format specifiers are standard C/C++ specifiers as used with the sprintf function. The IFormat method converts an integer value to a string; the Format method should be used to convert a double precision floating point value to a string.
Insert	Inserts a value into the calling Array at the specified index, increasing the dimension of the Array by one.
IsEqualTo	Determines if two arrays are equal.
Kurtosis	Returns the kurtosis value of the array.
Max	Returns the maximum value in the array.
Mean	Returns the mean value of the array.
Median	Returns the median value of the array.
Min	Returns the minimum value in the array.
Norm	Computes the square root of the sum of the squares of all array elements.
Normalized	Computes an array where each element is divided by the array norm.
PolynomialFit	Uses Singular Value Decomposition to compute the coefficients of a polynomial to best fit the provided data set. The coefficients are returned in order of highest to lowest degree.
PolynomialRoots	Treats the array of numbers as the coefficients of a polynomial wherein the coefficients are arranged from highest to lowest degree. The degree of the polynomial must be between 1 and 100. Returns the real roots of the polynomial.
Push	Adds the value of the specified argument to the end of the Array, increasing the dimension of the Array by one. Returns the new dimension of the Array.
PushBack	Adds the value of the specified argument to the end of the Array, increasing the dimension of the Array by one. Returns the new dimension of the Array.
PushFront	Adds the value of the specified argument to the front of the calling Array, increasing the dimension of the Array by one. Returns the new dimension of the Array.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
RankSort	Sorts all input StringArray and Array arguments in the order specified by the calling Array. Elements of the calling array should be integers where a positive value indicates an ascending sort and negative indicates a descending sort. For example, for a calling Array of {3, -1, 2}, the objects passed in as arguments will first be sorted based on ascending order of the third argument, then descending order of the first argument, and finally ascending order of the second argument. A value of zero in the calling Array stops the sorting, unless the zero is the first element of the calling Array, in which case it is treated as a 1.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Reverse	Returns an array with the elements in reverse order.
Save	Save the object's state so that it can be restored later.
Shuffle	Randomly shuffles the elements of the calling Array. Calling SeedNoise will set the seed for this method.
Skewness	Returns the skewness value of the array.
SortAscending	Sorts the elements of the array in ascending order (smallest to largest).
SortDescending	Sorts the elements of the array in descending order (largest to smallest).
SortedAscending	Returns a copy of the calling Array sorted in ascending order.
SortedDescending	Returns a copy of the calling Array sorted in descending order.
StandardDeviation	Returns the sample standard deviation of the array.
Sum	Returns the sum of the elements in the array.
ToColumnMajorMatrix	Returns a matrix using the input array as its column-major elements.
ToColumnMatrix	Returns a column matrix representation of the value.
ToDiagonalMatrix	Returns a Matrix where the diagonal elements are the elements of the calling Array.
ToRowMajorMatrix	Returns a matrix using the input array as its row-major elements.
ToRowMatrix	Returns a row matrix representation of the value.
ToStringArray	Returns a copy of the Array in the form of a StringArray. This is equivalent to creating a StringArray consisting of each element of the calling Array using the ToString() method.
VertexAngle	Returns the angle in degrees between two 3-element vectors.

Array Object

Description

Available In Editions:

Timing Precision Mode