Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
object SGCoeffs
Link copied to clipboard
actual class SincMatrix(rowMajArray: DoubleArray, m: Int, n: Int)
expect class SincMatrix(rowMajArray: DoubleArray, m: Int, n: Int)
actual class SincMatrix(rowMajArray: DoubleArray, m: Int, n: Int)

Properties

Link copied to clipboard
Link copied to clipboard

Returns a value if the matrix is scalar otherwise throws an error.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
actual val SincMatrix.numCols: Int
expect val SincMatrix.numCols: Int
actual val SincMatrix.numCols: Int
Link copied to clipboard
actual val SincMatrix.numel: Int
expect val SincMatrix.numel: Int
actual val SincMatrix.numel: Int
Link copied to clipboard
actual val SincMatrix.numRows: Int
expect val SincMatrix.numRows: Int
actual val SincMatrix.numRows: Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Returns a value if the matrix is scalar otherwise throws an error.

Link copied to clipboard
Link copied to clipboard

Matrix transpose

Link copied to clipboard

Functions

Link copied to clipboard
actual fun SincMatrix.abs(): SincMatrix
expect fun SincMatrix.abs(): SincMatrix
actual fun SincMatrix.abs(): SincMatrix
Link copied to clipboard
fun SincMatrix.acf(numLags: Int): SincMatrix

Citation: Matlab central

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Create a row vector by indexing elements row by row

Link copied to clipboard
Link copied to clipboard
fun DoubleArray.asSincMatrix(asRowVector: Boolean = true): SincMatrix
fun IntArray.asSincMatrix(asRowVector: Boolean = true): SincMatrix
fun List<Double>.asSincMatrix(asRowVector: Boolean = true): SincMatrix
fun IntRange.asSincMatrix(asRowVector: Boolean = true): SincMatrix
fun List<Int>.asSincMatrix(asRowVector: Boolean = true, intType: Any? = null): SincMatrix
fun List<Int>.asSincMatrix(m: Int, n: Int, intType: Any? = null): SincMatrix
Link copied to clipboard
fun SincMatrix.cat(dim: Int = 1, vararg matrices: SincMatrix): SincMatrix
Link copied to clipboard
Link copied to clipboard
fun colVectorOf(vararg values: Double): SincMatrix
fun colVectorOf(vararg values: Int): SincMatrix
Link copied to clipboard
fun SincMatrix.conv(bVector: SincMatrix, shape: ConvolutionShape = ConvolutionShape.FULL): SincMatrix
Link copied to clipboard
Link copied to clipboard
actual fun SincMatrix.cos(): SincMatrix
expect fun SincMatrix.cos(): SincMatrix
actual fun SincMatrix.cos(): SincMatrix
Link copied to clipboard
Link copied to clipboard
fun SincMatrix.Companion.csvRead(filePath: String, separator: String = ",", headerInfo: List<String> = listOf(), dateFormat: String = "yyyy-MM-dd HH:mm:ss.SSS", bundleID: String? = null): SincMatrix

For example usage see SincMathsTests/SincMatrixIO.

Link copied to clipboard
Link copied to clipboard
fun SincMatrix.diff(dim: Int = 1): SincMatrix
Link copied to clipboard

Differentiates the vector by wavelet transformation using the mexican-hat wavelet.

