Eigen

• Index

Contents

• Functions

Modules

• bdcsvd
• block
• boolmatrix
• choleskybase
• colpivhouseholderqr
• commonwriteops
• completeorthogonaldecomposition
• complexeigensolver
• complexschur
• diagonal
• eigen
• eigensolver
• eigentype
• fullpivhouseholderqr
• fullpivlu
• generalizedeigensolver
• generalizedselfadjointeigensolver
• hessenbergdecomposition
• householderqr
• jacobisvd
• ldlt
• llt
• map
• matrix
• numericalwriteops
• partialpivlu
• qrbase
• qrextensions
• realqz
• realschur
• selfadjointeigensolver
• selfadjointview
• transpose
• triangularview
• tridiagonalization
• vectorblock
• xprops

Module matrix

Wrapper over Eigen's matrices.

In addition to those listed below, matrices have those methods listed in CommonWriteOps, NumericalWriteOps, and XprOps.

Functions

Matrix:acos ()	DOCMEMORE
Matrix:add (B, vectorwise)	DOCMEMORE
Matrix:__add ()	Metamethod May be matrix / scalar combo
Matrix:adjoint ()	DOCMEMORE
Matrix:allFinite ()	DOCMEMORE
Matrix:arg ()	DOCMEMORE
Matrix:asDiagonal ()	DOCMEMORE
Matrix:asMatrix ()	DOCMEMORE
Matrix:asPermutation ()	DOCMEMORE
Matrix:asin ()	DOCMEMORE
Matrix:atan ()	DOCMEMORE
Matrix:bdcSvd ([opts])	DOCMEMORE
Matrix:binaryExpr (func)	DOCMEMORE
Matrix:blueNorm ()	DOCMEMORE
Matrix:__call (row, col)	DOCMEMORE
Matrix:cast (type)	DOCMEMORE
Matrix:ceil ()	DOCMEMORE
Matrix:colPivHouseholderQr ()	DOCMEMORE
Matrix:cols ()	DOCMEMORE
Matrix:colStride ()	DOCMEMORE
Matrix:completeOrthogonalDecomposition ()	DOCEMORE
Matrix:conjugate ()	DOCMEMORE
Matrix:conservativeResize (nrows, ncols)	DOCMEMORE
Matrix:conservativeResizeLike (other)	DOCMEMORE
Matrix:cos ()	DOCMEMORE
Matrix:cosh ()	DOCMEMORE
Matrix:cube ()	DOCMEMORE
Matrix:cwiseAbs ()	DOCMEMORE
Matrix:cwiseAbs2 ()	DOCMEMORE
Matrix:cwiseEqual (m)	DOCMEMORE
Matrix:cwiseGreaterThan (m)	DOCMEMORE
Matrix:cwiseGreaterThanOrEqual (m)	DOCMEMORE
Matrix:cwiseInverse ()	DOCMEMORE
Matrix:cwiseLessThan (m)	DOCMEMORE
Matrix:cwiseLessThanOrEqual (m)	DOCMEMORE
Matrix:cwiseMax (m)	DOCMEMORE
Matrix:cwiseMin (m)	DOCMEMORE
Matrix:cwiseNotEqual (m)	DOCMEMORE
Matrix:cwiseProduct (M)	DOCMEMORE
Matrix:cwiseQuotient (M)	DOCMEMORE
Matrix:cwiseSign ()	DOCMEMORE
Matrix:cwiseSqrt ()	DOCMEMORE
Matrix:data ()	DOCMEMORE
Matrix:determinant ()	DOCMEMORE
Matrix:diagonalSize ()	DOCMEMORE
Matrix:__div ()	Metamethod RHS may be matrix / scalar combo
Matrix:dot (other)	DOCMEMORE
Matrix:eigenSolver (N)	DOCMEMORE
Matrix:exp ()	DOCMEMORE
Matrix:floor ()	DOCMEMORE
Matrix:fullPivHouseholderQr ()	DOCMEMORE
Matrix:fullPivLu ()	DOCMEMORE
Matrix:generalizedEigenSolver (R, N)	DOCMEMORE
Matrix:generalizedSelfAdjointEigenSolver (R[, opts])	DOCMEMORE
Matrix:hasNaN ()	DOCMEMORE
Matrix:hessenbergDecomposition ()	DOCMEMORE
Matrix:householderQr ()	DOCMEMORE
Matrix:hypotNorm ()	DOCMEMORE
Matrix:imag ()	DOCMEMORE
Matrix:imagAssign (M)	DOCMEMORE
Matrix:innerSize ()	DOCMEMORE
Matrix:innerStride ()	DOCMEMORE
Matrix:inverse ()	DOCMEMORE
Matrix:isApprox (A, prec)	DOCMEMORE
Matrix:isConstant (S, prec)	DOCMEMORE
Matrix:isDiagonal (prec)	DOCMEMORE
Matrix:isFinite (prec)	DOCMEMORE
Matrix:isIdentity (prec)	DOCMEMORE
Matrix:isInf (prec)	DOCMEMORE
Matrix:isLowerTriangular (prec)	DOCMEMORE
Matrix:isMuchSmallerThan (prec)	DOCMEMORE
Matrix:isNaN (prec)	DOCMEMORE
Matrix:isOnes (prec)	DOCMEMORE
Matrix:isOrthogonal (prec)	DOCMEMORE
Matrix:isUnitary (prec)	DOCMEMORE
Matrix:isUpperTriangular (prec)	DOCMEMORE
Matrix:isZero (prec)	DOCMEMORE
Matrix:jacobiSvd ([opts])	DOCMEMORE
Matrix:ldlt (UL)	DOCMEMORE
Matrix:__len ()	Metamethod.
Matrix:llt (UL)	DOCMEMORE
Matrix:log ()	DOCMEMORE
Matrix:log10 ()	DOCMEMORE
Matrix:lp1Norm ()	DOCMEMORE
Matrix:lpInfNorm ()	DOCMEMORE
Matrix:lu ()	Synonym for Matrix:partialPivLu.
Matrix:maxCoeff (choice)	DOCMEMORE
Matrix:mean (choice)	DOCMEMORE
Matrix:minCoeff (choice)	DOCMEMORE
Matrix:__mul ()	Metamethod May be matrix / scalar combo
Matrix:norm ()	DOCMEMORE
Matrix:normalized (vectorwise)	DOCMEMORE
Matrix:operatorNorm ()	DOCMEMORE
Matrix:outerSize ()	DOCMEMORE
Matrix:outerStride ()	DOCMEMORE
Matrix:partialPivLu ()	DOCMEMORE
Matrix:__pow ()	Metamethod May be matrix / scalar combo
Matrix:prod (choice)	DOCMEMORE
Matrix:real ()	DOCMEMORE
Matrix:realAssign (M)	DOCMEMORE
Matrix:realQz (R, N)	DOCMEMORE
Matrix:redux (func, how)	DOCMEMORE
Matrix:replicate (vcount)	DOCMEMORE
Matrix:reshape (nrows, ncols)	DOCMEMORE
Matrix:reshapeWithInnerStride (nrows, ncols, stride)	DOCMEMORE
Matrix:reshapeWithOuterStride (nrows, ncols, stride)	DOCMEMORE
Matrix:resize (nrows, ncols)	DOCMEMORE
Matrix:resizeLike (other)	DOCMEMORE
Matrix:reverse (vectorwise)	DOCMEMORE
Matrix:round ()	DOCMEMORE
Matrix:rows ()	DOCMEMORE
Matrix:rowStride ()	DOCMEMORE
Matrix:schur (N)	DOCMEMORE
Matrix:selfAdjointEigenSolver (N)	DOCMEMORE
Matrix:selfAdjointView (N)	DOCMEMORE
Matrix:sin ()	DOCMEMORE
Matrix:sinh ()	DOCMEMORE
Matrix:size ()	DOCMEMORE
Matrix:square ()	DOCMEMORE
Matrix:squaredNorm ()	DOCMEMORE
Matrix:stableNorm ()	DOCMEMORE
Matrix:stableNormalized ()	DOCMEMORE
Matrix:sub (B, vectorwise)	DOCMEMORE
Matrix:__sub ()	Metamethod May be matrix / scalar combo
Matrix:sum (choice)	DOCMEMORE
Matrix:tan ()	DOCMEMORE
Matrix:tanh ()	DOCMEMORE
Matrix:__tostring ()	DOCMEMORE
Matrix:trace ()	DOCMEMORE
Matrix:transpose ()	DOCMEMORE
Matrix:triangularView (Lower)	DOCMEMORE
Matrix:tridiagonalization ()	DOCMEMORE
Matrix:unaryExpr (func)	DOCMEMORE
Matrix:unitOrthogonal ()	DOCMEMORE
Matrix:__unm ()	Metamethod
Matrix:value ()	DOCMEMORE
Matrix:visit (init, rest)	DOCMEMORE

