ILNumerics Ultimate VS

ILMathmeshgrid Method (InArraycomplex, InArraycomplex, InArraycomplex, OutArraycomplex, OutArraycomplex)

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Create 3d arrays for evaluation and visualization of 3 dimensional functions.

[ILNumerics Computing Engine]

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

public static RetArray<complex> meshgrid(
	InArray<complex> X,
	InArray<complex> Y,
	InArray<complex> Z,
	OutArray<complex> outY = null,
	OutArray<complex> outZ = null
)

Parameters

X
Type: ILNumericsInArraycomplex
Vector of x values.
Y
Type: ILNumericsInArraycomplex
Vector of y values.
Z
Type: ILNumericsInArraycomplex
Vector of z values.
outY (Optional)
Type: ILNumericsOutArraycomplex
[Output, Optional] If on entry outY is not null it holds the values for the y dimension on return.
outZ (Optional)
Type: ILNumericsOutArraycomplex
[Output, Optional] If on entry outZ is not null it holds the values for the z dimension on return.

Return Value

Type: RetArraycomplex
X value array along the values of X, arrays for y and z dimensions are returned in outY and outZ respectively.
Exceptions

ExceptionCondition
ArgumentNullExceptionIf X or Y is null.
Remarks

The arrays returned can conveniently be used to evaluate and visualize functions of 3 variables X, Y and Z. Coordinates build a 3 dimensional grid with edges at all permutations of X, Y and Z.

Note that the X dimension goes along the rows, while the second dimension is considered the columns! This deviates from the common intuition and the actual storage order of matrix elements (i.e.: first dimension along the columns and 2nd dimension along the rows). The reason for it is the convenience this order gives for plotting purposes: In most plots the X axis is expected to run horizontaly.

[ILNumerics Computing Engine]

See Also

Reference

MathInternal.meshgrid(InArraycomplex, InArraycomplex, InArraycomplex, OutArraycomplex, OutArraycomplex)

Other Resources