Module eigentype
The Eigen plugin is divided into five namespaces, according to the underlying data type: int (signed integers), float (single-precision float), double (double-precision float), cfloat (single-precision complex number), and cdouble (double-precision complex number).
Each namespace has the assortment of functions listed below (including many matrix factories), but the Matrix involved will be made up of whatever type belongs to the given namespace.
Functions
| Constant (nrows[, ncols=nrows]) | DOCMEMORE: Make a constant matrix |
| Identity (nrows[, ncols=nrows]) | DOCMEMORE: Make an identity matrix |
| LinSpaced () | DOCMEMORE: Make a linear-spaced vector |
| LinSpacedRow () | DOCMEMORE: Make a linear-spaced row vector |
| MatrixFromMemory (memory, nrows[, ncols=nrows]) | DOCMEMORE: Map memory as a matrix |
| MatrixFromMemoryWithInnerStride (memory, nrows[, ncols=nrows], stride) | DOCMEMORE: Map memory as a matrix, with inner stride |
| MatrixFromMemoryWithOuterStride (memory, nrows[, ncols=nrows], stride) | DOCMEMORE: Map memory as a matrix, with outer stride |
| NewMatrix (nrows[, ncols=nrows]) | DOCMEMORE: Make a matrix |
| Ones (nrows[, ncols=nrows]) | DOCMEMORE: Make an all-ones matrix |
| Random (nrows[, ncols=nrows]) | DOCMEMORE: Make a random matrix |
| RandomPermutation (n) | DOCMEMORE: Make a random permutation matrix |
| RowVector (size) | DOCMEMORE: Make a row vector |
| Vector (size) | DOCMEMORE: Make a (column) vector |
| Zero (nrows[, ncols=nrows]) | DOCMEMORE: Make an all-zeroes matrix |
Functions
- Constant (nrows[, ncols=nrows])
-
DOCMEMORE: Make a constant matrix
Parameters:
- nrows uint X
- ncols uint Y (default nrows)
Returns:
-
Matrix
C
- Identity (nrows[, ncols=nrows])
-
DOCMEMORE: Make an identity matrix
Parameters:
- nrows uint X
- ncols uint Y (default nrows)
Returns:
-
Matrix
I
- LinSpaced ()
-
DOCMEMORE: Make a linear-spaced vector
Returns:
-
Matrix
V
- LinSpacedRow ()
-
DOCMEMORE: Make a linear-spaced row vector
Returns:
-
Matrix
V
- MatrixFromMemory (memory, nrows[, ncols=nrows])
-
DOCMEMORE: Map memory as a matrix
Parameters:
- memory MemoryBlob or string
- nrows uint X
- ncols uint Y (default nrows)
Returns:
-
Map
M
- MatrixFromMemoryWithInnerStride (memory, nrows[, ncols=nrows], stride)
-
DOCMEMORE: Map memory as a matrix, with inner stride
Parameters:
- memory MemoryBlob or string
- nrows uint X
- ncols uint Y (default nrows)
- stride uint
Returns:
-
Map
M
- MatrixFromMemoryWithOuterStride (memory, nrows[, ncols=nrows], stride)
-
DOCMEMORE: Map memory as a matrix, with outer stride
Parameters:
- memory MemoryBlob or string
- nrows uint X
- ncols uint Y (default nrows)
- stride uint
Returns:
-
Map
M
- NewMatrix (nrows[, ncols=nrows])
-
DOCMEMORE: Make a matrix
Parameters:
- nrows uint X
- ncols uint Y (default nrows)
Returns:
-
Matrix
M
- Ones (nrows[, ncols=nrows])
-
DOCMEMORE: Make an all-ones matrix
Parameters:
- nrows uint X
- ncols uint Y (default nrows)
Returns:
-
Matrix
O
- Random (nrows[, ncols=nrows])
-
DOCMEMORE: Make a random matrix
Parameters:
- nrows uint X
- ncols uint Y (default nrows)
Returns:
-
Matrix
R
- RandomPermutation (n)
-
DOCMEMORE: Make a random permutation matrix
Parameters:
- n uint
Returns:
-
Matrix
R
- RowVector (size)
-
DOCMEMORE: Make a row vector
Parameters:
- size uint X
Returns:
-
Matrix
RV
- Vector (size)
-
DOCMEMORE: Make a (column) vector
Parameters:
- size uint X
Returns:
-
Matrix
V
- Zero (nrows[, ncols=nrows])
-
DOCMEMORE: Make an all-zeroes matrix
Parameters:
- nrows uint X
- ncols uint Y (default nrows)
Returns:
-
Matrix
Z