Link copied to clipboard
operator fun SincMatrix.div(rhs: Double): SincMatrix
operator fun Double.div(rhs: SincMatrix): SincMatrix
Link copied to clipboard
Link copied to clipboard
actual infix fun SincMatrix.elDiv(rhs: SincMatrix): SincMatrix
expect infix fun SincMatrix.elDiv(rhs: SincMatrix): SincMatrix
actual infix fun SincMatrix.elDiv(rhs: SincMatrix): SincMatrix
Link copied to clipboard
actual infix fun SincMatrix.elMul(rhs: SincMatrix): SincMatrix
expect infix fun SincMatrix.elMul(rhs: SincMatrix): SincMatrix
actual infix fun SincMatrix.elMul(rhs: SincMatrix): SincMatrix
Link copied to clipboard
actual infix fun SincMatrix.elPow(power: Double): SincMatrix
expect infix fun SincMatrix.elPow(power: Double): SincMatrix
actual infix fun SincMatrix.elPow(power: Double): SincMatrix
Link copied to clipboard
actual fun SincMatrix.elSum(): Double
expect fun SincMatrix.elSum(): Double
actual fun SincMatrix.elSum(): Double
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Equals to as in A == B

infix fun SincMatrix.et(rhs: Double): SincMatrix

Equals to as in A == b

infix fun Double.et(rhs: SincMatrix): SincMatrix

Equals to as in a == B

Link copied to clipboard
Link copied to clipboard
fun SincMatrix.filter(bVector: DoubleArray, aVector: DoubleArray, dim: Int = 1): SincMatrix

Only second order filters are supported. Thus, length(B) == length(A) == 3 is assumed.

Link copied to clipboard

Only second order filters are supported. Thus, length(B) == length(A) == 3 is assumed.

Link copied to clipboard
actual fun SincMatrix.find(): SincMatrix
expect fun SincMatrix.find(): SincMatrix
actual fun SincMatrix.find(): SincMatrix
Link copied to clipboard
Link copied to clipboard
fun SincMatrix.flip(dim: Int = 1): SincMatrix
Link copied to clipboard
Link copied to clipboard

Creates a SincMatrix from Octave scripts, such as:

Link copied to clipboard
fun SincMatrix.get(selector: (end: Int, all: IntRange) -> IntRange): SincMatrix
fun SincMatrix.get(selector: (endR: Int, endC: Int, allR: IntRange, allC: IntRange) -> Pair<IntRange, IntRange>): SincMatrix

kotlin-way of doing get(mlScript: String).

operator fun SincMatrix.get(index: Int): Double
operator fun SincMatrix.get(indices: IntArray): SincMatrix
operator fun SincMatrix.get(indices: IntRange): SincMatrix
operator fun SincMatrix.get(mlRow: Int, mlCol: Int): Double
operator fun SincMatrix.get(mlRows: IntArray, mlCols: IntArray): SincMatrix
operator fun SincMatrix.get(mlRows: IntRange, mlCols: IntRange): SincMatrix

Indexing starts at 1, like Octave/MATLAB.

operator fun SincMatrix.get(mlScript: String): SincMatrix

Supported Octave scripts: 1:5,4:7 and 1:5,4 and 1:5,: and 1,4:7 and :,4:7 and : and 1:end,end:end-1 and 1:5 and 1:end-1 and end:end-1

Link copied to clipboard

Indexing starts at 1, like Octave/MATLAB.

Link copied to clipboard

Indexing starts at 1, like Octave/MATLAB.

Link copied to clipboard

Indexing starts at 1, like Octave/MATLAB.

Link copied to clipboard

Indexing starts at 1, like Octave/MATLAB.

Link copied to clipboard

Indexing starts at 1, like Octave/MATLAB.

Link copied to clipboard
infix fun SincMatrix.gt(rhs: Double): SincMatrix

Greater than as in A b

infix fun Double.gt(rhs: SincMatrix): SincMatrix

Greater than as in a B

Link copied to clipboard
fun SincMatrix.iqr(dim: Int = 1): SincMatrix

The IQR function is compatible with MATLAB 2020b and not with Octave 6.2.0. C.F. bug no. 59636

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
infix fun SincMatrix.lt(rhs: Double): SincMatrix

Less than as in A < b

infix fun Double.lt(rhs: SincMatrix): SincMatrix

Less than as in a < B

