NativeUtilities Module

Functions and values

Function or value Description

assertDimensions functionName (aName, bName) (a, b)

Full Usage: assertDimensions functionName (aName, bName) (a, b)

Parameters:
    functionName : string
    aName : string
    bName : string
    a : int
    b : int

functionName : string
aName : string
bName : string
a : int
b : int

freeA pA

Full Usage: freeA pA

Parameters:
pA : PinnedArray<'T>

freeA2 a

Full Usage: freeA2 a

Parameters:
a : PinnedArray2<'a>

freeAA (pA, pB)

Full Usage: freeAA (pA, pB)

Parameters:
pA : PinnedArray<'T>
pB : PinnedArray<'T>

freeM pA

Full Usage: freeM pA

Parameters:
pA : PinnedArray2<'T>

freeMM (pA, pB)

Full Usage: freeMM (pA, pB)

Parameters:
pA : PinnedArray2<'T>
pB : PinnedArray2<'T>

freeMMM (pA, pB, pC)

Full Usage: freeMMM (pA, pB, pC)

Parameters:
pA : PinnedArray2<'T>
pB : PinnedArray2<'T>
pC : PinnedArray2<'T>

freeMV (pA, pB)

Full Usage: freeMV (pA, pB)

Parameters:
pA : PinnedArray2<'T>
pB : PinnedArray<'T>

freeMVV (pA, pB, pC)

Full Usage: freeMVV (pA, pB, pC)

Parameters:
pA : PinnedArray2<'T>
pB : PinnedArray<'T>
pC : PinnedArray<'T>

freeV pA

Full Usage: freeV pA

Parameters:
pA : PinnedArray<'T>

freeVV (pA, pB)

Full Usage: freeVV (pA, pB)

Parameters:
pA : PinnedArray<'T>
pB : PinnedArray<'T>

matrixDim1 m

Full Usage: matrixDim1 m

Parameters:
Returns: int
m : Matrix<'a>
Returns: int

matrixDim2 m

Full Usage: matrixDim2 m

Parameters:
Returns: int
m : Matrix<'a>
Returns: int

matrixDims m

Full Usage: matrixDims m

Parameters:
Returns: int * int
m : Matrix<'a>
Returns: int * int

nativeArray_as_CMatrix_colvec arr

Full Usage: nativeArray_as_CMatrix_colvec arr

Parameters:
Returns: CMatrix<'T>
arr : NativeArray<'T>
Returns: CMatrix<'T>

nativeArray_as_FortranMatrix_colvec arr

Full Usage: nativeArray_as_FortranMatrix_colvec arr

Parameters:
Returns: FortranMatrix<'T>
arr : NativeArray<'T>
Returns: FortranMatrix<'T>

pinA arr

Full Usage: pinA arr

Parameters:
    arr : 'a[]

Returns: PinnedArray<'a>
arr : 'a[]
Returns: PinnedArray<'a>

pinA2 arr

Full Usage: pinA2 arr

Parameters:
    arr : 'a[,]

Returns: PinnedArray2<'a>
arr : 'a[,]
Returns: PinnedArray2<'a>

pinAA v1 v2

Full Usage: pinAA v1 v2

Parameters:
    v1 : 'a[]
    v2 : 'b[]

Returns: PinnedArray<'a> * PinnedArray<'b>
v1 : 'a[]
v2 : 'b[]
Returns: PinnedArray<'a> * PinnedArray<'b>

pinM m

Full Usage: pinM m

Parameters:
Returns: PinnedArray2<'a>
m : Matrix<'a>
Returns: PinnedArray2<'a>

pinMM m1 m2

Full Usage: pinMM m1 m2

Parameters:
Returns: PinnedArray2<'a> * PinnedArray2<'b>
m1 : Matrix<'a>
m2 : Matrix<'b>
Returns: PinnedArray2<'a> * PinnedArray2<'b>

pinMMM m1 m2 m3

Full Usage: pinMMM m1 m2 m3

Parameters:
Returns: PinnedArray2<'a> * PinnedArray2<'b> * PinnedArray2<'c>
m1 : Matrix<'a>
m2 : Matrix<'b>
m3 : Matrix<'c>
Returns: PinnedArray2<'a> * PinnedArray2<'b> * PinnedArray2<'c>

pinMV m1 v2

Full Usage: pinMV m1 v2

Parameters:
Returns: PinnedArray2<'a> * PinnedArray<'b>
m1 : Matrix<'a>
v2 : Vector<'b>
Returns: PinnedArray2<'a> * PinnedArray<'b>

pinMVV m1 v2 m3

Full Usage: pinMVV m1 v2 m3

Parameters:
Returns: PinnedArray2<'a> * PinnedArray<'b> * PinnedArray<'c>
m1 : Matrix<'a>
v2 : Vector<'b>
m3 : Vector<'c>
Returns: PinnedArray2<'a> * PinnedArray<'b> * PinnedArray<'c>

pinV v

Full Usage: pinV v

Parameters:
Returns: PinnedArray<'a>
v : Vector<'a>
Returns: PinnedArray<'a>

pinVV v1 v2

Full Usage: pinVV v1 v2

Parameters:
Returns: PinnedArray<'a> * PinnedArray<'b>
v1 : Vector<'a>
v2 : Vector<'b>
Returns: PinnedArray<'a> * PinnedArray<'b>

vectorDim v

Full Usage: vectorDim v

Parameters:
Returns: int
v : Vector<'a>
Returns: int