ILNumerics - Technical Application Development
Assembly: ILNumerics.Computing (in ILNumerics.Computing.dll) Version: 5.5.0.0 (5.5.7503.3146)
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.
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
public static RetArray<fcomplex> prod( BaseArray<fcomplex> A, int dim = -1, bool keepdim = true )
Parameters
- A
- Type: ILNumerics.BaseArray<fcomplex>
Input array. - dim (Optional)
- Type: System.Int32
[Optional] The index of the dimension to be reduced. Default: (-1) the first non-singleton dimension found in A or 0. - keepdim (Optional)
- Type: System.Boolean
[Optional] True: reduced singleton dimension is not removed from the output (default). False: the new singleton dimension is removed.
Return Value
Type: RetArray<fcomplex>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]
See Also