IntervalIndex<T>.TryLookupNearest Method

Tries to find the key nearest to the specified value in the index.

Definition

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

public override bool TryLookupNearest(
	Interval<T> key,
	Direction direction,
	out int index
)

Visual Basic

Public Overrides Function TryLookupNearest ( 
	key As Interval(Of T),
	direction As Direction,
	<OutAttribute> ByRef index As Integer
) As Boolean

C++/CLI

public:
virtual bool TryLookupNearest(
	Interval<T> key, 
	Direction direction, 
	[OutAttribute] int% index
) override

abstract TryLookupNearest : 
        key : Interval<'T> * 
        direction : Direction * 
        index : int byref -> bool 
override TryLookupNearest : 
        key : Interval<'T> * 
        direction : Direction * 
        index : int byref -> bool

Parameters

key Interval<T>: The key to locate.
direction Direction: The direction to look for the key if an exact match is not found.
index Int32: On return, if key was found, the position of key in the index; otherwise -1.

Return Value

Boolean
true if key was found in the index; otherwise false.

Remarks

This method is not supported for interval indexes.

Exceptions

NotSupportedException

Always thrown.