scid.matrix

This module contains the MatrixView class as well as some functions related to it.

Members

Enums

Storage
enum Storage

Various matrix representations.

Triangle
enum Triangle

In packed storage (triangular, symmetric, and Hermitian matrices), one can choose to store either the upper or lower triangle.

Functions

copy
MatrixView!(T, stor, tri) copy(MatrixView!(T, stor, tri) m)

A convenience function that creates a copy of the input matrix. Memory for the copy is allocated using the GC.

matrix
MatrixView!(T) matrix(size_t rows, size_t cols)
MatrixView!(T) matrix(size_t rows, size_t cols, T init)
MatrixView!(T, stor, tri) matrix(size_t n, T init)

A convenience function that allocates memory for a matrix (using the GC), optionally sets the values of the matrix elements, and returns a MatrixView of the allocated memory.

Structs

MatrixView
struct MatrixView(T, Storage stor = Storage.General, Triangle tri = Triangle.Upper)

A matrix-like view of the contents of an array.

Templates

isMatrixView
template isMatrixView(MatrixT)
template isMatrixView(MatrixT, ElemT)
template isMatrixView(MatrixT, Storage stor)
template isMatrixView(MatrixT, ElemT, Storage stor)

Evaluates to true if the given type is an instantiation of MatrixView. Optionally test the element type and/or storage scheme.

Meta

Authors

Lars Tandle Kyllingstad

License

Boost License 1.0