Functions: M¶

14 functions (22 overloads) on BasicRuntime.Functions starting with M.

A B C D E F G H I K L M N O P Q R S T U W X Z

MAT¶

Overload 1

static void Functions.MAT(ref DimensionedArray array, DynamicArray value)

Performs the mat operation using the supplied array, value.


Kind	Method (static)
Returns	`void`
Use case	Call Functions.MAT(...) directly (no instance required) when your code needs to perform the mat operation using the supplied array, value.

How this member is tested

Act: Functions.MAT(ref /* a valid DimensionedArray value */, /* a valid DynamicArray value */)
Assert: no exception is thrown and the expected side effect occurred.

Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).

Overload 2

static void Functions.MAT(ref DimensionedArray array1, DimensionedArray array2)

Performs the mat operation using the supplied array1, array2.


Kind	Method (static)
Returns	`void`
Use case	Call Functions.MAT(...) directly (no instance required) when your code needs to perform the mat operation using the supplied array1, array2.

How this member is tested

Act: Functions.MAT(ref /* a valid DimensionedArray value */, /* a valid DimensionedArray value */)
Assert: no exception is thrown and the expected side effect occurred.

Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).

MATBUILD¶

6 overloads

Overload 1

static DynamicArray Functions.MATBUILD(DimensionedArray array)

Performs the matbuild operation using the supplied array.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MATBUILD(...) directly (no instance required) when your code needs to perform the matbuild operation using the supplied array.

How this member is tested

Act: var result = Functions.MATBUILD(/* a valid DimensionedArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 2

static DynamicArray Functions.MATBUILD(DimensionedArray array, int start)

Performs the matbuild operation using the supplied array, start.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MATBUILD(...) directly (no instance required) when your code needs to perform the matbuild operation using the supplied array, start.

How this member is tested

Act: var result = Functions.MATBUILD(/* a valid DimensionedArray value */, 1)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 3

static DynamicArray Functions.MATBUILD(DimensionedArray array, int start, DynamicArray delimiter)

Performs the matbuild operation using the supplied array, start, delimiter.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MATBUILD(...) directly (no instance required) when your code needs to perform the matbuild operation using the supplied array, start, delimiter.

How this member is tested

