Aggregator<T, TResult>.TryAggregate Method

Definition

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

Overload List

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

TryAggregate(Vector<T>, TResult)

Aggregates the elements of a vector and returns the result.

public virtual bool TryAggregate(
	Vector<T> values,
	out TResult result
)

Visual Basic

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

C++/CLI

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

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

Parameters

values Vector<T>: A vector of values.
result TResult: On return, the result of the aggregation.

Return Value

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

TryAggregate(IEnumerable<T>, Boolean, TResult)

Aggregates the elements of a sequence and returns the result.

public bool TryAggregate(
	IEnumerable<T> values,
	bool skipMissingValues,
	out TResult result
)

Visual Basic

Public Function TryAggregate ( 
	values As IEnumerable(Of T),
	skipMissingValues As Boolean,
	<OutAttribute> ByRef result As TResult
) As Boolean

C++/CLI

public:
bool TryAggregate(
	IEnumerable<T>^ values, 
	bool skipMissingValues, 
	[OutAttribute] TResult% result
)

member TryAggregate : 
        values : IEnumerable<'T> * 
        skipMissingValues : bool * 
        result : 'TResult byref -> bool

Parameters

values IEnumerable<T>: A sequence of values.
skipMissingValues Boolean: Specifies whether missing values should be excluded from the aggregation.
result TResult: On return, the result of the aggregation.

Return Value

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

TryAggregate(ReadOnlySpan<T>, Boolean, TResult)

Aggregates the elements of a vector and returns the result.

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

Visual Basic

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

C++/CLI

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

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

Parameters

values ReadOnlySpan<T>: A read-only span of values.
skipMissingValues Boolean: Specifies whether missing values should be excluded from the aggregation.
result TResult: On return, the result of the aggregation.

Return Value

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

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

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

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

Visual Basic

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

C++/CLI

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

member TryAggregate : 
        values : Vector<'T> * 
        startIndex : int * 
        endIndex : int * 
        result : 'TResult 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 TResult: On return, the result of the aggregation.

Return Value

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

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

Aggregates the elements of a vector and returns the result.

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

Visual Basic

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

C++/CLI

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

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

Parameters

length Int32: The number of elements to aggregate.
values ReadOnlySpan<T>: A read-only span of values.
stride Int32: The distance between successive elements in values.
skipMissingValues Boolean: Specifies whether missing values should be excluded from the aggregation.
result TResult: On return, the result of the aggregation.

Return Value

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

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

Aggregates the elements of a vector and returns the result.

public bool TryAggregate(
	int length,
	ReadOnlySpan<T> values,
	int stride,
	ReadOnlySpan<bool> mask,
	int maskStride,
	bool skipMissingValues,
	out TResult result
)

Visual Basic

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

C++/CLI

public:
bool TryAggregate(
	int length, 
	ReadOnlySpan<T> values, 
	int stride, 
	ReadOnlySpan<bool> mask, 
	int maskStride, 
	bool skipMissingValues, 
	[OutAttribute] TResult% result
)

member TryAggregate : 
        length : int * 
        values : ReadOnlySpan<'T> * 
        stride : int * 
        mask : ReadOnlySpan<bool> * 
        maskStride : int * 
        skipMissingValues : bool * 
        result : 'TResult byref -> bool

Parameters

length Int32: The number of elements to aggregate.
values ReadOnlySpan<T>: A read-only span of values.
stride Int32: The distance between successive elements in values.
mask ReadOnlySpan<Boolean>: A read-only span of booleans.
maskStride Int32: The distance between successive elements in mask.
skipMissingValues Boolean: Specifies whether missing values should be excluded from the aggregation.
result TResult: On return, the result of the aggregation.

Return Value

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

Aggregator<T, TResult>.TryAggregate Method

Definition

Overload List

TryAggregate(Vector<T>, TResult)

Parameters

Return Value

TryAggregate(IEnumerable<T>, Boolean, TResult)

Parameters

Return Value

TryAggregate(ReadOnlySpan<T>, Boolean, TResult)

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

See Also

Reference