ExtensionMethodsall Method (ConcreteArrayByte, ArrayByte, InArrayByte, OutArrayByte, RetArrayByte, StorageByte, Int32, Boolean)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Tests for all elements of A along the dimension 'axis' being non-zero.

[ILNumerics numpy Module]

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

Syntax

public static RetLogical all(
	this ConcreteArray<byte, Array<byte>, InArray<byte>, OutArray<byte>, RetArray<byte>, Storage<byte>> A,
	int axis,
	bool keepdims = false
)

<ExtensionAttribute>
Public Shared Function all ( 
	A As ConcreteArray(Of Byte, Array(Of Byte), InArray(Of Byte), OutArray(Of Byte), RetArray(Of Byte), Storage(Of Byte)),
	axis As Integer,
	Optional keepdims As Boolean = false
) As RetLogical

Dim A As ConcreteArray(Of Byte, Array(Of Byte), InArray(Of Byte), OutArray(Of Byte), RetArray(Of Byte), Storage(Of Byte))
Dim axis As Integer
Dim keepdims As Boolean
Dim returnValue As RetLogical

returnValue = A.all(axis, keepdims)

Parameters

A: Type: ILNumerics.Core.ArraysConcreteArrayByte, ArrayByte, InArrayByte, OutArrayByte, RetArrayByte, StorageByte
The source array. This will not be altered.
axis: Type: SystemInt32
The dimension of A to work along.
keepdims (Optional): Type: SystemBoolean
[Optional] the reduced dimension axis remains in the resulting array. Default: (false) the dimension axis is removed from the result.

Return Value

Type: RetLogical
Logical array with the same shape of A, except dimension 'axis' which is reduced / expanded to length 1.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArrayByte, ArrayByte, InArrayByte, OutArrayByte, RetArrayByte, StorageByte. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentException	if axis is smaller than -A.S.NumberOfDimensions or larger or equal to A.S.NumberOfDimensions.

Remarks

Depending on the value of keepdims the array returned will have the same number of dimensions as A (keepdims = true) or with a number of dimensions according to MinNumberOfArrayDimensions (keepdims = false).

Empty arrays A produce a scalar array with the default element value for the element data type (false).

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

all Overload

ILNumerics Namespace

ExtensionMethodsany(ConcreteArrayByte, ArrayByte, InArrayByte, OutArrayByte, RetArrayByte, StorageByte, Int32, Boolean)

ExtensionMethodsprod(ConcreteArrayByte, ArrayByte, InArrayByte, OutArrayByte, RetArrayByte, StorageByte, Boolean)

ExtensionMethodssum(ConcreteArrayByte, ArrayByte, InArrayByte, OutArrayByte, RetArrayByte, StorageByte, Int32, Boolean)