ExtensionMethods.any Method (ConcreteArray<UInt32, Array<UInt32>, InArray<UInt32>, OutArray<UInt32>, RetArray<UInt32>, Storage<UInt32>>, Int32, Boolean)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Tests for any elements of A 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 any(
	this ConcreteArray<uint, Array<uint>, InArray<uint>, OutArray<uint>, RetArray<uint>, Storage<uint>> A,
	int axis,
	bool keepdims = false
)

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

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

returnValue = A.any(axis, keepdims)

Parameters

A: Type: ILNumerics.Core.Arrays.ConcreteArray<UInt32, Array<UInt32>, InArray<UInt32>, OutArray<UInt32>, RetArray<UInt32>, Storage<UInt32>>
The source array. This will not be altered.
axis: Type: System.Int32
The dimension of A to work along.
keepdims (Optional): Type: System.Boolean
[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 ConcreteArray<UInt32, Array<UInt32>, InArray<UInt32>, OutArray<UInt32>, RetArray<UInt32>, Storage<UInt32>>. 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.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

any Overload

ILNumerics Namespace

ExtensionMethods.all(ConcreteArray<UInt32, Array<UInt32>, InArray<UInt32>, OutArray<UInt32>, RetArray<UInt32>, Storage<UInt32>>, Int32, Boolean)

ExtensionMethods.prod(ConcreteArray<UInt32, Array<UInt32>, InArray<UInt32>, OutArray<UInt32>, RetArray<UInt32>, Storage<UInt32>>, Boolean)

ExtensionMethods.sum(ConcreteArray<UInt32, Array<UInt32>, InArray<UInt32>, OutArray<UInt32>, RetArray<UInt32>, Storage<UInt32>>, Int32, Boolean)