Interpolator

RhinoList<1>
public class Interpolator : RhinoList<double>
Exposes a set of standard numeric interpolation algorithms.

Constructors

Interpolator

#Since v5.0
Constructs a new, empty Interpolator.
public Interpolator()

Interpolator

#Since v5.0
Constructs an Interpolator from a collection of numbers.
public Interpolator(
collection
Collection of numbers to duplicate.
)

Interpolator

#Since v5.0
Constructs a new Interpolator with a specified amount of numbers.
public Interpolator(
amount,
Number of values to add to this Interpolator. Must be equal to or larger than zero.
defaultValue
Number to add.
)

Interpolator

#Since v5.0
Constructs an empty Interpolator with a certain capacity.
public Interpolator(
initialCapacity
Number of items this interpolator can store without resizing.
)

Interpolator

#Since v5.0
Copy all the numbers from an existing RhinoList.
public Interpolator(
list
List to mimic.
)

Properties

Capacity

Gets or sets the total number of elements the internal data structure can hold without resizing.
public int Capacity { get; set; }
inherited fromRhinoList<T>

Count

Gets the number of elements actually contained in the List.
public int Count { get; }
inherited fromRhinoList<T>

Cyclical

#Since v5.0
Gets or sets a value indicating whether or not the values inside this Interpolator are to be treated as cyclical (i.e. circular).
public bool Cyclical { get; set; }

First

Gets or sets the first item in the list. This is synonymous to calling List[0].
public T First { get; set; }
inherited fromRhinoList<T>

Last

Gets or sets the last item in the list. This is synonymous to calling List[Count-1].
public T Last { get; set; }
inherited fromRhinoList<T>

NullCount

Gets the number of null references (Nothing in Visual Basic) in this list. If T is a ValueType, this property always return zero.
public int NullCount { get; }
inherited fromRhinoList<T>

Indexers

this[]

Gets or sets the element at the specified index.
public T this[
index
The zero-based index of the element to get or set.
] { get; set; }
inherited fromRhinoList<T>
The element at the specified index.

Methods

Add

Adds an object to the end of the List.
public void Add(
T
item
Item to append.
)
inherited fromRhinoList<T>

AddRange

Adds the elements of the specified collection to the end of the List.
public void AddRange(
collection
The collection whose elements should be added to the end of the List. The collection itself cannot be a null reference (Nothing in Visual Basic), but it can contain elements that are a null reference (Nothing in Visual Basic). Objects in collection which cannot be represented as T will throw exceptions.
)
inherited fromRhinoList<T>

AddRange

Adds the elements of the specified collection to the end of the List.
public void AddRange(
collection
The collection whose elements should be added to the end of the List. The collection itself cannot be a null reference (Nothing in Visual Basic), but it can contain elements that are a null reference (Nothing in Visual Basic), if type T is a reference type.
)
inherited fromRhinoList<T>

AsReadOnly

Constructs a read-only wrapper of this class.
public ReadOnlyCollection<T> AsReadOnly()
inherited fromRhinoList<T>
A wrapper.

BinarySearch

Searches the entire sorted List for an element using the specified comparer and returns the zero-based index of the element.
public int BinarySearch(
index,
The zero-based starting index of the range to search.
count,
The length of the range to search.
T
item,
The object to locate. The value can be a null reference (Nothing in Visual Basic) for reference types.
comparer
The IComparer(T) implementation to use when comparing elements. Or a null reference (Nothing in Visual Basic) to use the default comparer Comparer(T)::Default.
)
inherited fromRhinoList<T>
The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of Count.

BinarySearch

Searches the entire sorted List for an element using the specified comparer and returns the zero-based index of the element.
public int BinarySearch(
T
item,
The object to locate. The value can be a null reference (Nothing in Visual Basic) for reference types.
comparer
The IComparer(T) implementation to use when comparing elements. Or a null reference (Nothing in Visual Basic) to use the default comparer Comparer(T)::Default.
)
inherited fromRhinoList<T>
The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of Count.

