TypePreservingAggregatorGroup.TryAggregate Method

Definition

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

Overload List

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

TryAggregate<TResult>(IVector, TResult)

Aggregates the elements of a vector and returns the result.
C#
public bool TryAggregate<TResult>(
	IVector values,
	out TResult result
)

Parameters

values  IVector
A vector of values.
result  TResult
On return, the result of the aggregation.

Type Parameters

TResult

Return Value

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

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

Aggregates the elements of a vector and returns the result.
C#
public bool TryAggregate<TResult>(
	Vector<TResult> values,
	out TResult result
)

Parameters

values  Vector<TResult>
A vector of values.
result  TResult
The result of the aggregation.

Type Parameters

TResult
The element type of the vector.

Return Value

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

TryAggregate<TResult>(IEnumerable<TResult>, Boolean, TResult)

Aggregates the elements of a sequence and returns the result.
C#
public bool TryAggregate<TResult>(
	IEnumerable<TResult> values,
	bool skipMissingValues,
	out TResult result
)

Parameters

values  IEnumerable<TResult>
A sequence of values.
skipMissingValues  Boolean
Indicates whether missing values should be filtered from the sequence.
result  TResult
The result of the aggregation.

Type Parameters

TResult

Return Value

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

TryAggregate<TResult>(IVector, Int32, Int32, TResult)

Aggregates the specified range of elements of a vector and returns the result.
C#
public bool TryAggregate<TResult>(
	IVector values,
	int startIndex,
	int endIndex,
	out TResult result
)

Parameters

values  IVector
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
The result of the aggregation.

Type Parameters

TResult

Return Value

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

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

Aggregates the specified range of elements of a vector and returns the result.
C#
public bool TryAggregate<TResult>(
	Vector<TResult> values,
	int startIndex,
	int endIndex,
	out TResult result
)

Parameters

values  Vector<TResult>
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
The result of the aggregation.

Type Parameters

TResult

Return Value

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

See Also