ILMathprod Method (BaseArrayfcomplex, Int32, Boolean)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Computes the product of elements of A along specific dimension dim.

[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<fcomplex> prod(
	BaseArray<fcomplex> A,
	int dim = -1,
	bool keepdim = true
)

Public Shared Function prod ( 
	A As BaseArray(Of fcomplex),
	Optional dim As Integer = -1,
	Optional keepdim As Boolean = true
) As RetArray(Of fcomplex)

Dim A As BaseArray(Of fcomplex)
Dim dim As Integer
Dim keepdim As Boolean
Dim returnValue As RetArray(Of fcomplex)

returnValue = ILMath.prod(A, dim, keepdim)

Parameters

A: Type: ILNumericsBaseArrayfcomplex
Input array.
dim (Optional): Type: SystemInt32
[Optional] The index of the dimension to be reduced. Default: (-1) the first non-singleton dimension found in A or 0.
keepdim (Optional): Type: SystemBoolean
[Optional] True: reduced singleton dimension is not removed from the output (default). False: the new singleton dimension is removed.

Return Value

Type: RetArrayfcomplex
New array with the same shape as A except that the dimension specified by dim is reduced to length min(1,A.S[dim]) and removed if keepdim is false.

Exceptions

Exception	Condition
ArgumentException	If A.S[dim] == 0 and keepdim was false.

Remarks

[ILNumerics Computing Engine]

Reference

ILMath Class

prod Overload

ILNumerics Namespace

ILMathAddLanguageSpecificTextSet("LST8F261C71_0?cpp=::|nu=.");prod Method (BaseArrayAddLanguageSpecificTextSet("LST8F261C71_1?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");fcomplexAddLanguageSpecificTextSet("LST8F261C71_2?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)");, Int32, Boolean)

Parameters

Return Value

Reference

ILMathprod Method (BaseArrayfcomplex, Int32, Boolean)