AlgorithmUtil

Description

static class Tinman.Core.AlgorithmUtil

Helper class that provides some commonly used algorithms for element sequences.

Algorithms that use IComparable or IEquatable are provided in three variants, where each variant is identified by the name suffix:

*Default :
The algorithm uses a generic delegate to operate on the elements, which may cause virtual calls or boxing at runtime.
*Object :
The algorithm makes null-safe use of the natural semantic of the element objects, which may cause virtual calls at runtime. Special overloads exist for the string type, which make use of StringUtil.Compare, in order to provide the same behaviour (independently of platform, culture, etc.).
*Value :
The algorithm makes direct use of the natural semantic of the element values.

Public / Methods

Choose

[Pure]
public static method Choose → (5) → <T>

idx ⁱⁿ : int32: [0..3]
The index.
idx0 ⁱⁿ : T: The value to return if idx ⁱⁿ is 0.
idx1 ⁱⁿ : T: The value to return if idx ⁱⁿ is 1.
idx2 ⁱⁿ : T: The value to return if idx ⁱⁿ is 2.
idx3 ⁱⁿ : T: The value to return if idx ⁱⁿ is 3.
returns → T: The value chosen by idx ⁱⁿ.

Chooses one of the four values by the given index.

SearchBinaryDefault

[Pure]
public static method SearchBinaryDefault → (5) → <T>

value ⁱⁿ : T: The value to search.
array ⁱⁿ : T [ ]: [not-null]
The array, which must be sorted in ascending order, according to compare ⁱⁿ.
compare ⁱⁿ : CompareDelegate<T>: [not-null]
The compare to use.
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to search.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to search. If -1, all remaining elements will be used.
returns → int32: Index of the array element that equals value ⁱⁿ. If the value has not been found in the array, -idx-1 is returned, where idx is the insertion index of value ⁱⁿ.

Runs a binary search for value ⁱⁿ in the given array.

See also: CompareDelegate

SearchBinaryObject

_2 overloads

[Pure]
public static method SearchBinaryObject¹ → (4)
→ <T ^ref : IComparable<T>>

value ⁱⁿ : T: The value to search.
array ⁱⁿ : T [ ]: [not-null]
The array, which must be sorted in ascending order, according to SystemUtil.CompareObject.
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to search.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to search. If -1, all remaining elements will be used.
returns → int32: Index of the array element that equals value ⁱⁿ. If the value has not been found in the array, -idx-1 is returned, where idx is the insertion index of value ⁱⁿ.

Runs a binary search for value ⁱⁿ in the given array.

See also: SystemUtil.CompareObject

[Pure]
public static method SearchBinaryObject² → (4)

value ⁱⁿ : string: The value to search.
array ⁱⁿ : string [ ]: [not-null]
The array, which must be sorted in ascending order, according to StringUtil.Compare.
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to search.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to search. If -1, all remaining elements will be used.
returns → int32: Index of the array element that equals value ⁱⁿ. If the value has not been found in the array, -idx-1 is returned, where idx is the insertion index of value ⁱⁿ.

Runs a binary search for value ⁱⁿ in the given array.

See also: StringUtil.Compare

SearchBinaryValue

[Pure]
public static method SearchBinaryValue → (4)
→ <T ^val : IComparable<T>>

value ⁱⁿ : T: The value to search.
array ⁱⁿ : T [ ]: [not-null]
The array, which must be sorted in ascending order, according to SystemUtil.CompareValue.
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to search.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to search. If -1, all remaining elements will be used.
returns → int32: Index of the array element that equals value ⁱⁿ. If the value has not been found in the array, -idx-1 is returned, where idx is the insertion index of value ⁱⁿ.

Runs a binary search for value ⁱⁿ in the given array.

See also: SystemUtil.CompareValue

SearchLinearDefault

[Pure]
public static method SearchLinearDefault → (5) → <T>

value ⁱⁿ : T: The value to find in array ⁱⁿ.
array ⁱⁿ : T [ ]: [not-null]
The array to search.
equals ^opt : EqualsDelegate<T> = null: Optional equality compare. If null, SystemUtil.EqualsDefault will be used.
offset ^opt : int32 = 0: [0..array.Length]
Offset into array ⁱⁿ to first element to search.
count ^opt : int32 = -1: [-1..array.Length-offset]
Number of elements in array ⁱⁿ to search. If -1, all remaining elements will be searched.
returns → int32: The index of the found array element or -1 iff not found.

Finds the smallest index of the array element that is equal to the given value, according to equals ^opt.

See also: EqualsDelegate

SearchLinearObject

[Pure]
public static method SearchLinearObject → (4)
→ <T ^ref : IEquatable<T>>