Link copied to clipboard
fun List<SincMatrix>.makeMatrixFrom(rowVectors: Boolean = true): SincMatrix
Link copied to clipboard
fun SincMatrix.map(transform: (value: Double) -> Double): SincMatrix
Link copied to clipboard
fun SincMatrix.mapColumns(transform: (colVector: SincMatrix) -> SincMatrix): SincMatrix
fun SincMatrix.mapColumns(resultLen: Int, transform: (colVector: SincMatrix) -> SincMatrix): SincMatrix
Link copied to clipboard
fun SincMatrix.mapColumnsToDouble(transform: (colVector: SincMatrix) -> Double): SincMatrix
Link copied to clipboard
Link copied to clipboard
fun SincMatrix.mapRows(transform: (rowVector: SincMatrix) -> SincMatrix): SincMatrix
fun SincMatrix.mapRows(resultLen: Int, transform: (rowVector: SincMatrix) -> SincMatrix): SincMatrix
Link copied to clipboard
fun SincMatrix.mapRowsToDouble(transform: (rowVector: SincMatrix) -> Double): SincMatrix
Link copied to clipboard
fun SincMatrix.mapRowsToList(transform: (rowVector: SincMatrix) -> SincMatrix): List<SincMatrix>
Link copied to clipboard

Creates a SincMatrix from Octave scripts, such as:

Link copied to clipboard
fun matrixOf(m: Int, n: Int, vararg values: Double): SincMatrix
fun matrixOf(m: Int, n: Int, vararg values: Int): SincMatrix
fun matrixOf(m: Int, n: Int, values: IntRange): SincMatrix
Link copied to clipboard
actual fun SincMatrix.max(dim: Int): SincMatrix
expect fun SincMatrix.max(dim: Int = 1): SincMatrix
actual fun SincMatrix.max(dim: Int): SincMatrix
Link copied to clipboard
fun SincMatrix.maxI(dim: Int = 1): SincMatrix
Link copied to clipboard
fun SincMatrix.mean(dim: Int = 1): SincMatrix
Link copied to clipboard
Link copied to clipboard
actual fun SincMatrix.min(dim: Int): SincMatrix
expect fun SincMatrix.min(dim: Int = 1): SincMatrix
actual fun SincMatrix.min(dim: Int): SincMatrix
Link copied to clipboard
fun SincMatrix.minI(dim: Int = 1): SincMatrix
Link copied to clipboard
operator fun SincMatrix.minus(rhs: Double): SincMatrix
operator fun Double.minus(rhs: SincMatrix): SincMatrix
Link copied to clipboard
fun SincMatrix.movMean(wLen: Int, endpoints: MovWinShape = MovWinShape.SHRINK, dim: Int = 1): SincMatrix
Link copied to clipboard
fun SincMatrix.movSum(wLen: Int, endpoints: MovWinShape = MovWinShape.SHRINK, dim: Int = 1): SincMatrix
Link copied to clipboard
Link copied to clipboard

Not equals to as in A != B or A ~= B

infix fun SincMatrix.net(rhs: Double): SincMatrix

Not equals to as in A != b or A ~= b

infix fun Double.net(rhs: SincMatrix): SincMatrix

Not equals to as in a != B or a ~= B

Link copied to clipboard
operator fun SincMatrix.not(): SincMatrix

!A or ~A

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
actual operator fun SincMatrix.plus(rhs: SincMatrix): SincMatrix
actual operator fun SincMatrix.plus(rhs: Double): SincMatrix
expect operator fun SincMatrix.plus(rhs: SincMatrix): SincMatrix
expect operator fun SincMatrix.plus(rhs: Double): SincMatrix
operator fun Double.plus(rhs: SincMatrix): SincMatrix
actual operator fun SincMatrix.plus(rhs: SincMatrix): SincMatrix
actual operator fun SincMatrix.plus(rhs: Double): SincMatrix
Link copied to clipboard
Link copied to clipboard
actual fun SincMatrix.removeAt(index: Int)
actual fun SincMatrix.removeAt(indices: IntArray)
expect fun SincMatrix.removeAt(index: Int)
expect fun SincMatrix.removeAt(indices: IntArray)

