LengthFreeStaticMatrices.jl

Have you ever wanted to include a SMatrix as a field for a struct, but realized that you need to include a separate length parameter in order to create a pure bits type?

julia> using StaticArrays

julia> struct Test{M,N,T}
           matrix::SMatrix{M,N,T}
       end

julia> isbitstype(Test{2,3,Int})
false

julia> struct AnotherTest{M,N,T,L}
           matrix::SMatrix{M,N,T,L}
       end

julia> isbitstype(AnotherTest{2,3,Int,6})
true

The problem is that Julia cannot automatically infer that L = M*N, as there is no way to constrain type variables to be numeric values, or to perform operations such as multiplication with them. For all the compiler knows, L could be any value (or even a type).

This package solves this problem by introducing a new type, LSMatrix{M,N,T}, which stores its data in an NTuple{M,NTuple{N,T}}. We also provide the alias SquareLSMatrix{D,T} for square matrices.

julia> using LengthFreeStaticMatrices

julia> struct YetAnotherTest{M,N,T}
           matrix::LSMatrix{M,N,T}
       end

julia> isbitstype(YetAnotherTest{2,3,Int})
true

Why would you use this?

A type which is a sufficiently small set of pure bits can be stored inline rather than as references to individually allocated objects.

There is no expected performance gain over StaticArrays.SMatrix on its own (and as this package is quite new, there is likely room for performance improvements in the implementation); the intent is to allow for the optimization of data structures which contain small matrices without having to leak an unnecessary type parameter.

Performance

We haven't benchmarked this implementation yet, but a brief glance of LLVM bitcode suggests that the performance should be on par with SMatrix.

Acknowledgements

This functionality was originally implemented by Thomas Christensen for the Crystalline.jl package for square matrices.

This issue on the Julia repository may be of interest if you're interested in a language-level solution to the issue of computing dependent type parameters.

brainandforce/LengthFreeStaticMatrices.jl

LengthFreeStaticMatrices.jl

Why would you use this?

Performance

Acknowledgements