value ⁱⁿ : T: The value to find in array ⁱⁿ.
array ⁱⁿ : T [ ]: [not-null]
The array to search.
offset ^opt : int32 = 0: [0..array.Length]
Offset into array ⁱⁿ to first element to search.
count ^opt : int32 = -1: [-1..array.Length-offset]
Number of elements in array ⁱⁿ to search. If -1, all remaining elements will be searched.
returns → int32: The index of the found array element or -1 iff not found.

Finds the smallest index of the array element that is equal to the given value.

See also: SystemUtil.EqualsObject

SearchLinearValue

[Pure]
public static method SearchLinearValue → (4)
→ <T ^val : IEquatable<T>>

value ⁱⁿ : T: The value to find in array ⁱⁿ.
array ⁱⁿ : T [ ]: [not-null]
The array to search.
offset ^opt : int32 = 0: [0..array.Length]
Offset into array ⁱⁿ to first element to search.
count ^opt : int32 = -1: [-1..array.Length-offset]
Number of elements in array ⁱⁿ to search. If -1, all remaining elements will be searched.
returns → int32: The index of the found array element or -1 iff not found.

Finds the smallest index of the array element that is equal to the given value.

See also: SystemUtil.EqualsValue

Shuffle

_2 overloads

public static method Shuffle¹ → (4) → <T>

random ⁱⁿ : RandomNumber: [not-null]
The random number generator to use.
array ⁱⁿ : T [ ]: [not-null]
The array to shuffle.
offset ^opt : int32 = 0: [0..array.Length]
Offset to first element in array ⁱⁿ to shuffle. Defaults to 0.
count ^opt : int32 = -1: [-1..array.Length-offset]
Number of elements to shuffle, beginning at offset ^opt. If -1, all elements up to the end of the array ⁱⁿ will be shuffled.

Shuffles the elements of the given array randomly.

public static method Shuffle² → (4) → <T>

random ⁱⁿ : RandomNumber: [not-null]
The random number generator to use.
list ⁱⁿ : IVector<T>: [not-null]
The list to shuffle.
offset ^opt : int32 = 0: [0..list.Count]
Offset to first element in list ⁱⁿ to shuffle.
count ^opt : int32 = -1: [-1..list.Count-offset]
Number of elements to shuffle, beginning at offset ^opt. If -1, all elements up to the end of the list ⁱⁿ will be shuffled.

Shuffles the elements of the given list randomly.

SortArrayDefault

public static method SortArrayDefault → (4) → <T>

array ⁱⁿ : T [ ]: [not-null]
The array that holds the range to sort.
comparer ⁱⁿ : CompareDelegate<T>: [not-null]
The compare to use.
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to sort.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to sort. If -1, all remaining elements will be used.

Sorts the given array range.

The method uses an unstable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: CompareDelegate

SortArrayObject

_2 overloads

public static method SortArrayObject¹ → (3)
→ <T ^ref : IComparable<T>>

array ⁱⁿ : T [ ]: [not-null]
The array that holds the range to sort.
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to sort.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to sort. If -1, all remaining elements will be used.

Sorts the given array range.

The method uses an unstable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: SystemUtil.CompareObject

public static method SortArrayObject² → (3)

array ⁱⁿ : string [ ]: [not-null]
The array that holds the range to sort.
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to sort.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to sort. If -1, all remaining elements will be used.

Sorts the given array range.

The method uses an unstable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: StringUtil.Compare

SortArrayValue

public static method SortArrayValue → (3)
→ <T ^val : IComparable<T>>

array ⁱⁿ : T [ ]: [not-null]
The array that holds the range to sort.
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to sort.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to sort. If -1, all remaining elements will be used.

Sorts the given array range.

The method uses an unstable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: SystemUtil.CompareValue

SortIndexArrayDefault

public static method SortIndexArrayDefault → (5) → <T>

array ⁱⁿ : T [ ]: [not-null]
The array that holds the elements to compare. This array will not be modified.
indices ⁱⁿ : int32 [ ]: [not-null]
The array indices to be sorted (the values in this array are used to access array ⁱⁿ).
comparer ⁱⁿ : CompareDelegate<T>: [not-null]
The compare to use.
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to sort.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to sort. If -1, all remaining elements will be used.

Sorts the given array range.

The method uses a stable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: CompareDelegate

SortIndexArrayObject

_2 overloads

public static method SortIndexArrayObject¹ → (4)
→ <T ^ref : IComparable<T>>

