BinaryAggregator<T1, T2, TResult>.TryAggregateWhere Method

Definition

Namespace: Numerics.NET.DataAnalysis
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.1.5

Overload List

TryAggregateWhere<TPredicate>(IEnumerable<T1>, IEnumerable<T2>, TPredicate, Boolean, TResult)	Aggregates the elements of two sequences pairwise subject to a predicate, and returns the result.
TryAggregateWhere<TPredicate>(ReadOnlySpan<T1>, ReadOnlySpan<T2>, TPredicate, Boolean, TResult)	Aggregates the elements of two spans pairwise and returns the result.
TryAggregateWhere<TPredicate>(Vector<T1>, Vector<T2>, TPredicate, Boolean, TResult)	Aggregates the elements of a vector and returns the result.
TryAggregateWhere<TPredicate>(Int32, ReadOnlySpanSlice<T1>, ReadOnlySpanSlice<T2>, TPredicate, Boolean, TResult)	Aggregates the elements of two span slices pairwise and returns the result.

TryAggregateWhere<TPredicate>(IEnumerable<T1>, IEnumerable<T2>, TPredicate, Boolean, TResult)

Aggregates the elements of two sequences pairwise subject to a predicate, and returns the result.

public virtual bool TryAggregateWhere<TPredicate>(
	IEnumerable<T1> values1,
	IEnumerable<T2> values2,
	TPredicate predicate,
	bool skipMissingValues,
	out TResult result
)
where TPredicate : struct, new(), IFastFunc<T1, T2, bool>

Visual Basic

Public Overridable Function TryAggregateWhere(Of TPredicate As {Structure, New, IFastFunc(Of T1, T2, Boolean)}) ( 
	values1 As IEnumerable(Of T1),
	values2 As IEnumerable(Of T2),
	predicate As TPredicate,
	skipMissingValues As Boolean,
	<OutAttribute> ByRef result As TResult
) As Boolean

C++/CLI

public:
generic<typename TPredicate>
where TPredicate : value class, gcnew(), IFastFunc<T1, T2, bool>
virtual bool TryAggregateWhere(
	IEnumerable<T1>^ values1, 
	IEnumerable<T2>^ values2, 
	TPredicate predicate, 
	bool skipMissingValues, 
	[OutAttribute] TResult% result
)

abstract TryAggregateWhere : 
        values1 : IEnumerable<'T1> * 
        values2 : IEnumerable<'T2> * 
        predicate : 'TPredicate * 
        skipMissingValues : bool * 
        result : 'TResult byref -> bool  when 'TPredicate : struct, new() and IFastFunc<'T1, 'T2, bool>
override TryAggregateWhere : 
        values1 : IEnumerable<'T1> * 
        values2 : IEnumerable<'T2> * 
        predicate : 'TPredicate * 
        skipMissingValues : bool * 
        result : 'TResult byref -> bool  when 'TPredicate : struct, new() and IFastFunc<'T1, 'T2, bool>

Parameters

values1 IEnumerable<T1>: A vector of values.
values2 IEnumerable<T2>: A vector of values.
predicate TPredicate: The predicate that determines whether a given input is to be included in the aggregation.
skipMissingValues Boolean: Specifies whether missing values should be excluded from the aggregation.
result TResult: The result of the aggregation.

Type Parameters

TPredicate: The type of predicate.

Return Value

Boolean
true if the aggregation produced a result; otherwise false.

Remarks

predicate is evaluated for each pair of corresponding elements of values1 and values2. If the result is true, then the values are included in the aggregation.

TryAggregateWhere<TPredicate>(ReadOnlySpan<T1>, ReadOnlySpan<T2>, TPredicate, Boolean, TResult)

Aggregates the elements of two spans pairwise and returns the result.

public abstract bool TryAggregateWhere<TPredicate>(
	ReadOnlySpan<T1> values1,
	ReadOnlySpan<T2> values2,
	TPredicate predicate,
	bool skipMissingValues,
	out TResult result
)
where TPredicate : struct, new(), IFastFunc<T1, T2, bool>

Visual Basic

Public MustOverride Function TryAggregateWhere(Of TPredicate As {Structure, New, IFastFunc(Of T1, T2, Boolean)}) ( 
	values1 As ReadOnlySpan(Of T1),
	values2 As ReadOnlySpan(Of T2),
	predicate As TPredicate,
	skipMissingValues As Boolean,
	<OutAttribute> ByRef result As TResult
) As Boolean

C++/CLI

public:
generic<typename TPredicate>
where TPredicate : value class, gcnew(), IFastFunc<T1, T2, bool>
virtual bool TryAggregateWhere(
	ReadOnlySpan<T1> values1, 
	ReadOnlySpan<T2> values2, 
	TPredicate predicate, 
	bool skipMissingValues, 
	[OutAttribute] TResult% result
) abstract

abstract TryAggregateWhere : 
        values1 : ReadOnlySpan<'T1> * 
        values2 : ReadOnlySpan<'T2> * 
        predicate : 'TPredicate * 
        skipMissingValues : bool * 
        result : 'TResult byref -> bool  when 'TPredicate : struct, new() and IFastFunc<'T1, 'T2, bool>

Parameters

values1 ReadOnlySpan<T1>: A span of values.
values2 ReadOnlySpan<T2>: A span of values.
predicate TPredicate: The predicate that determines whether a given input is to be included in the aggregation.
skipMissingValues Boolean: Specifies whether missing values should be excluded from the aggregation.
result TResult: The result of the aggregation.

Type Parameters

TPredicate: The type of predicate.

Return Value

Boolean
true if the aggregation produced a result; otherwise false.

Remarks

