TensorBackEnd.Any Method

Definition

Namespace: Numerics.NET.Tensors
Assembly: Numerics.NET.Tensors (in Numerics.NET.Tensors.dll) Version: 9.0.0

Overload List

Any(Tensor<Boolean>, Tensor<Boolean>)	Returns whether any elements of a boolean tensor are true.
Any(Tensor<Boolean>, Axes, Tensor<Boolean>, Boolean, Tensor<Boolean>, TensorElementOrder)	Computes whether any elements of a boolean tensor along the specified axis are true.
Any<T, TPredicate>(TPredicate, Tensor<T>, Tensor<Boolean>, Boolean)	Returns whether any elements of a tensor satisfy a predicate.
Any<T, TPredicate>(TPredicate, Tensor<T>, Axes, Tensor<Boolean>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)	Computes whether any elements of a tensor along the specified axis satisfy a predicate.
Any<T1, T2, TPredicate>(TPredicate, Tensor<T1>, Tensor<T2>, Tensor<Boolean>)	Returns whether any elements of a pair of tensors satisfy a predicate.

Any(Tensor<Boolean>, Tensor<Boolean>)

Returns whether any elements of a boolean tensor are true.

public virtual bool Any(
	Tensor<bool> operand,
	Tensor<bool>? mask = null
)

Visual Basic

Public Overridable Function Any ( 
	operand As Tensor(Of Boolean),
	Optional mask As Tensor(Of Boolean) = Nothing
) As Boolean

C++/CLI

public:
virtual bool Any(
	Tensor<bool>^ operand, 
	Tensor<bool>^ mask = nullptr
)

abstract Any : 
        operand : Tensor<bool> * 
        ?mask : Tensor<bool> 
(* Defaults:
        let _mask = defaultArg mask null
*)
-> bool 
override Any : 
        operand : Tensor<bool> * 
        ?mask : Tensor<bool> 
(* Defaults:
        let _mask = defaultArg mask null
*)
-> bool

Parameters

operand Tensor<Boolean>: The tensor that contains the elements to check.
mask Tensor<Boolean> (Optional): Optional. A boolean that specifies which elements should be included in the operation. If null (the default), all elements are included.

Return Value

Boolean
true if any elements that satisfy mask are true; otherwise false.

Any<T, TPredicate>(TPredicate, Tensor<T>, Tensor<Boolean>, Boolean)

Returns whether any elements of a tensor satisfy a predicate.

public abstract bool Any<T, TPredicate>(
	TPredicate predicate,
	Tensor<T> operand,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false
)
where TPredicate : struct, new(), IFastFunc<T, bool>

Visual Basic

Public MustOverride Function Any(Of T, TPredicate As {Structure, New, IFastFunc(Of T, Boolean)}) ( 
	predicate As TPredicate,
	operand As Tensor(Of T),
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional skipMissingValues As Boolean = false
) As Boolean

C++/CLI

public:
generic<typename T, typename TPredicate>
where TPredicate : value class, gcnew(), IFastFunc<T, bool>
virtual bool Any(
	TPredicate predicate, 
	Tensor<T>^ operand, 
	Tensor<bool>^ mask = nullptr, 
	bool skipMissingValues = false
) abstract

abstract Any : 
        predicate : 'TPredicate * 
        operand : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> bool  when 'TPredicate : struct, new() and IFastFunc<'T, bool>

Parameters

predicate TPredicate: The predicate that the elements must satisfy.
operand Tensor<T>: The tensor that contains the elements to check.
mask Tensor<Boolean> (Optional): Optional. A boolean that specifies which elements should be included in the operation. If null (the default), any elements are included.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the evaluation. The default is false.

Type Parameters

T
TPredicate

Return Value

Boolean
true if any elements that satisfy mask also satisfy predicate; otherwise false.

Any<T1, T2, TPredicate>(TPredicate, Tensor<T1>, Tensor<T2>, Tensor<Boolean>)