Functions

Matrix:acos ()

DOCMEMORE

Returns:

Matrix x

Matrix:add (B, vectorwise)

DOCMEMORE

Parameters:

• B Matrix
• vectorwise string

Returns:

Matrix A

Matrix:__add ()

Metamethod May be matrix / scalar combo

Returns:

Matrix S

Matrix:adjoint ()

DOCMEMORE

Returns:

Matrix A

Matrix:allFinite ()

DOCMEMORE

Returns:

boolean B

Matrix:arg ()

DOCMEMORE

Returns:

Matrix x

Matrix:asDiagonal ()

DOCMEMORE

Returns:

Matrix x

Matrix:asMatrix ()

DOCMEMORE

Returns:

Matrix x

Matrix:asPermutation ()

DOCMEMORE

Returns:

Matrix x

Matrix:asin ()

DOCMEMORE

Returns:

Matrix x

Matrix:atan ()

DOCMEMORE

Returns:

Matrix x

Matrix:bdcSvd ([opts])

DOCMEMORE

Parameters:

• opts table ("FullU", "ThinU", "FullV", "ThinV")

Returns:

BDCSVD B

Matrix:binaryExpr (func)

DOCMEMORE

Parameters:

• func callable

Returns:

Matrix x

Matrix:blueNorm ()