Act: var result = Functions.MATBUILD(/* a valid DimensionedArray value */, 1, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 4

static DynamicArray Functions.MATBUILD(DimensionedArray array, DynamicArray delimiter)

Performs the matbuild operation using the supplied array, delimiter.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MATBUILD(...) directly (no instance required) when your code needs to perform the matbuild operation using the supplied array, delimiter.

How this member is tested

Act: var result = Functions.MATBUILD(/* a valid DimensionedArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 5

static DynamicArray Functions.MATBUILD(DimensionedArray array, int start, int end)

Performs the matbuild operation using the supplied array, start, end.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MATBUILD(...) directly (no instance required) when your code needs to perform the matbuild operation using the supplied array, start, end.

How this member is tested

Act: var result = Functions.MATBUILD(/* a valid DimensionedArray value */, 1, 1)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 6

static DynamicArray Functions.MATBUILD(DimensionedArray array, int start, int end, string delimiter)

Performs the matbuild operation using the supplied array, start, end, delimiter.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MATBUILD(...) directly (no instance required) when your code needs to perform the matbuild operation using the supplied array, start, end, delimiter.

How this member is tested

Act: var result = Functions.MATBUILD(/* a valid DimensionedArray value */, 1, 1, "sample")
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

MATCHFIELD¶

1 overload

static DynamicArray Functions.MATCHFIELD(string value, string pattern, int field)

Performs the matchfield operation using the supplied value, pattern, field.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MATCHFIELD(...) directly (no instance required) when your code needs to perform the matchfield operation using the supplied value, pattern, field.

How this member is tested

Act: var result = Functions.MATCHFIELD("sample", "sample", 1)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

MATPARSE¶

3 overloads

Overload 1

static DynamicArray Functions.MATPARSE(ref DimensionedArray array, DynamicArray value)

Performs the matparse operation using the supplied array, value.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MATPARSE(...) directly (no instance required) when your code needs to perform the matparse operation using the supplied array, value.

How this member is tested

Act: var result = Functions.MATPARSE(ref /* a valid DimensionedArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 2

static DynamicArray Functions.MATPARSE(ref DimensionedArray array, DynamicArray value, string delimiter)

Performs the matparse operation using the supplied array, value, delimiter.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MATPARSE(...) directly (no instance required) when your code needs to perform the matparse operation using the supplied array, value, delimiter.

How this member is tested

Act: var result = Functions.MATPARSE(ref /* a valid DimensionedArray value */, /* a valid DynamicArray value */, "sample")
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 3

static DynamicArray Functions.MATPARSE(ref DimensionedArray array, DynamicArray value, int startposition, int endposition, string delimiter)

Performs the matparse operation using the supplied array, value, startposition, endposition, delimiter.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MATPARSE(...) directly (no instance required) when your code needs to perform the matparse operation using the supplied array, value, startposition, endposition, delimiter.

How this member is tested

Act: var result = Functions.MATPARSE(ref /* a valid DimensionedArray value */, /* a valid DynamicArray value */, 1, 1, "sample")
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

MATREAD¶

1 overload

static bool Functions.MATREAD(DynamicArray fileVariable, DynamicArray key, DimensionedArray record, bool lockRecord, bool throwLockedException, bool throwErrorException)

Performs the matread operation using the supplied fileVariable, key, record, lockRecord, throwLockedException, throwErrorException.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.MATREAD(...) directly (no instance required) when your code needs to perform the matread operation using the supplied fileVariable, key, record, lockRecord, throwLockedException, throwErrorException.

How this member is tested

Act: var result = Functions.MATREAD(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DimensionedArray value */, true, true, true)
Assert: result matches the expected true/false outcome.

Expected: Returns true or false, indicating the outcome of the matread check for the given input.

MATWRITE¶

1 overload

static bool Functions.MATWRITE(DynamicArray fileVariable, DynamicArray key, DimensionedArray record, bool lockRecord, bool throwLockedException, bool throwErrorException)

Performs the matwrite operation using the supplied fileVariable, key, record, lockRecord, throwLockedException, throwErrorException.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.MATWRITE(...) directly (no instance required) when your code needs to perform the matwrite operation using the supplied fileVariable, key, record, lockRecord, throwLockedException, throwErrorException.

How this member is tested

Act: var result = Functions.MATWRITE(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DimensionedArray value */, true, true, true)
Assert: result matches the expected true/false outcome.

Expected: Returns true or false, indicating the outcome of the matwrite check for the given input.

MAX¶

1 overload

static DynamicArray Functions.MAX(DynamicArray value1, DynamicArray value2)

Performs the max operation using the supplied value1, value2.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MAX(...) directly (no instance required) when your code needs to perform the max operation using the supplied value1, value2.

How this member is tested

Act: var result = Functions.MAX(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

MAXIMUM¶

1 overload

static DynamicArray Functions.MAXIMUM(DynamicArray value)

Performs the maximum operation using the supplied value.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MAXIMUM(...) directly (no instance required) when your code needs to perform the maximum operation using the supplied value.

How this member is tested

Act: var result = Functions.MAXIMUM(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

MESSAGE¶

1 overload

static bool Functions.MESSAGE(DynamicArray[] msgParams)

Performs the message operation using the supplied msgParams.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.MESSAGE(...) directly (no instance required) when your code needs to perform the message operation using the supplied msgParams.

How this member is tested

Act: var result = Functions.MESSAGE(/* a populated collection */)
Assert: result matches the expected true/false outcome.

Expected: Returns true or false, indicating the outcome of the message check for the given input.

MINIMUM¶

1 overload

static DynamicArray Functions.MINIMUM(DynamicArray value)

Performs the minimum operation using the supplied value.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MINIMUM(...) directly (no instance required) when your code needs to perform the minimum operation using the supplied value.

How this member is tested

Act: var result = Functions.MINIMUM(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

MKDIR¶

1 overload

static DynamicArray Functions.MKDIR(DynamicArray directoryName)

Performs the mkdir operation using the supplied directoryName.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MKDIR(...) directly (no instance required) when your code needs to perform the mkdir operation using the supplied directoryName.

How this member is tested

Act: var result = Functions.MKDIR(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

MOD¶

1 overload

static DynamicArray Functions.MOD(DynamicArray value, DynamicArray divisor)

Performs the mod operation using the supplied value, divisor.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MOD(...) directly (no instance required) when your code needs to perform the mod operation using the supplied value, divisor.

How this member is tested

Act: var result = Functions.MOD(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

MODS¶

1 overload

static DynamicArray Functions.MODS(DynamicArray value, DynamicArray value2)

Performs the mods operation using the supplied value, value2.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MODS(...) directly (no instance required) when your code needs to perform the mods operation using the supplied value, value2.

How this member is tested

Act: var result = Functions.MODS(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

MULS¶

1 overload

static DynamicArray Functions.MULS(DynamicArray array1, DynamicArray array2)

Performs the muls operation using the supplied array1, array2.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.MULS(...) directly (no instance required) when your code needs to perform the muls operation using the supplied array1, array2.

How this member is tested

Act: var result = Functions.MULS(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.