SystemUtil

Description

static class Tinman.Core.System.SystemUtil

Provides static helper method for dealing with objects.

This class provides some helper methods, dealing with the following:

Clear ranges of arrays of primitive element-types to the default value, see ArrayClear.
Copy ranges between arrays of primitive element-types, see ArrayCopy.
Comparison methods for primitive types, compatible with CompareDelegate, see Compare*.
Equality methods for primitive types, compatible with EqualsDelegate.
Helpers for object disposal: IsValid, Dispose.
Helpers for estimating memory consumption, see MemoryConsumption*.
Pin object references, for safely passing them around as IntPtr values.
Sort fixed-length sequences of values, see Sort*.
Read and write 64-bit integer values using minimal byte count (between 1 and 9), see VarInt*.

Public / Constants

DelegateCompareBool

[ShutdownSurvive]
public static readonly attribute DelegateCompareBool → (CompareDelegate<bool>)

The delegate for CompareBool.

DelegateCompareChar

[ShutdownSurvive]
public static readonly attribute DelegateCompareChar → (CompareDelegate<char>)

The delegate for CompareChar.

DelegateCompareFloat32

[ShutdownSurvive]
public static readonly attribute DelegateCompareFloat32 → (CompareDelegate<float32>)

The delegate for CompareFloat32.

DelegateCompareFloat64

[ShutdownSurvive]
public static readonly attribute DelegateCompareFloat64 → (CompareDelegate<float64>)

The delegate for CompareFloat64.

DelegateCompareInt16

[ShutdownSurvive]
public static readonly attribute DelegateCompareInt16 → (CompareDelegate<int16>)

The delegate for CompareInt16.

DelegateCompareInt32

[ShutdownSurvive]
public static readonly attribute DelegateCompareInt32 → (CompareDelegate<int32>)

The delegate for CompareInt32.

DelegateCompareInt64

[ShutdownSurvive]
public static readonly attribute DelegateCompareInt64 → (CompareDelegate<int64>)

The delegate for CompareInt64.

DelegateCompareInt8

[ShutdownSurvive]
public static readonly attribute DelegateCompareInt8 → (CompareDelegate<int8>)

The delegate for CompareInt8.

DelegateEqualsBool

[ShutdownSurvive]
public static readonly attribute DelegateEqualsBool → (EqualsDelegate<bool>)

The delegate for EqualsBool.

DelegateEqualsChar

[ShutdownSurvive]
public static readonly attribute DelegateEqualsChar → (EqualsDelegate<char>)

The delegate for EqualsChar.

DelegateEqualsFloat32

[ShutdownSurvive]
public static readonly attribute DelegateEqualsFloat32 → (EqualsDelegate<float32>)

The delegate for EqualsFloat32.

DelegateEqualsFloat64

[ShutdownSurvive]
public static readonly attribute DelegateEqualsFloat64 → (EqualsDelegate<float64>)

The delegate for EqualsFloat64.

DelegateEqualsInt16

[ShutdownSurvive]
public static readonly attribute DelegateEqualsInt16 → (EqualsDelegate<int16>)

The delegate for EqualsInt16.

DelegateEqualsInt32

[ShutdownSurvive]
public static readonly attribute DelegateEqualsInt32 → (EqualsDelegate<int32>)

The delegate for EqualsInt32.

DelegateEqualsInt64

[ShutdownSurvive]
public static readonly attribute DelegateEqualsInt64 → (EqualsDelegate<int64>)

The delegate for EqualsInt64.

DelegateEqualsInt8

[ShutdownSurvive]
public static readonly attribute DelegateEqualsInt8 → (EqualsDelegate<int8>)

The delegate for EqualsInt8.

DelegateEqualsIntPtr

[ShutdownSurvive]
public static readonly attribute DelegateEqualsIntPtr → (EqualsDelegate<IntPtr>)

The delegate for EqualsIntPtr.

DelegateHashCodeChar

[ShutdownSurvive]
public static readonly attribute DelegateHashCodeChar → (HashCodeDelegate<char>)

The default hash code delegate for char.

DelegateHashCodeFloat32

[ShutdownSurvive]
public static readonly attribute DelegateHashCodeFloat32 → (HashCodeDelegate<float32>)

The default hash code delegate for float.

DelegateHashCodeFloat64

[ShutdownSurvive]
public static readonly attribute DelegateHashCodeFloat64 → (HashCodeDelegate<float64>)

The default hash code delegate for double.

DelegateHashCodeInt32

[ShutdownSurvive]
public static readonly attribute DelegateHashCodeInt32 → (HashCodeDelegate<int32>)

The default hash code delegate for int.

DelegateHashCodeInt64

[ShutdownSurvive]
public static readonly attribute DelegateHashCodeInt64 → (HashCodeDelegate<int64>)

The default hash code delegate for long.

