sincmaths
0.3indexedFacilitates translation of signal processing code from Octave/MATLAB for mobile apps, offering 2D matrix support, row-major storage, and platform-specific optimizations.
0
Stars
1
Used by
dependents
—
Health
/ 100
SincMaths
SincMaths is a Kotlin Multiplatform library which provides a 2D matrix SincMatrix to
facilitate translation of signal processing code written in Octave/MATLAB to mobile applications.
Originally written for the Gait&Balance app.
See docs for a comprehensive list of functions.
Key implementation aspects:
- Stores data in row-major format as opposed to column-major format used by Octave/MATLAB
- Uses ejml-simple for Android side optimisations
- Uses Apple Accelerate for iOS side optimisations
- Uses rafat/wavelib to provide wavelet-based demonising
- Uses codeplea/tinyexpr to provide Octave/MATLAB style indexing
Examples
Initialisation
val matrixA = matrixFrom("[1, 2, 3; 4, 5, 6]")
val matrixB = matrixFrom("[1, 2, 3, 4]")
val matrixC = matrixFrom("[5;6;7;8;9;10]")
val matrixD = matrixFrom("1:10")
val matrixE = matrixFrom()
matrixF = matrixOf(, , )
matrixG = colVectorOf(, , , , )
Indexing
val matrixM: SincMatrix = (1..110).asSincMatrix(11, 10)
val matrixA = matrixM["1:5,4:7"]
val matrixB = matrixM["1:end,end:-1:end-1"]
matrixC = matrixM[, ]
matrixD = matrixM[]
matrixE = matrixM[]
matrixF = matrixM. { endR, endC, allR, allC ->
Pair(allR, )
}
Implementation of acf from MATLAB Central
Reference: https://au.mathworks.com/matlabcentral/fileexchange/30540-autocorrelation-function-acf
Usage
Kotlin Project: MavenCentral
Note: This library does not work with
iosSimulatorArm64target. Android tests have to be performed on an emulator or a connected device, otherwise, the underlying JAVA JNI libraries fail to load.
Add dependency:
implementation("io.github.gallvp:sincmathsmp:0.3")
Try a test:
expect(5050.0) {
matrixFrom("1:100").sum().scalar
}
Swift Project: CocoaPods
Note: Global functions such as
matrixFromare converted into open class functions asSincMatrixInitKt.matrixFrom. Use 'Jump to Definition' on 'SincMaths' to locate the class and function definitions.
Clone this project and add it to your project's Podfile:
pod 'SincMaths', :path => '/path/to/cloned/sincmaths/sincmathsmp'
Import it in your project and try a test:
import SincMaths
XCTAssertEqual(
SincMatrixInitKt.matrixFrom(script: "1:100").sum(dim: 1).scalar,
5050.0
)