ExtensionMethodsanyIndT Method (ConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32, BaseArrayIndT, Boolean)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Tests for any elements of A along specified dimensions 'axes' 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<IndT>(
	this ConcreteArray<int, Array<int>, InArray<int>, OutArray<int>, RetArray<int>, Storage<int>> A,
	BaseArray<IndT> axes = null,
	bool keepdims = false
)
where IndT : struct, new(), IConvertible

<ExtensionAttribute>
Public Shared Function any(Of IndT As {Structure, New, IConvertible}) ( 
	A As ConcreteArray(Of Integer, Array(Of Integer), InArray(Of Integer), OutArray(Of Integer), RetArray(Of Integer), Storage(Of Integer)),
	Optional axes As BaseArray(Of IndT) = Nothing,
	Optional keepdims As Boolean = false
) As RetLogical

Dim A As ConcreteArray(Of Integer, Array(Of Integer), InArray(Of Integer), OutArray(Of Integer), RetArray(Of Integer), Storage(Of Integer))
Dim axes As BaseArray(Of IndT)
Dim keepdims As Boolean
Dim returnValue As RetLogical

returnValue = A.any(axes, keepdims)

Parameters

A: Type: ILNumerics.Core.ArraysConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32
The source array. This will not be altered.
axes (Optional): Type: ILNumericsBaseArrayIndT
[Optional] Dimensions of A to work along. Default: (null) considers all elements of A, reducing to a scalar.
keepdims (Optional): Type: SystemBoolean
[Optional] accumulated dimensions remain in the resulting array. Default: (false) accumulated singleton dimensions are removed.

Type Parameters

IndT: Element type for axes parameter. Must be numeric.

Return Value

Type: RetLogical
A logical array with the same shape of A, except dimensions listed in 'axes' which are 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 ConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32. 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 elements of axes are smaller than -A.S.NumberOfDimensions or larger or equal to A.S.NumberOfDimensions.

Remarks

All dimension indices in axes must be a valid, non-virtual dimension index from A.

Elements of axes may be negative. Corresponding dimension indices are considered as counting from the end of the range of existing dimensions in A.

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

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.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

any Overload

ILNumerics Namespace

ExtensionMethodsall(ConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32, Int32, Boolean)

ExtensionMethodsprod(ConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32, Boolean)

ExtensionMethodssum(ConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32, Int32, Boolean)