Public / Methods

ArrayClear

_8 overloads

public static method ArrayClear¹ → (3)

array ⁱⁿ : bool [ ]: [not-null]
The array to clear.
offset ^opt : int32 = 0: [>=0]
Offset to first element in array ⁱⁿ to clear.
count ^opt : int32 = -1: [>=-1]
Number of elements in array ⁱⁿ to clear. If -1, all remaining elements will be cleared.

Clears the elements of the given array to the default value.

public static method ArrayClear² → (3)

array ⁱⁿ : int8 [ ]: [not-null]
The array to clear.
offset ^opt : int32 = 0: [>=0]
Offset to first element in array ⁱⁿ to clear.
count ^opt : int32 = -1: [>=-1]
Number of elements in array ⁱⁿ to clear. If -1, all remaining elements will be cleared.

Clears the elements of the given array to the default value.

public static method ArrayClear³ → (3)

array ⁱⁿ : char [ ]: [not-null]
The array to clear.
offset ^opt : int32 = 0: [>=0]
Offset to first element in array ⁱⁿ to clear.
count ^opt : int32 = -1: [>=-1]
Number of elements in array ⁱⁿ to clear. If -1, all remaining elements will be cleared.

Clears the elements of the given array to the default value.

public static method ArrayClear⁴ → (3)

array ⁱⁿ : int16 [ ]: [not-null]
The array to clear.
offset ^opt : int32 = 0: [>=0]
Offset to first element in array ⁱⁿ to clear.
count ^opt : int32 = -1: [>=-1]
Number of elements in array ⁱⁿ to clear. If -1, all remaining elements will be cleared.

Clears the elements of the given array to the default value.

public static method ArrayClear⁵ → (3)

array ⁱⁿ : int32 [ ]: [not-null]
The array to clear.
offset ^opt : int32 = 0: [>=0]
Offset to first element in array ⁱⁿ to clear.
count ^opt : int32 = -1: [>=-1]
Number of elements in array ⁱⁿ to clear. If -1, all remaining elements will be cleared.

Clears the elements of the given array to the default value.

public static method ArrayClear⁶ → (3)

array ⁱⁿ : float32 [ ]: [not-null]
The array to clear.
offset ^opt : int32 = 0: [>=0]
Offset to first element in array ⁱⁿ to clear.
count ^opt : int32 = -1: [>=-1]
Number of elements in array ⁱⁿ to clear. If -1, all remaining elements will be cleared.

Clears the elements of the given array to the default value.

public static method ArrayClear⁷ → (3)

array ⁱⁿ : int64 [ ]: [not-null]
The array to clear.
offset ^opt : int32 = 0: [>=0]
Offset to first element in array ⁱⁿ to clear.
count ^opt : int32 = -1: [>=-1]
Number of elements in array ⁱⁿ to clear. If -1, all remaining elements will be cleared.

Clears the elements of the given array to the default value.

public static method ArrayClear⁸ → (3)

array ⁱⁿ : float64 [ ]: [not-null]
The array to clear.
offset ^opt : int32 = 0: [>=0]
Offset to first element in array ⁱⁿ to clear.
count ^opt : int32 = -1: [>=-1]
Number of elements in array ⁱⁿ to clear. If -1, all remaining elements will be cleared.

Clears the elements of the given array to the default value.

ArrayCopy

_8 overloads

public static method ArrayCopy¹ → (5)

source ⁱⁿ : bool [ ]: [not-null]
The source array.
sourceIdx ⁱⁿ : int32: [>=0]
Index of first element in source ⁱⁿ to copy.
target ⁱⁿ : bool [ ]: [not-null]
The target array.
targetIdx ⁱⁿ : int32: [>=0]
Index of first element in target ⁱⁿ to write.
count ⁱⁿ : int32: [>=0]
Total number of array elements to copy.

Copies elements from one array to another.

public static method ArrayCopy² → (5)

source ⁱⁿ : int8 [ ]: [not-null]
The source array.
sourceIdx ⁱⁿ : int32: [>=0]
Index of first element in source ⁱⁿ to copy.
target ⁱⁿ : int8 [ ]: [not-null]
The target array.
targetIdx ⁱⁿ : int32: [>=0]
Index of first element in target ⁱⁿ to write.
count ⁱⁿ : int32: [>=0]
Total number of array elements to copy.

Copies elements from one array to another.

public static method ArrayCopy³ → (5)

source ⁱⁿ : char [ ]: [not-null]
The source array.
sourceIdx ⁱⁿ : int32: [>=0]
Index of first element in source ⁱⁿ to copy.
target ⁱⁿ : char [ ]: [not-null]
The target array.
targetIdx ⁱⁿ : int32: [>=0]
Index of first element in target ⁱⁿ to write.
count ⁱⁿ : int32: [>=0]
Total number of array elements to copy.

