ILMathcross Method (InArraySingle, InArraySingle, Boolean, NullableUInt32)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Computes the cross product along a dimension of two arrays.

[ILNumerics Computing Engine]

Namespace: ILNumerics
Assembly: ILNumerics.Computing (in ILNumerics.Computing.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

Copy

public static RetArray<float> cross(
	InArray<float> A,
	InArray<float> B,
	bool normalize = false,
	Nullable<uint> dimension = null
)

Public Shared Function cross ( 
	A As InArray(Of Single),
	B As InArray(Of Single),
	Optional normalize As Boolean = false,
	Optional dimension As Nullable(Of UInteger) = Nothing
) As RetArray(Of Single)

Dim A As InArray(Of Single)
Dim B As InArray(Of Single)
Dim normalize As Boolean
Dim dimension As Nullable(Of UInteger)
Dim returnValue As RetArray(Of Single)

returnValue = ILMath.cross(A, B, normalize, 
	dimension)

Parameters

A: Type: ILNumericsInArraySingle
First array.
B: Type: ILNumericsInArraySingle
Second array.
normalize (Optional): Type: SystemBoolean
[Optional] If true: normalize resulting vectors to length 1.0. Default: false.
dimension (Optional): Type: SystemNullableUInt32
[Optional] The working dimension. Default: (null) the first dimension of length 3.

Return Value

Type: RetArraySingle
Array with cross products of vectors from A and B.

Exceptions

Exception	Condition
ArgumentException	If the size of A and B is not the same or if either of A or B is null, if the working dimension could not be determined or if the determined workign dimension is not at least of length 3.

Remarks

A and B are expected to store the vectors inside the same respective dimensions. This dimension must be of length 3 or longer. If dimension is not specified the working dimension if found by searching for the first dimension of length 3, starting with dimension #0. If no dimension of length 3 is found, cross(InArraySingle, InArraySingle, Boolean, NullableUInt32) uses the first dimension which has more than 3 elements. If no such dimension is found either an exception is thrown.

The dimension argument allows to explicitly determine the index of the working dimension. The length of this dimension must be equal to or larger than 3. Both, A and B must be of the same size.

Elements in the working dimension with indices > #2 are ignored. Corresponding elements in the output array become 0.

[ILNumerics Computing Engine]

Reference

ILMath Class

cross Overload

ILNumerics Namespace