DOCMEMORE

Returns:

number n

Matrix:__call (row, col)

DOCMEMORE

Parameters:

• row uint
• col uint

Returns:

Scalar x

Matrix:cast (type)

DOCMEMORE

Parameters:

• type string

Returns:

Matrix x

Matrix:ceil ()

DOCMEMORE

Returns:

Matrix S

Matrix:colPivHouseholderQr ()

DOCMEMORE

Returns:

ColPivHouseholderQR C

Matrix:cols ()

DOCMEMORE

Returns:

uint C

Matrix:colStride ()

DOCMEMORE

Returns:

uint C

Matrix:completeOrthogonalDecomposition ()

DOCEMORE

Returns:

CompleteOrthogonalDecomposition C

Matrix:conjugate ()

DOCMEMORE

Returns:

Matrix S

Matrix:conservativeResize (nrows, ncols)

DOCMEMORE

Parameters:

• nrows uint
• ncols uint

Matrix:conservativeResizeLike (other)

DOCMEMORE

Parameters:

• other Matrix

Matrix:cos ()

DOCMEMORE

Returns:

Matrix S

Matrix:cosh ()

DOCMEMORE

Returns:

Matrix S

Matrix:cube ()

DOCMEMORE

Returns:

Matrix S

Matrix:cwiseAbs ()

DOCMEMORE

Returns:

Matrix S

Matrix:cwiseAbs2 ()

DOCMEMORE

Returns:

Matrix S

Matrix:cwiseEqual (m)

DOCMEMORE

Parameters:

• m Matrix or Scalar

Returns:

BoolMatrix B

Matrix:cwiseGreaterThan (m)

DOCMEMORE

Parameters:

• m Matrix or Scalar

Returns:

BoolMatrix B

Matrix:cwiseGreaterThanOrEqual (m)

DOCMEMORE

Parameters:

• m Matrix or Scalar

Returns:

BoolMatrix B

Matrix:cwiseInverse ()

DOCMEMORE

Returns:

Matrix S

Matrix:cwiseLessThan (m)

DOCMEMORE

Parameters:

• m Matrix or Scalar

Returns:

BoolMatrix B

Matrix:cwiseLessThanOrEqual (m)

DOCMEMORE

Parameters:

• m Matrix or Scalar

Returns:

BoolMatrix B

Matrix:cwiseMax (m)

DOCMEMORE

Parameters:

• m Matrix or Scalar

Returns:

Matrix S

Matrix:cwiseMin (m)

DOCMEMORE

Parameters:

• m Matrix or Scalar

Returns:

Matrix S

Matrix:cwiseNotEqual (m)

DOCMEMORE

Parameters:

• m Matrix or Scalar

Returns:

BoolMatrix B

Matrix:cwiseProduct (M)

DOCMEMORE

Parameters:

• M Matrix

Returns:

Matrix S

Matrix:cwiseQuotient (M)

DOCMEMORE

Parameters:

• M Matrix

Returns:

Matrix S

Matrix:cwiseSign ()

DOCMEMORE

Returns:

Matrix S

Matrix:cwiseSqrt ()

DOCMEMORE

Returns:

Matrix S

Matrix:data ()

DOCMEMORE

Returns:

userdata D

Matrix:determinant ()

DOCMEMORE

Returns:

number x

Matrix:diagonalSize ()

DOCMEMORE

Returns:

uint C

Matrix:__div ()