array ⁱⁿ : T [ ]: [not-null]
The array that holds the elements to compare. This array will not be modified.
indices ⁱⁿ : int32 [ ]: [not-null]
The array indices to be sorted (the values in this array are used to access array ⁱⁿ).
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to sort.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to sort. If -1, all remaining elements will be used.

Sorts the given array range.

The method uses a stable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: SystemUtil.CompareObject

public static method SortIndexArrayObject² → (4)

array ⁱⁿ : string [ ]: [not-null]
The array that holds the elements to compare. This array will not be modified.
indices ⁱⁿ : int32 [ ]: [not-null]
The array indices to be sorted (the values in this array are used to access array ⁱⁿ).
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to sort.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to sort. If -1, all remaining elements will be used.

Sorts the given array range.

The method uses a stable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: StringUtil.Compare

SortIndexArrayValue

public static method SortIndexArrayValue → (4)
→ <T ^val : IComparable<T>>

array ⁱⁿ : T [ ]: [not-null]
The array that holds the elements to compare. This array will not be modified.
indices ⁱⁿ : int32 [ ]: [not-null]
The array indices to be sorted (the values in this array are used to access array ⁱⁿ).
offset ^opt : int32 = 0: [0..array.Length]
Index of first array element to sort.
count ^opt : int32 = -1: [-1..array.Length-offset]
Length of array range to sort. If -1, all remaining elements will be used.

Sorts the given array range.

The method uses a stable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: SystemUtil.CompareValue

SortListDefault

public static method SortListDefault → (4) → <T>

list ⁱⁿ : IVector<T>: [not-null]
The list that holds the range to sort.
comparer ⁱⁿ : CompareDelegate<T>: [not-null]
The compare to use.
offset ^opt : int32 = 0: [0..list.Count]
Index of first list element to sort.
count ^opt : int32 = -1: [-1..list.Count-offset]
Length of list range to sort. If -1, all remaining elements will be used.

Sorts the given list range.

The method uses an unstable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: CompareDelegate

SortListObject

_2 overloads

public static method SortListObject¹ → (3)
→ <T ^ref : IComparable<T>>

list ⁱⁿ : IVector<T>: [not-null]
The list that holds the range to sort.
offset ^opt : int32 = 0: [0..list.Count]
Index of first list element to sort.
count ^opt : int32 = -1: [-1..list.Count-offset]
Length of list range to sort. If -1, all remaining elements will be used.

Sorts the given list range.

The method uses an unstable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: SystemUtil.CompareObject

public static method SortListObject² → (3)

list ⁱⁿ : IVector<string>: [not-null]
The list that holds the range to sort.
offset ^opt : int32 = 0: [0..list.Count]
Index of first list element to sort.
count ^opt : int32 = -1: [-1..list.Count-offset]
Length of list range to sort. If -1, all remaining elements will be used.

Sorts the given list range.

The method uses an unstable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: StringUtil.Compare

SortListValue

public static method SortListValue → (3)
→ <T ^val : IComparable<T>>

list ⁱⁿ : IVector<T>: [not-null]
The list that holds the range to sort.
offset ^opt : int32 = 0: [0..list.Count]
Index of first list element to sort.
count ^opt : int32 = -1: [-1..list.Count-offset]
Length of list range to sort. If -1, all remaining elements will be used.

Sorts the given list range.

The method uses an unstable hybrid quicksort (median-3 pivot) / insertion sort algorithm.

See also: SystemUtil.CompareValue

SortTuple4

_2 overloads

[Pure]
public static method SortTuple4¹ → (4)

d0 ⁱⁿ : int64: First value to sort.
d1 ⁱⁿ : int64: Second value to sort.
d2 ⁱⁿ : int64: Third value to sort.
d3 ⁱⁿ : int64: Fourth value to sort.
returns → int32: Bits 0..1 : sort order index of d0 ⁱⁿ
Bits 2..3 : sort order index of d1 ⁱⁿ
Bits 4..5 : sort order index of d2 ⁱⁿ
Bits 6..7 : sort order index of d3 ⁱⁿ

Sorts the given values.

[Pure]
public static method SortTuple4² → (4)

d0 ⁱⁿ : float64: First value to sort.
d1 ⁱⁿ : float64: Second value to sort.
d2 ⁱⁿ : float64: Third value to sort.
d3 ⁱⁿ : float64: Fourth value to sort.
returns → int32: Bits 0..1 : sort order index of d0 ⁱⁿ
Bits 2..3 : sort order index of d1 ⁱⁿ
Bits 4..5 : sort order index of d2 ⁱⁿ
Bits 6..7 : sort order index of d3 ⁱⁿ

Sorts the given values.

SortTuple4Default

[Pure]
public static method SortTuple4Default → (5) → <T>