Copies elements from one array to another.

public static method ArrayCopy⁴ → (5)

source ⁱⁿ : int16 [ ]: [not-null]
The source array.
sourceIdx ⁱⁿ : int32: [>=0]
Index of first element in source ⁱⁿ to copy.
target ⁱⁿ : int16 [ ]: [not-null]
The target array.
targetIdx ⁱⁿ : int32: [>=0]
Index of first element in target ⁱⁿ to write.
count ⁱⁿ : int32: [>=0]
Total number of array elements to copy.

Copies elements from one array to another.

public static method ArrayCopy⁵ → (5)

source ⁱⁿ : int32 [ ]: [not-null]
The source array.
sourceIdx ⁱⁿ : int32: [>=0]
Index of first element in source ⁱⁿ to copy.
target ⁱⁿ : int32 [ ]: [not-null]
The target array.
targetIdx ⁱⁿ : int32: [>=0]
Index of first element in target ⁱⁿ to write.
count ⁱⁿ : int32: [>=0]
Total number of array elements to copy.

Copies elements from one array to another.

public static method ArrayCopy⁶ → (5)

source ⁱⁿ : float32 [ ]: [not-null]
The source array.
sourceIdx ⁱⁿ : int32: [>=0]
Index of first element in source ⁱⁿ to copy.
target ⁱⁿ : float32 [ ]: [not-null]
The target array.
targetIdx ⁱⁿ : int32: [>=0]
Index of first element in target ⁱⁿ to write.
count ⁱⁿ : int32: [>=0]
Total number of array elements to copy.

Copies elements from one array to another.

public static method ArrayCopy⁷ → (5)

source ⁱⁿ : int64 [ ]: [not-null]
The source array.
sourceIdx ⁱⁿ : int32: [>=0]
Index of first element in source ⁱⁿ to copy.
target ⁱⁿ : int64 [ ]: [not-null]
The target array.
targetIdx ⁱⁿ : int32: [>=0]
Index of first element in target ⁱⁿ to write.
count ⁱⁿ : int32: [>=0]
Total number of array elements to copy.

Copies elements from one array to another.

public static method ArrayCopy⁸ → (5)

source ⁱⁿ : float64 [ ]: [not-null]
The source array.
sourceIdx ⁱⁿ : int32: [>=0]
Index of first element in source ⁱⁿ to copy.
target ⁱⁿ : float64 [ ]: [not-null]
The target array.
targetIdx ⁱⁿ : int32: [>=0]
Index of first element in target ⁱⁿ to write.
count ⁱⁿ : int32: [>=0]
Total number of array elements to copy.

Copies elements from one array to another.

CompareBool

[Pure]
public static method CompareBool → (2)

a ⁱⁿ : bool: The first value.
b ⁱⁿ : bool: The second value.
returns → int32: +1 : if a ⁱⁿ is greater than b ⁱⁿ,
0 : if a ⁱⁿ is equal to b ⁱⁿ,
-1 : if a ⁱⁿ is less than b ⁱⁿ.

Compares the given values.

false is less then true.

CompareChar

[Pure]
public static method CompareChar → (2)

a ⁱⁿ : char: The first value.
b ⁱⁿ : char: The second value.
returns → int32: +1 : if a ⁱⁿ is greater than b ⁱⁿ,
0 : if a ⁱⁿ is equal to b ⁱⁿ,
-1 : if a ⁱⁿ is less than b ⁱⁿ.

Compares the given values.

CompareFloat32

[Pure]
public static method CompareFloat32 → (2)

a ⁱⁿ : float32: The first value.
b ⁱⁿ : float32: The second value.
returns → int32: +1 : if a ⁱⁿ is greater than b ⁱⁿ,
0 : if a ⁱⁿ is equal to b ⁱⁿ,
-1 : if a ⁱⁿ is less than b ⁱⁿ.

Compares the given values.

CompareFloat64

[Pure]
public static method CompareFloat64 → (2)

a ⁱⁿ : float64: The first value.
b ⁱⁿ : float64: The second value.
returns → int32: +1 : if a ⁱⁿ is greater than b ⁱⁿ,
0 : if a ⁱⁿ is equal to b ⁱⁿ,
-1 : if a ⁱⁿ is less than b ⁱⁿ.

Compares the given values.

CompareInt16

[Pure]
public static method CompareInt16 → (2)

a ⁱⁿ : int16: The first value.
b ⁱⁿ : int16: The second value.
returns → int32: +1 : if a ⁱⁿ is greater than b ⁱⁿ,
0 : if a ⁱⁿ is equal to b ⁱⁿ,
-1 : if a ⁱⁿ is less than b ⁱⁿ.

Compares the given values.

CompareInt32

[Pure]
public static method CompareInt32 → (2)