predicate is evaluated for each pair of corresponding elements of values1 and values2. If the result is true, then the values are included in the aggregation.

TryAggregateWhere<TPredicate>(Vector<T1>, Vector<T2>, TPredicate, Boolean, TResult)

Aggregates the elements of a vector and returns the result.

public virtual bool TryAggregateWhere<TPredicate>(
	Vector<T1> values1,
	Vector<T2> values2,
	TPredicate predicate,
	bool skipMissingValues,
	out TResult result
)
where TPredicate : struct, new(), IFastFunc<T1, T2, bool>

Visual Basic

Public Overridable Function TryAggregateWhere(Of TPredicate As {Structure, New, IFastFunc(Of T1, T2, Boolean)}) ( 
	values1 As Vector(Of T1),
	values2 As Vector(Of T2),
	predicate As TPredicate,
	skipMissingValues As Boolean,
	<OutAttribute> ByRef result As TResult
) As Boolean

C++/CLI

public:
generic<typename TPredicate>
where TPredicate : value class, gcnew(), IFastFunc<T1, T2, bool>
virtual bool TryAggregateWhere(
	Vector<T1>^ values1, 
	Vector<T2>^ values2, 
	TPredicate predicate, 
	bool skipMissingValues, 
	[OutAttribute] TResult% result
)

abstract TryAggregateWhere : 
        values1 : Vector<'T1> * 
        values2 : Vector<'T2> * 
        predicate : 'TPredicate * 
        skipMissingValues : bool * 
        result : 'TResult byref -> bool  when 'TPredicate : struct, new() and IFastFunc<'T1, 'T2, bool>
override TryAggregateWhere : 
        values1 : Vector<'T1> * 
        values2 : Vector<'T2> * 
        predicate : 'TPredicate * 
        skipMissingValues : bool * 
        result : 'TResult byref -> bool  when 'TPredicate : struct, new() and IFastFunc<'T1, 'T2, bool>

Parameters

values1 Vector<T1>: A vector of values.
values2 Vector<T2>: A vector of values.
predicate TPredicate: The predicate that determines whether a given input is to be included in the aggregation.
skipMissingValues Boolean: Specifies whether missing values should be excluded from the aggregation.
result TResult: The result of the aggregation.

Type Parameters

TPredicate: The type of predicate.

Return Value

Boolean
true if the aggregation produced a result; otherwise false.

TryAggregateWhere<TPredicate>(Int32, ReadOnlySpanSlice<T1>, ReadOnlySpanSlice<T2>, TPredicate, Boolean, TResult)

Aggregates the elements of two span slices pairwise and returns the result.

public abstract bool TryAggregateWhere<TPredicate>(
	int length,
	ReadOnlySpanSlice<T1> values1,
	ReadOnlySpanSlice<T2> values2,
	TPredicate predicate,
	bool skipMissingValues,
	out TResult result
)
where TPredicate : struct, new(), IFastFunc<T1, T2, bool>

Visual Basic

Public MustOverride Function TryAggregateWhere(Of TPredicate As {Structure, New, IFastFunc(Of T1, T2, Boolean)}) ( 
	length As Integer,
	values1 As ReadOnlySpanSlice(Of T1),
	values2 As ReadOnlySpanSlice(Of T2),
	predicate As TPredicate,
	skipMissingValues As Boolean,
	<OutAttribute> ByRef result As TResult
) As Boolean

C++/CLI

public:
generic<typename TPredicate>
where TPredicate : value class, gcnew(), IFastFunc<T1, T2, bool>
virtual bool TryAggregateWhere(
	int length, 
	ReadOnlySpanSlice<T1> values1, 
	ReadOnlySpanSlice<T2> values2, 
	TPredicate predicate, 
	bool skipMissingValues, 
	[OutAttribute] TResult% result
) abstract

abstract TryAggregateWhere : 
        length : int * 
        values1 : ReadOnlySpanSlice<'T1> * 
        values2 : ReadOnlySpanSlice<'T2> * 
        predicate : 'TPredicate * 
        skipMissingValues : bool * 
        result : 'TResult byref -> bool  when 'TPredicate : struct, new() and IFastFunc<'T1, 'T2, bool>

Parameters

length Int32: The number of elements to include in the aggregation.
values1 ReadOnlySpanSlice<T1>: A span of values.
values2 ReadOnlySpanSlice<T2>: A span of values.
predicate TPredicate: The predicate that determines whether a given input is to be included in the aggregation.
skipMissingValues Boolean: Specifies whether missing values should be excluded from the aggregation.
result TResult: The result of the aggregation.

Type Parameters

TPredicate: The type of predicate.

Return Value

Boolean
true if the aggregation produced a result; otherwise false.

Remarks

predicate is evaluated for each pair of corresponding elements of values1 and values2. If the result is true, then the values are included in the aggregation.

BinaryAggregator<T1, T2, TResult>.TryAggregateWhere Method

Definition

Overload List

TryAggregateWhere<TPredicate>(IEnumerable<T1>, IEnumerable<T2>, TPredicate, Boolean, TResult)

Parameters

Type Parameters

Return Value

Remarks

TryAggregateWhere<TPredicate>(ReadOnlySpan<T1>, ReadOnlySpan<T2>, TPredicate, Boolean, TResult)

Parameters

Type Parameters

Return Value

Remarks

TryAggregateWhere<TPredicate>(Vector<T1>, Vector<T2>, TPredicate, Boolean, TResult)

Parameters

Type Parameters

Return Value

TryAggregateWhere<TPredicate>(Int32, ReadOnlySpanSlice<T1>, ReadOnlySpanSlice<T2>, TPredicate, Boolean, TResult)

Parameters

Type Parameters

Return Value

Remarks

See Also

Reference