Returns whether any elements of a pair of tensors satisfy a predicate.

public abstract bool Any<T1, T2, TPredicate>(
	TPredicate predicate,
	Tensor<T1> tensor1,
	Tensor<T2> tensor2,
	Tensor<bool>? mask = null
)
where TPredicate : struct, new(), IFastFunc<T1, T2, bool>

Visual Basic

Public MustOverride Function Any(Of T1, T2, TPredicate As {Structure, New, IFastFunc(Of T1, T2, Boolean)}) ( 
	predicate As TPredicate,
	tensor1 As Tensor(Of T1),
	tensor2 As Tensor(Of T2),
	Optional mask As Tensor(Of Boolean) = Nothing
) As Boolean

C++/CLI

public:
generic<typename T1, typename T2, typename TPredicate>
where TPredicate : value class, gcnew(), IFastFunc<T1, T2, bool>
virtual bool Any(
	TPredicate predicate, 
	Tensor<T1>^ tensor1, 
	Tensor<T2>^ tensor2, 
	Tensor<bool>^ mask = nullptr
) abstract

abstract Any : 
        predicate : 'TPredicate * 
        tensor1 : Tensor<'T1> * 
        tensor2 : Tensor<'T2> * 
        ?mask : Tensor<bool> 
(* Defaults:
        let _mask = defaultArg mask null
*)
-> bool  when 'TPredicate : struct, new() and IFastFunc<'T1, 'T2, bool>

Parameters

predicate TPredicate: The predicate that the elements must satisfy.
tensor1 Tensor<T1>: The tensor that contains the elements to check.
tensor2 Tensor<T2>: The tensor that contains the elements to check.
mask Tensor<Boolean> (Optional): Optional. A boolean that specifies which elements should be included in the operation. If null (the default), all elements are included.

Type Parameters

T1
T2
TPredicate

Return Value

Boolean
true if any elements that satisfy mask also satisfy predicate; otherwise false.

Any(Tensor<Boolean>, Axes, Tensor<Boolean>, Boolean, Tensor<Boolean>, TensorElementOrder)

Computes whether any elements of a boolean tensor along the specified axis are true.

