VirtualArray Object

The VirtualArray object provides properties and methods for expressions that evaluate to an Array. One example of an expression that evaluates to an Array is Array.Reverse().

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

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.

Name

Description

Attributes

Count

The number of elements in the array.

Type: Variable

Access: Read-Only

Name	Description
CrossProduct	Computes the cross product with the specified vector.
DotProduct	Computes the dot product with the specified vector.
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.
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.
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.
Reverse	Returns an array with the elements in reverse order.
Skewness	Returns the skewness value of the array.
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.