Metamethod RHS may be matrix / scalar combo

Returns:

Matrix S

Matrix:dot (other)

DOCMEMORE

Parameters:

• other Matrix

Returns:

Scalar x

Matrix:eigenSolver (N)

DOCMEMORE

Parameters:

• N string ("NoEigenvalues")

Returns:

EigenSolver or ComplexEigenSolver ES

Matrix:exp ()

DOCMEMORE

Returns:

Matrix S

Matrix:floor ()

DOCMEMORE

Returns:

Matrix S

Matrix:fullPivHouseholderQr ()

DOCMEMORE

Returns:

FullPivHouseholderQR F

Matrix:fullPivLu ()

DOCMEMORE

Returns:

FullPivLU F

Matrix:generalizedEigenSolver (R, N)

DOCMEMORE

Parameters:

• R Matrix
• N string ("NoEigenvectors")

Returns:

GeneralizedEigenSolver GES

Matrix:generalizedSelfAdjointEigenSolver (R[, opts])

DOCMEMORE

Parameters:

• R Matrix
• opts table ( noeigenvectors = bool, method = "ABxlx", "AxlBx", "BAxlx" )

Returns:

GeneralizedSelfAdjointEigenSolver G

Matrix:hasNaN ()

DOCMEMORE

Returns:

boolean B

Matrix:hessenbergDecomposition ()

DOCMEMORE

Returns:

HessenbergDecomposition H

Matrix:householderQr ()

DOCMEMORE

Returns:

HouseholderQR H

Matrix:hypotNorm ()

DOCMEMORE

Returns:

number n

Matrix:imag ()

DOCMEMORE

Returns:

Matrix M

Matrix:imagAssign (M)

DOCMEMORE

Parameters:

• M Matrix

Matrix:innerSize ()

DOCMEMORE

Returns:

uint C

Matrix:innerStride ()

DOCMEMORE

Returns:

uint C

Matrix:inverse ()

DOCMEMORE

Returns:

Matrix S

Matrix:isApprox (A, prec)

DOCMEMORE

Parameters:

• A Matrix
• prec number

Returns:

boolean B

Matrix:isConstant (S, prec)

DOCMEMORE

Parameters:

• S Scalar
• prec number

Returns:

boolean B