public virtual Tensor<bool> Any(
	Tensor<bool> operand,
	Axes axis,
	Tensor<bool>? result = null,
	bool keepDimensions = false,
	Tensor<bool>? mask = null,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Overridable Function Any ( 
	operand As Tensor(Of Boolean),
	axis As Axes,
	Optional result As Tensor(Of Boolean) = Nothing,
	Optional keepDimensions As Boolean = false,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of Boolean)

C++/CLI

public:
virtual Tensor<bool>^ Any(
	Tensor<bool>^ operand, 
	Axes axis, 
	Tensor<bool>^ result = nullptr, 
	bool keepDimensions = false, 
	Tensor<bool>^ mask = nullptr, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract Any : 
        operand : Tensor<bool> * 
        axis : Axes * 
        ?result : Tensor<bool> * 
        ?keepDimensions : bool * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _keepDimensions = defaultArg keepDimensions false
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<bool> 
override Any : 
        operand : Tensor<bool> * 
        axis : Axes * 
        ?result : Tensor<bool> * 
        ?keepDimensions : bool * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _keepDimensions = defaultArg keepDimensions false
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<bool>

Parameters

operand Tensor<Boolean>: A boolean tensor.
axis Axes: The axis along which to sum the elements. The default is 0.
result Tensor<Boolean> (Optional): Optional. The tensor that is to hold the result. May be null.
keepDimensions Boolean (Optional): Optional. Specifies whether the reduced axis should be retained in the result. The default is false.
mask Tensor<Boolean> (Optional): Optional. A boolean that specifies for which elements the operation should be performed. If null (the default), the operation is applied everywhere.
order TensorElementOrder (Optional): Optional. Specifies the element order of the result. By default, elements are stored in the order of operand.

Return Value

Tensor<Boolean>
A tensor containing a value that indicates whether any elements of operand that satisfy mask along axis are true.

Any<T, TPredicate>(TPredicate, Tensor<T>, Axes, Tensor<Boolean>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)

Computes whether any elements of a tensor along the specified axis satisfy a predicate.

public virtual Tensor<bool> Any<T, TPredicate>(
	TPredicate predicate,
	Tensor<T> operand,
	Axes axis,
	Tensor<bool>? result = null,
	bool keepDimensions = false,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false,
	TensorElementOrder order = TensorElementOrder.Automatic
)
where TPredicate : struct, new(), IFastFunc<T, bool>

Visual Basic

Public Overridable Function Any(Of T, TPredicate As {Structure, New, IFastFunc(Of T, Boolean)}) ( 
	predicate As TPredicate,
	operand As Tensor(Of T),
	axis As Axes,
	Optional result As Tensor(Of Boolean) = Nothing,
	Optional keepDimensions As Boolean = false,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional skipMissingValues As Boolean = false,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of Boolean)

C++/CLI

public:
generic<typename T, typename TPredicate>
where TPredicate : value class, gcnew(), IFastFunc<T, bool>
virtual Tensor<bool>^ Any(
	TPredicate predicate, 
	Tensor<T>^ operand, 
	Axes axis, 
	Tensor<bool>^ result = nullptr, 
	bool keepDimensions = false, 
	Tensor<bool>^ mask = nullptr, 
	bool skipMissingValues = false, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract Any : 
        predicate : 'TPredicate * 
        operand : Tensor<'T> * 
        axis : Axes * 
        ?result : Tensor<bool> * 
        ?keepDimensions : bool * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _keepDimensions = defaultArg keepDimensions false
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<bool>  when 'TPredicate : struct, new() and IFastFunc<'T, bool>
override Any : 
        predicate : 'TPredicate * 
        operand : Tensor<'T> * 
        axis : Axes * 
        ?result : Tensor<bool> * 
        ?keepDimensions : bool * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _keepDimensions = defaultArg keepDimensions false
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<bool>  when 'TPredicate : struct, new() and IFastFunc<'T, bool>

Parameters

predicate TPredicate: The predicate that the elements must satisfy.
operand Tensor<T>: A boolean tensor.
axis Axes: The axis along which to sum the elements. The default is 0.
result Tensor<Boolean> (Optional): Optional. The tensor that is to hold the result. May be null.
keepDimensions Boolean (Optional): Optional. Specifies whether the reduced axis should be retained in the result. The default is false.
mask Tensor<Boolean> (Optional): Optional. A boolean that specifies which elements should be included in the operation. If null (the default), all elements are included.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the evaluation. The default is false.
order TensorElementOrder (Optional): Optional. Specifies the element order of the result. By default, elements are stored in the order of operand.

Type Parameters

T
TPredicate

Return Value

Tensor<Boolean>
A tensor containing a value that indicates whether any elements of operand that satisfy mask along axis also satisfy predicate.

TensorBackEnd.Any Method

Definition

Overload List

Any(Tensor<Boolean>, Tensor<Boolean>)

Parameters

Return Value

Any<T, TPredicate>(TPredicate, Tensor<T>, Tensor<Boolean>, Boolean)

Parameters

Type Parameters

Return Value

Any<T1, T2, TPredicate>(TPredicate, Tensor<T1>, Tensor<T2>, Tensor<Boolean>)

Parameters

Type Parameters

Return Value

Any(Tensor<Boolean>, Axes, Tensor<Boolean>, Boolean, Tensor<Boolean>, TensorElementOrder)

Parameters

Return Value

Any<T, TPredicate>(TPredicate, Tensor<T>, Axes, Tensor<Boolean>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)

Parameters

Type Parameters

Return Value

See Also

Reference