Aggregator<T, U>.TryAggregate Method

Definition

Namespace: Extreme.DataAnalysis
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

TryAggregate(ReadOnlySpan<T>, U)	Aggregates the elements of a vector and returns the result.
TryAggregate(Vector<T>, U)	Aggregates the elements of a vector and returns the result.
TryAggregate(IEnumerable<T>, Boolean, U)	Aggregates the elements of a sequence and returns the result.
TryAggregate(ReadOnlySpan<T>, Int32, U)	Aggregates the elements of a vector and returns the result.
TryAggregate(ReadOnlySpan<T>, Int32, Func<T, Boolean>, U)	Aggregates the elements of a vector and returns the result.
TryAggregate(Vector<T>, Array1D<Int32>, Int32, U)	Aggregates the specified elements of a vector and returns the result.
TryAggregate(Vector<T>, Int32, Int32, U)	Aggregates the specified range of elements of a vector and returns the result.
TryAggregate(ReadOnlySpan<T>, Int32, ReadOnlySpan<Boolean>, Int32, U)	Aggregates the elements of a vector and returns the result.

TryAggregate(ReadOnlySpan<T>, U)

Aggregates the elements of a vector and returns the result.

public virtual bool TryAggregate(
	ReadOnlySpan<T> values,
	out U result
)

Visual Basic

Public Overridable Function TryAggregate ( 
	values As ReadOnlySpan(Of T),
	<OutAttribute> ByRef result As U
) As Boolean

C++/CLI

public:
virtual bool TryAggregate(
	ReadOnlySpan<T> values, 
	[OutAttribute] U% result
)

abstract TryAggregate : 
        values : ReadOnlySpan<'T> * 
        result : 'U byref -> bool 
override TryAggregate : 
        values : ReadOnlySpan<'T> * 
        result : 'U byref -> bool

Parameters

values ReadOnlySpan<T>: A read-only span of values.
result U: The result of the aggregation.

Return Value

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

TryAggregate(Vector<T>, U)

Aggregates the elements of a vector and returns the result.

public abstract bool TryAggregate(
	Vector<T> values,
	out U result
)

Visual Basic

Public MustOverride Function TryAggregate ( 
	values As Vector(Of T),
	<OutAttribute> ByRef result As U
) As Boolean

C++/CLI

public:
virtual bool TryAggregate(
	Vector<T>^ values, 
	[OutAttribute] U% result
) abstract

abstract TryAggregate : 
        values : Vector<'T> * 
        result : 'U byref -> bool

Parameters

values Vector<T>: A vector of values.
result U: The result of the aggregation.

Return Value

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

TryAggregate(IEnumerable<T>, Boolean, U)

Aggregates the elements of a sequence and returns the result.

public virtual bool TryAggregate(
	IEnumerable<T> values,
	bool checkForMissingValues,
	out U result
)

Visual Basic

Public Overridable Function TryAggregate ( 
	values As IEnumerable(Of T),
	checkForMissingValues As Boolean,
	<OutAttribute> ByRef result As U
) As Boolean

C++/CLI

public:
virtual bool TryAggregate(
	IEnumerable<T>^ values, 
	bool checkForMissingValues, 
	[OutAttribute] U% result
)

abstract TryAggregate : 
        values : IEnumerable<'T> * 
        checkForMissingValues : bool * 
        result : 'U byref -> bool 
override TryAggregate : 
        values : IEnumerable<'T> * 
        checkForMissingValues : bool * 
        result : 'U byref -> bool

Parameters

values IEnumerable<T>: A sequence of values.
checkForMissingValues Boolean: Indicates whether missing values should be filtered from the sequence.
result U: The result of the aggregation.

Return Value

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

TryAggregate(ReadOnlySpan<T>, Int32, U)

Aggregates the elements of a vector and returns the result.

public abstract bool TryAggregate(
	ReadOnlySpan<T> values,
	int stride,
	out U result
)

Visual Basic

Public MustOverride Function TryAggregate ( 
	values As ReadOnlySpan(Of T),
	stride As Integer,
	<OutAttribute> ByRef result As U
) As Boolean

C++/CLI

public:
virtual bool TryAggregate(
	ReadOnlySpan<T> values, 
	int stride, 
	[OutAttribute] U% result
) abstract

abstract TryAggregate : 
        values : ReadOnlySpan<'T> * 
        stride : int * 
        result : 'U byref -> bool

Parameters

values ReadOnlySpan<T>: A read-only span of values.
stride Int32
result U: The result of the aggregation.

Return Value

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

TryAggregate(ReadOnlySpan<T>, Int32, Func<T, Boolean>, U)

Aggregates the elements of a vector and returns the result.

public abstract bool TryAggregate(
	ReadOnlySpan<T> values,
	int stride,
	Func<T, bool> predicate,
	out U result
)

Visual Basic

Public MustOverride Function TryAggregate ( 
	values As ReadOnlySpan(Of T),
	stride As Integer,
	predicate As Func(Of T, Boolean),
	<OutAttribute> ByRef result As U
) As Boolean