Matrix:isDiagonal (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isFinite (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isIdentity (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isInf (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isLowerTriangular (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isMuchSmallerThan (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isNaN (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isOnes (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isOrthogonal (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isUnitary (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isUpperTriangular (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:isZero (prec)

DOCMEMORE

Parameters:

• prec number

Returns:

boolean B

Matrix:jacobiSvd ([opts])

DOCMEMORE

Parameters:

• opts table (Follows bdcSvd, also has preconditioner = "fullPiv", "householder", "none")

Returns:

JacobiSVD J

Matrix:ldlt (UL)

DOCMEMORE

Parameters:

• UL string ("upper")

Returns:

LDLT L

Matrix:__len ()

Metamethod.

Synonym for Matrix:size.

Returns:

uint Number of elements.

Matrix:llt (UL)

DOCMEMORE

Parameters:

• UL string ("upper")

Returns:

LLT L

Matrix:log ()

DOCMEMORE

Returns:

Matrix S

Matrix:log10 ()

DOCMEMORE

Returns:

Matrix S

Matrix:lp1Norm ()

DOCMEMORE

Returns:

number n

Matrix:lpInfNorm ()

DOCMEMORE

Returns:

number n

Matrix:lu ()

Synonym for Matrix:partialPivLu.

Matrix:maxCoeff (choice)

DOCMEMORE

Parameters:

• choice string (colwise, rowwise)

Returns:

Scalar S

Or

Matrix M (col, row)

Matrix:mean (choice)

DOCMEMORE

Parameters:

• choice string (colwise, rowwise)

Returns:

Scalar S

Or

Matrix M (col, row)

Matrix:minCoeff (choice)

DOCMEMORE

Parameters:

• choice string (colwise, rowwise)

Returns:

Scalar S

Or

Matrix M (col, row)

Matrix:__mul ()

Metamethod May be matrix / scalar combo

Returns:

Matrix S

Matrix:norm ()

DOCMEMORE

Returns:

number n

Matrix:normalized (vectorwise)

DOCMEMORE

Parameters:

• vectorwise string

Returns:

Matrix A

Matrix:operatorNorm ()

DOCMEMORE

Returns:

number n

Matrix:outerSize ()

DOCMEMORE

Returns:

uint C

Matrix:outerStride ()

DOCMEMORE

Returns:

uint C

Matrix:partialPivLu ()

DOCMEMORE

Returns:

PartialPivLU P

Matrix:__pow ()

Metamethod May be matrix / scalar combo

Returns:

Matrix S

Matrix:prod (choice)

DOCMEMORE

Parameters:

• choice string (colwise, rowwise)

Returns:

Scalar S

Or

Matrix M (col, row)

Matrix:real ()

DOCMEMORE

Returns:

Matrix M

Matrix:realAssign (M)

DOCMEMORE

Parameters:

• M Matrix

Matrix:realQz (R, N)

DOCMEMORE

Parameters:

• R Matrix
• N string ("NoQZ")

Returns:

RealQZ RQZ

Matrix:redux (func, how)

DOCMEMORE

Parameters:

• func callable
• how

Returns:

Matrix x

Or

Scalar y

Matrix:replicate (vcount)

DOCMEMORE

Parameters:

• vcount uint @?|uint|string hcount / choice (colwise, rowwise)

Returns:

Matrix R

Matrix:reshape (nrows, ncols)

DOCMEMORE

Parameters:

• nrows uint
• ncols uint

Returns:

Map

Matrix:reshapeWithInnerStride (nrows, ncols, stride)

DOCMEMORE

Parameters:

• nrows uint
• ncols uint
• stride uint

Returns:

Map

Matrix:reshapeWithOuterStride (nrows, ncols, stride)

DOCMEMORE

Parameters:

• nrows uint
• ncols uint
• stride uint

Returns:

Map

Matrix:resize (nrows, ncols)

DOCMEMORE

Parameters:

• nrows uint
• ncols uint

Matrix:resizeLike (other)

DOCMEMORE

Parameters:

• other Matrix

Matrix:reverse (vectorwise)

DOCMEMORE

Parameters:

• vectorwise string

Returns:

Matrix A

Matrix:round ()

DOCMEMORE

Returns:

Matrix S

Matrix:rows ()

DOCMEMORE

Returns:

uint R

Matrix:rowStride ()

DOCMEMORE

Returns:

uint C

Matrix:schur (N)

DOCMEMORE

Parameters:

• N string ("NoU")

Returns:

RealSchur or ComplexSchur S

Matrix:selfAdjointEigenSolver (N)

DOCMEMORE

Parameters:

• N string ("NoEigenvectors")

Returns:

SelfAdjointEigenSolver S

Matrix:selfAdjointView (N)

DOCMEMORE

Parameters:

• N string ("Lower", "Upper")

Returns:

SelfAdjointView S

Matrix:sin ()

DOCMEMORE

Returns:

Matrix S

Matrix:sinh ()

DOCMEMORE

Returns:

Matrix S

Matrix:size ()

DOCMEMORE

Returns:

uint C

Matrix:square ()

DOCMEMORE

Returns:

Matrix S

Matrix:squaredNorm ()

DOCMEMORE

Returns:

number n

Matrix:stableNorm ()

DOCMEMORE

Returns:

number n

Matrix:stableNormalized ()

DOCMEMORE

Returns:

Matrix A

Matrix:sub (B, vectorwise)

DOCMEMORE

Parameters:

• B Matrix
• vectorwise string

Returns:

Matrix A

Matrix:__sub ()

Metamethod May be matrix / scalar combo

Returns:

Matrix S

Matrix:sum (choice)

DOCMEMORE

Parameters:

• choice string (colwise, rowwise)

Returns:

Scalar S

Or

Matrix M (col, row)

Matrix:tan ()

DOCMEMORE

Returns:

Matrix S

Matrix:tanh ()

DOCMEMORE

Returns:

Matrix S

Matrix:__tostring ()

DOCMEMORE

Matrix:trace ()

DOCMEMORE

Returns:

Scalar x

Matrix:transpose ()

DOCMEMORE

Returns:

Transpose A

Matrix:triangularView (Lower)

DOCMEMORE

Parameters:

• Lower string ", "Upper", "StrictlyLower", "StrictlyUpper", "UnitLower", "UnitUpper")

Returns:

TriangularView T

Matrix:tridiagonalization ()

DOCMEMORE

Returns:

Tridiagonalization T

Matrix:unaryExpr (func)

DOCMEMORE

Parameters:

• func callable

Returns:

Matrix x

Matrix:unitOrthogonal ()

DOCMEMORE

Returns:

Matrix O

Matrix:__unm ()

Metamethod

Returns:

Matrix S

Matrix:value ()

DOCMEMORE

Returns:

Scalar x

Matrix:visit (init, rest)

DOCMEMORE

Parameters:

• init callable
• rest callable