Class EnumerableUtil

Namespace

Hi.Common.Collections

Assembly

HiGeom.dll

Utility class providing extension methods for enumerable collections.

public static class EnumerableUtil

Inheritance

object

EnumerableUtil

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetIntensiveItems<TItem>(IEnumerable<TItem>, double, Func<TItem, double>)

Gets a collection of items with additional interpolated items inserted where the distance between consecutive items exceeds a specified resolution.

public static IEnumerable<TItem> GetIntensiveItems<TItem>(this IEnumerable<TItem> src, double resolution, Func<TItem, double> keyFunc) where TItem : IAdditionOperators<TItem, TItem, TItem>, ISubtractionOperators<TItem, TItem, TItem>, IMultiplyOperators<TItem, double, TItem>, IDivisionOperators<TItem, double, TItem>

Parameters

src IEnumerable<TItem>

The source collection.

resolution double

The maximum allowed distance between consecutive items.

keyFunc Func<TItem, double>

A function that extracts a double value from an item, used to measure the distance between items.

Returns

IEnumerable<TItem>

A collection containing the original items and additional interpolated items where needed.

Type Parameters

TItem

The type of items in the collection, which must support arithmetic operations.

Remarks

This method ensures that the distance between consecutive items in the resulting collection does not exceed the specified resolution. When the distance between two consecutive items in the source collection exceeds the resolution, additional items are interpolated between them.

Exceptions

ArgumentOutOfRangeException

resolution is not positive (zero, negative or NaN): every gap would be divided into an unbounded number of items. Thrown by the call itself, before the enumeration starts.

InvalidOperationException

A gap cannot be filled at the resolution — it is infinite, or it would take more than MaxValue items. Thrown by the enumeration when it reaches that gap.