BinarySearch

Searches the entire sorted List for an element using the default comparer and returns the zero-based index of the element.
public int BinarySearch(
T
item
The object to locate. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
inherited fromRhinoList<T>
The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of Count.

Clear

Removes all elements from the List.
public void Clear()
inherited fromRhinoList<T>

Contains

Determines whether an element is in the List.
public bool Contains(
T
item
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
inherited fromRhinoList<T>
true if item is found in the List; otherwise, false.

ConvertAll<TOutput>

Aggregates all results of a conversion function over this table into a new list.
public RhinoList<TOutput> ConvertAll<TOutput>(
Converter<T, TOutput>
converter
A conversion function that can transform from T to TOutput.
)
inherited fromRhinoList<T>
The new list.

CopyTo

Copies a range of elements from the List to a compatible one-dimensional array, starting at the specified index of the target array.
public void CopyTo(
index,
The zero-based index in the source List at which copying begins.
T[]
array,
The one-dimensional Array that is the destination of the elements copied from List. The Array must have zero-based indexing.
arrayIndex,
The zero-based index in array at which copying begins.
count
The number of elements to copy.
)
inherited fromRhinoList<T>

CopyTo

Copies the entire List to a compatible one-dimensional array, starting at the specified index of the target array.
public void CopyTo(
T[]
array,
The one-dimensional Array that is the destination of the elements copied from List. The Array must have zero-based indexing.
arrayIndex
The zero-based index in array at which copying begins.
)
inherited fromRhinoList<T>

CopyTo

Copies the entire List to a compatible one-dimensional array, starting at the beginning of the target array.
public void CopyTo(
T[]
array
The one-dimensional Array that is the destination of the elements copied from List. The Array must have zero-based indexing.
)
inherited fromRhinoList<T>

Duplicate

Returns a shallow copy of this instance. If the generic type is comprised of only value types (struct, enum, ptr), then the result will be a deep copy.
public RhinoList<T> Duplicate()
inherited fromRhinoList<T>
The duplicated list.

Exists

Determines whether the List contains elements that match the conditions defined by the specified predicate.
public bool Exists(
match
The Predicate(T) delegate that defines the conditions of the elements to search for.
)
inherited fromRhinoList<T>
true if the List contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.

Find

Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire List.
public T Find(
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
inherited fromRhinoList<T>
The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.

FindAll

Retrieves all the elements that match the conditions defined by the specified predicate.
public RhinoList<T> FindAll(
match
The Predicate(T) delegate that defines the conditions of the elements to search for.
)
inherited fromRhinoList<T>
A ON_List(T) containing all the elements that match the conditions defined by the specified predicate, if found; otherwise, an empty ON_List(T).

FindIndex

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element.
public int FindIndex(
startIndex,
The zero-based starting index of the search.
count,
The number of elements in the section to search.
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
inherited fromRhinoList<T>
The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

FindIndex

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List.
public int FindIndex(
startIndex,
The zero-based starting index of the search.
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
inherited fromRhinoList<T>
The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

FindIndex

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List.
public int FindIndex(
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
inherited fromRhinoList<T>
The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

FindLast

Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire List.
public T FindLast(
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
inherited fromRhinoList<T>
The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.

FindLastIndex

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.
public int FindLastIndex(
startIndex,
The zero-based starting index of the backward search.
count,
The number of elements in the section to search.
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
inherited fromRhinoList<T>
The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

FindLastIndex

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.
public int FindLastIndex(
startIndex,
The zero-based starting index of the backward search.
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
inherited fromRhinoList<T>
The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

FindLastIndex

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.
public int FindLastIndex(
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
inherited fromRhinoList<T>
The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

ForEach

Performs the specified action on each element of the List.
public void ForEach(
Action<T>
action
The Action(T) delegate to perform on each element of the List.
)
inherited fromRhinoList<T>

GetEnumerator

Constructs an enumerator that is capable of iterating over all items in this list.
public IEnumerator<T> GetEnumerator()
inherited fromRhinoList<T>
The new enumerator.

GetRange

Constructs a shallow copy of a range of elements in the source List.
public RhinoList<T> GetRange(
index,
The zero-based List index at which the range starts.
count
The number of elements in the range.
)
inherited fromRhinoList<T>
A shallow copy of a range of elements in the source List.

IndexOf

Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that starts at the specified index and contains the specified number of elements.
public int IndexOf(
T
item,
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
index,
The zero-based starting index of the search.
count
The number of elements in the section to search.
)
inherited fromRhinoList<T>
The zero-based index of the first occurrence of item within the entire List, if found; otherwise, -1.

IndexOf

Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element.
public int IndexOf(
T
item,
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
index
The zero-based starting index of the search.
)
inherited fromRhinoList<T>
The zero-based index of the first occurrence of item within the entire List, if found; otherwise, -1.

IndexOf

Searches for the specified object and returns the zero-based index of the first occurrence within the entire List.
public int IndexOf(
T
item
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
inherited fromRhinoList<T>
The zero-based index of the first occurrence of item within the entire List, if found; otherwise, -1.

Insert

Inserts an element into the List at the specified index.
public void Insert(
index,
The zero-based index at which item should be inserted.
T
item
The object to insert. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
inherited fromRhinoList<T>

InsertRange

Inserts the elements of a collection into the List at the specified index.
public void InsertRange(
index,
The zero-based index at which the new elements should be inserted.
collection
The collection whose elements should be inserted into the List. The collection itself cannot be a null reference (Nothing in Visual Basic), but it can contain elements that are a null reference (Nothing in Visual Basic), if type T is a reference type.
)
inherited fromRhinoList<T>

InterpolateCatmullRom

#Since v5.0
Sample the list of numbers with Catmull-Rom interpolation.
public double InterpolateCatmullRom(
t
Parameter to sample at. The integer portion of the parameter indicates the index of the left-hand value. If this Interpolator is cyclical, parameters will be wrapped.
)
The sampled value at t.

InterpolateCosine

#Since v5.0
Sample the list of numbers with cosine interpolation.
public double InterpolateCosine(
t
Parameter to sample at. The integer portion of the parameter indicates the index of the left-hand value. If this Interpolator is cyclical, parameters will be wrapped.
)
The sampled value at t.

InterpolateCubic

#Since v5.0
Sample the list of numbers with cubic interpolation.
public double InterpolateCubic(
t
Parameter to sample at. The integer portion of the parameter indicates the index of the left-hand value. If this Interpolator is cyclical, parameters will be wrapped.
)
The sampled value at t.

InterpolateLinear

#Since v5.0
Sample the list of numbers with linear interpolation.
public double InterpolateLinear(
t
Parameter to sample at. The integer portion of the parameter indicates the index of the left-hand value. If this Interpolator is cyclical, parameters will be wrapped.
)
The sampled value at t.

InterpolateNearestNeighbour

#Since v5.0
Sample the list of numbers with Nearest Neighbor interpolation.
public double InterpolateNearestNeighbour(
t
Parameter to sample at. The integer portion of the parameter indicates the index of the left-hand value. If this Interpolator is cyclical, parameters will be wrapped.
)
The sampled value at t.

LastIndexOf

Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that contains the specified number of elements and ends at the specified index.
public int LastIndexOf(
T
item,
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
index,
The zero-based starting index of the backward search.
count
The number of elements in the section to search.
)
inherited fromRhinoList<T>
The zero-based index of the last occurrence of item within the entire the List, if found; otherwise, -1.

LastIndexOf

Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that extends from the first element to the specified index.
public int LastIndexOf(
T
item,
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
index
The zero-based starting index of the backward search.
)
inherited fromRhinoList<T>
The zero-based index of the last occurrence of item within the entire the List, if found; otherwise, -1.

LastIndexOf

Searches for the specified object and returns the zero-based index of the last occurrence within the entire List.
public int LastIndexOf(
T
item
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
inherited fromRhinoList<T>
The zero-based index of the last occurrence of item within the entire the List, if found; otherwise, -1.

RemapIndex

Remap an index in the infinite range onto the List index range.
public int RemapIndex(
index
Index to remap.
)
inherited fromRhinoList<T>
Remapped index.

Remove

Removes the first occurrence of a specific object from the List.
public bool Remove(
T
item
The object to remove from the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
inherited fromRhinoList<T>
true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the List.

RemoveAll

Removes the all the elements that match the conditions defined by the specified predicate.
public int RemoveAll(
match
The Predicate(T) delegate that defines the conditions of the elements to remove.
)
inherited fromRhinoList<T>
The number of elements removed from the List.

RemoveAt

Removes the element at the specified index of the List.
public void RemoveAt(
index
The zero-based index of the element to remove.
)
inherited fromRhinoList<T>

RemoveNulls

Removes all elements from the List that are null references (Nothing in Visual Basic). This function will not do anything if T is not a Reference type.
public int RemoveNulls()
inherited fromRhinoList<T>
The number of nulls removed from the List.

RemoveRange

Removes a range of elements from the List.
public void RemoveRange(
index,
The zero-based starting index of the range of elements to remove.
count
The number of elements to remove.
)
inherited fromRhinoList<T>

Reverse

Reverses the order of the elements in the entire List.
public void Reverse()
inherited fromRhinoList<T>

Reverse

Reverses the order of the elements in the specified range.
public void Reverse(
index,
The zero-based starting index of the range to reverse.
count
The number of elements in the range to reverse.
)
inherited fromRhinoList<T>

Sort

Sorts the elements in the entire List using the default comparer.
public void Sort()
inherited fromRhinoList<T>

Sort

Sorts the elements in the entire list using the specified comparer.
public void Sort(
comparison
The System.Comparison(T) to use when comparing elements.
)
inherited fromRhinoList<T>

Sort

Sort this list based on a list of numeric keys of equal length. The keys array will not be altered.
public void Sort(
keys
Numeric keys to sort with.
)
inherited fromRhinoList<T>
Remarks: This function does not exist on the DotNET List class. David thought it was a good idea.

Sort

Sorts the elements in the entire list using the specified System.Comparison(T)
public void Sort(
comparer
The IComparer(T) implementation to use when comparing elements, or a null reference (Nothing in Visual Basic) to use the default comparer Comparer(T).Default.
)
inherited fromRhinoList<T>

Sort

Sorts the elements in a range of elements in list using the specified comparer.
public void Sort(
index,
The zero-based starting index of the range to sort.
count,
The length of the range to sort.
comparer
The IComparer(T) implementation to use when comparing elements, or a null reference (Nothing in Visual Basic) to use the default comparer Comparer(T).Default.
)
inherited fromRhinoList<T>

Sort

Sort this list based on a list of numeric keys of equal length. The keys array will not be altered.
public void Sort(
int[]
keys
Numeric keys to sort with.
)
inherited fromRhinoList<T>
Remarks: This function does not exist on the DotNET List class. David thought it was a good idea.

ToArray

Constructs an array that contains all items in this list.
public T[] ToArray()
inherited fromRhinoList<T>
An array containing all items in this list.

TrimExcess

Sets the capacity to the actual number of elements in the List, if that number is less than a threshold value.
public void TrimExcess()
inherited fromRhinoList<T>
Remarks: This function differs from the DotNET implementation of List<T> since that one only trims the excess if the excess exceeds 10% of the list length.

TrueForAll

Determines whether every element in the List matches the conditions defined by the specified predicate.
public bool TrueForAll(
match
The Predicate(T) delegate that defines the conditions to check against the elements.
)
inherited fromRhinoList<T>
true if every element in the List matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true.