Indexing starts at 1, like Octave/MATLAB. This function makes the underlying matrix a row vector.

actual fun SincMatrix.removeAt(index: Int)
actual fun SincMatrix.removeAt(indices: IntArray)
Link copied to clipboard
Link copied to clipboard

As SincMatrix is row-major, reshape picks data from rows first and also fills rows first. Thus, a reshape such as reshape(A, 4, 3) on SincMatrix is equal to reshape(A', 3, 4)' on MATLAB/Octave.

Link copied to clipboard
fun SincMatrix.rms(dim: Int = 1): SincMatrix
Link copied to clipboard

Citation: Mike Day, Insomniac Games, "Converting a Rotation Matrix to a Quaternion". The code in this document is for post-multiplying rotation matrix.

Link copied to clipboard
Link copied to clipboard
fun rowVectorOf(vararg values: Double): SincMatrix
fun rowVectorOf(vararg values: Int): SincMatrix
Link copied to clipboard
actual operator fun SincMatrix.set(index: Int, value: Double)
actual operator fun SincMatrix.set(mlRow: Int, mlCol: Int, value: Double)
expect operator fun SincMatrix.set(index: Int, value: Double)
expect operator fun SincMatrix.set(mlRow: Int, mlCol: Int, value: Double)

Indexing starts at 1, like Octave/MATLAB.

actual operator fun SincMatrix.set(index: Int, value: Double)
actual operator fun SincMatrix.set(mlRow: Int, mlCol: Int, value: Double)
Link copied to clipboard
fun SincMatrix.setCol(mlCol: Int, values: SincMatrix)
fun SincMatrix.setCol(mlCol: Int, value: Double)
fun SincMatrix.setCol(mlCol: Int, values: DoubleArray)

Indexing starts at 1, like Octave/MATLAB.

Link copied to clipboard
fun SincMatrix.setRow(mlRow: Int, values: SincMatrix)
fun SincMatrix.setRow(mlRow: Int, value: Double)
fun SincMatrix.setRow(mlRow: Int, values: DoubleArray)

Indexing starts at 1, like Octave/MATLAB.

Link copied to clipboard

Indexing starts at 1, like Octave/MATLAB.

Link copied to clipboard
fun SincMatrix.setWithLV(logicalVector: SincMatrix, values: SincMatrix)
fun SincMatrix.setWithLV(logicalVector: SincMatrix, value: Double)
fun SincMatrix.setWithLV(logicalVector: SincMatrix, values: DoubleArray)

Indexing with a logical vector containing 0's and 1's.

Link copied to clipboard

This function is like Octave's sgolayfilt, except that instead of order and filter length Savitzky-Golay a pre-computed projection matrix (bMatrix) is supplied.

Link copied to clipboard
Link copied to clipboard
actual fun SincMatrix.sin(): SincMatrix
expect fun SincMatrix.sin(): SincMatrix
actual fun SincMatrix.sin(): SincMatrix
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun SincMatrix.std(dim: Int = 1): SincMatrix
Link copied to clipboard
fun SincMatrix.sum(dim: Int = 1): SincMatrix
Link copied to clipboard
actual operator fun SincMatrix.times(rhs: SincMatrix): SincMatrix
actual operator fun SincMatrix.times(rhs: Double): SincMatrix
expect operator fun SincMatrix.times(rhs: SincMatrix): SincMatrix
expect operator fun SincMatrix.times(rhs: Double): SincMatrix
operator fun Double.times(rhs: SincMatrix): SincMatrix
actual operator fun SincMatrix.times(rhs: SincMatrix): SincMatrix
actual operator fun SincMatrix.times(rhs: Double): SincMatrix
Link copied to clipboard
Link copied to clipboard