C++/CLI

public:
virtual bool TryAggregate(
	ReadOnlySpan<T> values, 
	int stride, 
	Func<T, bool>^ predicate, 
	[OutAttribute] U% result
) abstract

abstract TryAggregate : 
        values : ReadOnlySpan<'T> * 
        stride : int * 
        predicate : Func<'T, bool> * 
        result : 'U byref -> bool

Parameters

values ReadOnlySpan<T>: A read-only span of values.
stride Int32
predicate Func<T, Boolean>
result U: The result of the aggregation.

Return Value

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

TryAggregate(Vector<T>, Array1D<Int32>, Int32, U)

Aggregates the specified elements of a vector and returns the result.

public virtual bool TryAggregate(
	Vector<T> values,
	Array1D<int> indexes,
	int length,
	out U result
)

Visual Basic

Public Overridable Function TryAggregate ( 
	values As Vector(Of T),
	indexes As Array1D(Of Integer),
	length As Integer,
	<OutAttribute> ByRef result As U
) As Boolean

C++/CLI

public:
virtual bool TryAggregate(
	Vector<T>^ values, 
	Array1D<int> indexes, 
	int length, 
	[OutAttribute] U% result
)

abstract TryAggregate : 
        values : Vector<'T> * 
        indexes : Array1D<int> * 
        length : int * 
        result : 'U byref -> bool 
override TryAggregate : 
        values : Vector<'T> * 
        indexes : Array1D<int> * 
        length : int * 
        result : 'U byref -> bool

Parameters

values Vector<T>: A vector of values.
indexes Array1D<Int32>: An integer array containing the indexes of the elements of values that will be aggregated.
length Int32: The number of values to aggregate.
result U: The result of the aggregation.

Return Value

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

TryAggregate(Vector<T>, Int32, Int32, U)

Aggregates the specified range of elements of a vector and returns the result.

public virtual bool TryAggregate(
	Vector<T> values,
	int startIndex,
	int endIndex,
	out U result
)

Visual Basic

Public Overridable Function TryAggregate ( 
	values As Vector(Of T),
	startIndex As Integer,
	endIndex As Integer,
	<OutAttribute> ByRef result As U
) As Boolean

C++/CLI

public:
virtual bool TryAggregate(
	Vector<T>^ values, 
	int startIndex, 
	int endIndex, 
	[OutAttribute] U% result
)

abstract TryAggregate : 
        values : Vector<'T> * 
        startIndex : int * 
        endIndex : int * 
        result : 'U byref -> bool 
override TryAggregate : 
        values : Vector<'T> * 
        startIndex : int * 
        endIndex : int * 
        result : 'U byref -> bool

Parameters

values Vector<T>: A vector of values.
startIndex Int32: The zero-based index of the first element in values that should be aggregated.
endIndex Int32: The zero-based index of the last element in values that should be aggregated.
result U: The result of the aggregation.

Return Value

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

TryAggregate(ReadOnlySpan<T>, Int32, ReadOnlySpan<Boolean>, Int32, U)

Aggregates the elements of a vector and returns the result.

public abstract bool TryAggregate(
	ReadOnlySpan<T> values,
	int stride,
	ReadOnlySpan<bool> mask,
	int maskStride,
	out U result
)

Visual Basic

Public MustOverride Function TryAggregate ( 
	values As ReadOnlySpan(Of T),
	stride As Integer,
	mask As ReadOnlySpan(Of Boolean),
	maskStride As Integer,
	<OutAttribute> ByRef result As U
) As Boolean

C++/CLI

public:
virtual bool TryAggregate(
	ReadOnlySpan<T> values, 
	int stride, 
	ReadOnlySpan<bool> mask, 
	int maskStride, 
	[OutAttribute] U% result
) abstract

abstract TryAggregate : 
        values : ReadOnlySpan<'T> * 
        stride : int * 
        mask : ReadOnlySpan<bool> * 
        maskStride : int * 
        result : 'U byref -> bool

Parameters

values ReadOnlySpan<T>: A read-only span of values.
stride Int32
mask ReadOnlySpan<Boolean>
maskStride Int32
result U: The result of the aggregation.

Return Value

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

Aggregator<T, U>.TryAggregate Method

Definition

Overload List

TryAggregate(ReadOnlySpan<T>, U)

Parameters

Return Value

TryAggregate(Vector<T>, U)

Parameters

Return Value

TryAggregate(IEnumerable<T>, Boolean, U)

Parameters

Return Value

TryAggregate(ReadOnlySpan<T>, Int32, U)

Parameters

Return Value

TryAggregate(ReadOnlySpan<T>, Int32, Func<T, Boolean>, U)

Parameters

Return Value

TryAggregate(Vector<T>, Array1D<Int32>, Int32, U)

Parameters

Return Value

TryAggregate(Vector<T>, Int32, Int32, U)

Parameters

Return Value

TryAggregate(ReadOnlySpan<T>, Int32, ReadOnlySpan<Boolean>, Int32, U)

Parameters

Return Value

See Also

Reference