a ⁱⁿ : int32: The first value.
b ⁱⁿ : int32: The second value.
returns → int32: +1 : if a ⁱⁿ is greater than b ⁱⁿ,
0 : if a ⁱⁿ is equal to b ⁱⁿ,
-1 : if a ⁱⁿ is less than b ⁱⁿ.

Compares the given values.

CompareInt64

[Pure]
public static method CompareInt64 → (2)

a ⁱⁿ : int64: The first value.
b ⁱⁿ : int64: The second value.
returns → int32: +1 : if a ⁱⁿ is greater than b ⁱⁿ,
0 : if a ⁱⁿ is equal to b ⁱⁿ,
-1 : if a ⁱⁿ is less than b ⁱⁿ.

Compares the given values.

CompareInt8

[Pure]
public static method CompareInt8 → (2)

a ⁱⁿ : int8: The first value.
b ⁱⁿ : int8: The second value.
returns → int32: +1 : if a ⁱⁿ is greater than b ⁱⁿ,
0 : if a ⁱⁿ is equal to b ⁱⁿ,
-1 : if a ⁱⁿ is less than b ⁱⁿ.

Compares the given values.

Dispose

public static method Dispose → (1)

obj ⁱⁿ : object ^own: The object or null.

Disposes the given object if it is an instance of IDisposable.

EqualsBool

public static method EqualsBool → (2)

a ⁱⁿ : bool: The first value.
b ⁱⁿ : bool: The second value.
returns → bool: true if a ⁱⁿ and b ⁱⁿ are equal,
false if they are different.

Compares the given values for equality.

EqualsChar

[Pure]
public static method EqualsChar → (2)

a ⁱⁿ : char: The first value.
b ⁱⁿ : char: The second value.
returns → bool: true if a ⁱⁿ and b ⁱⁿ are equal,
false if they are different.

Compares the given values for equality.

EqualsFloat32

[Pure]
public static method EqualsFloat32 → (2)

a ⁱⁿ : float32: The first value.
b ⁱⁿ : float32: The second value.
returns → bool: true if a ⁱⁿ and b ⁱⁿ are equal,
false if they are different.

Compares the given values for equality.

EqualsFloat64

[Pure]
public static method EqualsFloat64 → (2)

a ⁱⁿ : float64: The first value.
b ⁱⁿ : float64: The second value.
returns → bool: true if a ⁱⁿ and b ⁱⁿ are equal,
false if they are different.

Compares the given values for equality.

EqualsInt16

[Pure]
public static method EqualsInt16 → (2)

a ⁱⁿ : int16: The first value.
b ⁱⁿ : int16: The second value.
returns → bool: true if a ⁱⁿ and b ⁱⁿ are equal,
false if they are different.

Compares the given values for equality.

EqualsInt32

[Pure]
public static method EqualsInt32 → (2)

a ⁱⁿ : int32: The first value.
b ⁱⁿ : int32: The second value.
returns → bool: true if a ⁱⁿ and b ⁱⁿ are equal,
false if they are different.

Compares the given values for equality.

EqualsInt64

[Pure]
public static method EqualsInt64 → (2)

a ⁱⁿ : int64: The first value.
b ⁱⁿ : int64: The second value.
returns → bool: true if a ⁱⁿ and b ⁱⁿ are equal,
false if they are different.

Compares the given values for equality.

EqualsInt8

[Pure]
public static method EqualsInt8 → (2)

a ⁱⁿ : int8: The first value.
b ⁱⁿ : int8: The second value.
returns → bool: true if a ⁱⁿ and b ⁱⁿ are equal,
false if they are different.

Compares the given values for equality.

EqualsIntPtr

[Pure]
public static method EqualsIntPtr → (2)

a ⁱⁿ : IntPtr: The first value.
b ⁱⁿ : IntPtr: The second value.
returns → bool: true if a ⁱⁿ and b ⁱⁿ are equal,
false if they are different.

Compares the given values for equality.

GrowCapacity

[Pure]
public static method GrowCapacity → (4)

current ⁱⁿ : int32: The current capacity.
required ^opt : int64 = 0: The required capacity.
numerator ^opt : int32 = 5: Numerator of fraction to use for growing current ⁱⁿ.
denominator ^opt : int32 = 4: Denominator of fraction to use for growing current ⁱⁿ.
returns → int32: The grown capacity.

Grows the given capacity, making sure it stays within [0..2147483647] and is larger than or equal to required ^opt.

IsValid

public static method IsValid → (1)

obj ⁱⁿ : object: The object to check.
returns → bool: true if the object is valid, false if not.

Is this object valid (see remarks)?

An object is considered valid if it is in one of the following lifecycle states:

LifecycleState.Initialized
LifecycleState.Disposing (the IDisposable.Dispose method is being called).

An non-null object that does not implement the ILifecycleState interface is always valid. Null objects are always invalid.