d0 ⁱⁿ : T: First value to sort.
d1 ⁱⁿ : T: Second value to sort.
d2 ⁱⁿ : T: Third value to sort.
d3 ⁱⁿ : T: Fourth value to sort.
compare ⁱⁿ : CompareDelegate<T>: [not-null]
The compare to use.
returns → Vec4I: The sort order:
Vec4I.X: sort order index of d0 ⁱⁿ
Vec4I.Y: sort order index of d1 ⁱⁿ
Vec4I.Z: sort order index of d2 ⁱⁿ
Vec4I.W: sort order index of d3 ⁱⁿ

Sorts the given values.

See also: CompareDelegate

SortTuple4Value

[Pure]
public static method SortTuple4Value → (4)
→ <T ^val : IComparable<T>>

d0 ⁱⁿ : T: First value to sort.
d1 ⁱⁿ : T: Second value to sort.
d2 ⁱⁿ : T: Third value to sort.
d3 ⁱⁿ : T: Fourth value to sort.
returns → Vec4I: The sort order:
Vec4I.X: sort order index of d0 ⁱⁿ
Vec4I.Y: sort order index of d1 ⁱⁿ
Vec4I.Z: sort order index of d2 ⁱⁿ
Vec4I.W: sort order index of d3 ⁱⁿ

Sorts the given values.

See also: SystemUtil.CompareValue

SortTuple8

_2 overloads

[Pure]
public static method SortTuple8¹ → (8)

d0 ⁱⁿ : int64: First value to sort.
d1 ⁱⁿ : int64: Second value to sort.
d2 ⁱⁿ : int64: Third value to sort.
d3 ⁱⁿ : int64: Fourth value to sort.
d4 ⁱⁿ : int64: Fifth value to sort.
d5 ⁱⁿ : int64: Sixth value to sort.
d6 ⁱⁿ : int64: Seventh value to sort.
d7 ⁱⁿ : int64: Eighth value to sort.
returns → int32: Bits 0.. 2 : sort order index of d0 ⁱⁿ
Bits 3.. 5 : sort order index of d1 ⁱⁿ
Bits 6.. 8 : sort order index of d2 ⁱⁿ
Bits 9..11 : sort order index of d3 ⁱⁿ
Bits 12..14 : sort order index of d4 ⁱⁿ
Bits 15..17 : sort order index of d5 ⁱⁿ
Bits 18..20 : sort order index of d6 ⁱⁿ
Bits 21..23 : sort order index of d7 ⁱⁿ

Sorts the given values.

[Pure]
public static method SortTuple8² → (8)

d0 ⁱⁿ : float64: First value to sort.
d1 ⁱⁿ : float64: Second value to sort.
d2 ⁱⁿ : float64: Third value to sort.
d3 ⁱⁿ : float64: Fourth value to sort.
d4 ⁱⁿ : float64: Fifth value to sort.
d5 ⁱⁿ : float64: Sixth value to sort.
d6 ⁱⁿ : float64: Seventh value to sort.
d7 ⁱⁿ : float64: Eighth value to sort.
returns → int32: Bits 0.. 2 : sort order index of d0 ⁱⁿ
Bits 3.. 5 : sort order index of d1 ⁱⁿ
Bits 6.. 8 : sort order index of d2 ⁱⁿ
Bits 9..11 : sort order index of d3 ⁱⁿ
Bits 12..14 : sort order index of d4 ⁱⁿ
Bits 15..17 : sort order index of d5 ⁱⁿ
Bits 18..20 : sort order index of d6 ⁱⁿ
Bits 21..23 : sort order index of d7 ⁱⁿ

Sorts the given values.

AlgorithmUtil

Description

Public / Methods

Choose

Search​Binary​Default

Search​Binary​Object

Search​Binary​Value

Search​Linear​Default

Search​Linear​Object

Search​Linear​Value

Shuffle

Sort​Array​Default

Sort​Array​Object

Sort​Array​Value

Sort​Index​Array​Default

Sort​Index​Array​Object

Sort​Index​Array​Value

Sort​List​Default

Sort​List​Object

Sort​List​Value

Sort​Tuple4

Sort​Tuple4​Default

Sort​Tuple4​Value

Sort​Tuple8

SearchBinaryDefault

SearchBinaryObject

SearchBinaryValue

SearchLinearDefault

SearchLinearObject

SearchLinearValue

SortArrayDefault

SortArrayObject

SortArrayValue

SortIndexArrayDefault

SortIndexArrayObject

SortIndexArrayValue

SortListDefault

SortListObject

SortListValue

SortTuple4

SortTuple4Default

SortTuple4Value

SortTuple8