[ILNumerics Computing Engine]
Namespace: ILNumerics
Assembly: ILNumerics.Computing (in ILNumerics.Computing.dll) Version: 5.5.0.0 (5.5.7503.3146)
Parameters
- A
- Type: ILNumericsBaseArrayByte
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: RetLogicalNew array with the same shape as A except that the dimension specified by dim is reduced to length 1.
For floating point elements: special floating point values (NaN, PositiveInfinity, etc.; being 'not zero') evaluate to 'true'.
Empty arrays are allowed. In difference to sum(BaseArraySingle, Int32, Boolean) or prod(BaseArraySingle, Int32, Boolean) dimension dim may be of length 0, which leads to a singleton dimension in the result and the non-existing elements evaluate to 'false'.
The default value for dim is -1. It causes the function to determine the working dimension (numpy: 'axis') automatically. This search is based on WorkingDimension and starts looking at the first dimension for ArrayStyleILNumericsV4. For ArrayStylenumpy, however, the search starts with the last dimension and works its way up to the first dimension. If the array does not contain any non-singleton dimension 0 is returned in both cases.
[ILNumerics Computing Engine]