Description

This class is missing documentation.

Class Methods

Inherited class methods

Undocumented class methods

*fill (rows, cols, func)

*mul (m1: 0, m2: 0)

*newClear (rows: 1, cols: 1)

*newIdentity (n)

*with (array)

*withFlatArray (rows, cols, array)

Instance Methods

Inherited instance methods

Undocumented instance methods

-* (that)

-+ (summand2)

-- (summand2)

-== (matrix2)

-addCol (colVals)

-addNumber (aNumber)

-addRow (rowVals)

-adjoint

-asArray

-at (row, col)

-center (mean)

-choleski

-choleskiSolve (b)

-cofactor (row, col)

-collect (func)

-cols

-cov (mean)

-covML (mean)

-crout

-croutPivot

-croutPivotSolve (b, pivot)

-croutSolve (b)

-det

-doCol (col, func)

-doMatrix (function)

-doRow (row, func)

-doolittle

-doolittlePivot

-doolittlePivotSolve (b, pivot)

-doolittleSolve (b)

-exchangeCol (posA, posB)

-exchangeRow (posA, posB)

-fillCol (col, func)

-fillRow (row, func)

-flat

-flatten

-flop

-fromCol (col)

-fromRow (row)

-gauss (b)

-get (row, col)

-getCol (col)

-getDiagonal

-getRow (row)

-gram

-grammian

-insertCol (row, colVals)

-insertRow (col, rowVals)

-inverse

-isAntiSymmetric

-isDiagonal

-isIdempotent

-isIdentity

-isIntegral

-isNonNegative

-isNormal

-isOrthogonal

-isPositive

-isRegular

-isSingular

-isSquare

-isSymmetric

-isZero

-lowerTriangularInverse

-lowerTriangularSolve (b)

-mean

-mul (multplier2)

-mulMatrix (aMatrix)

-mulNumber (aNumber)

-norm

-postmln

-printItemsOn (stream)

-printOn (stream)

-pseudoInverse

-put (row, col, val)

-putCol (col, vals)

-putRow (row, vals)

-removeAt (row)

-removeCol (col)

-removeRow (row)

-rows

-shape

-solve (b, method: 'crout')

-sub (row, col)

-subNumber (aNumber)

-sum

-sumCol (col)

-sumCols (function)

-sumRow (row)

-sumRows (function)

-trace

-unitLowerTriangularInverse

-unitLowerTriangularSolve (b)

-unitUpperTriangularInverse

-unitUpperTriangularSolve (b)

-upperTriangularInverse

-upperTriangularSolve (b)

Help template

Copy and paste the text below and save to HelpSource/Classes/Matrix.schelp

TITLE:: Matrix
summary:: (put short description here)
categories:: Undocumented classes
related:: Classes/SomeRelatedClass, Reference/SomeRelatedStuff, etc.

DESCRIPTION::
(put long description here)


CLASSMETHODS::

METHOD:: with
(describe method here)

ARGUMENT:: array
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: newIdentity
(describe method here)

ARGUMENT:: n
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: newClear
(describe method here)

ARGUMENT:: rows
(describe argument here)

ARGUMENT:: cols
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: fill
(describe method here)

ARGUMENT:: rows
(describe argument here)

ARGUMENT:: cols
(describe argument here)

ARGUMENT:: func
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: mul
(describe method here)

ARGUMENT:: m1
(describe argument here)

ARGUMENT:: m2
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: withFlatArray
(describe method here)

ARGUMENT:: rows
(describe argument here)

ARGUMENT:: cols
(describe argument here)

ARGUMENT:: array
(describe argument here)

returns:: (describe returnvalue here)


INSTANCEMETHODS::

METHOD:: removeAt
(describe method here)

ARGUMENT:: row
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: putRow
(describe method here)

ARGUMENT:: row
(describe argument here)

ARGUMENT:: vals
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: exchangeCol
(describe method here)

ARGUMENT:: posA
(describe argument here)

ARGUMENT:: posB
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isSymmetric
(describe method here)

returns:: (describe returnvalue here)

METHOD:: isOrthogonal
(describe method here)

returns:: (describe returnvalue here)

METHOD:: fillRow
(describe method here)

ARGUMENT:: row
(describe argument here)

ARGUMENT:: func
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: croutPivotSolve
(describe method here)

ARGUMENT:: b
(describe argument here)

ARGUMENT:: pivot
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: norm
(describe method here)

returns:: (describe returnvalue here)

METHOD:: lowerTriangularSolve
(describe method here)

ARGUMENT:: b
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: addRow
(describe method here)

ARGUMENT:: rowVals
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isAntiSymmetric
(describe method here)

returns:: (describe returnvalue here)

METHOD:: rows
(describe method here)

returns:: (describe returnvalue here)

METHOD:: fillCol
(describe method here)

ARGUMENT:: col
(describe argument here)

ARGUMENT:: func
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: gram
(describe method here)

returns:: (describe returnvalue here)

METHOD:: sumCol
(describe method here)

ARGUMENT:: col
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isDiagonal
(describe method here)

returns:: (describe returnvalue here)

METHOD:: mulNumber
(describe method here)

ARGUMENT:: aNumber
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: asArray
(describe method here)

returns:: (describe returnvalue here)

METHOD:: sub
(describe method here)

ARGUMENT:: row
(describe argument here)

ARGUMENT:: col
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: subNumber
(describe method here)

ARGUMENT:: aNumber
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: crout
(describe method here)

returns:: (describe returnvalue here)

METHOD:: isSingular
(describe method here)

returns:: (describe returnvalue here)

METHOD:: cofactor
(describe method here)

ARGUMENT:: row
(describe argument here)

ARGUMENT:: col
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: upperTriangularSolve
(describe method here)

ARGUMENT:: b
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: getCol
(describe method here)

ARGUMENT:: col
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isNonNegative
(describe method here)

returns:: (describe returnvalue here)

METHOD:: fromCol
(describe method here)

ARGUMENT:: col
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: doMatrix
(describe method here)

ARGUMENT:: function
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: covML
(describe method here)

ARGUMENT:: mean
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: unitLowerTriangularInverse
(describe method here)

returns:: (describe returnvalue here)

METHOD:: unitUpperTriangularInverse
(describe method here)

returns:: (describe returnvalue here)

METHOD:: isRegular
(describe method here)

returns:: (describe returnvalue here)

METHOD:: putCol
(describe method here)

ARGUMENT:: col
(describe argument here)

ARGUMENT:: vals
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: doCol
(describe method here)

ARGUMENT:: col
(describe argument here)

ARGUMENT:: func
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: mean
(describe method here)

returns:: (describe returnvalue here)

METHOD:: mulMatrix
(describe method here)

ARGUMENT:: aMatrix
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: cov
(describe method here)

ARGUMENT:: mean
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: doolittle
(describe method here)

returns:: (describe returnvalue here)

METHOD:: mul
(describe method here)

ARGUMENT:: multplier2
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: printOn
(describe method here)

ARGUMENT:: stream
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: gauss
(describe method here)

ARGUMENT:: b
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isIdempotent
(describe method here)

returns:: (describe returnvalue here)

METHOD:: unitUpperTriangularSolve
(describe method here)

ARGUMENT:: b
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: pseudoInverse
(describe method here)

returns:: (describe returnvalue here)

METHOD:: ==
(describe method here)

ARGUMENT:: matrix2
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: addNumber
(describe method here)

ARGUMENT:: aNumber
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: det
(describe method here)

returns:: (describe returnvalue here)

METHOD:: grammian
(describe method here)

returns:: (describe returnvalue here)

METHOD:: getDiagonal
(describe method here)

returns:: (describe returnvalue here)

METHOD:: unitLowerTriangularSolve
(describe method here)

ARGUMENT:: b
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: upperTriangularInverse
(describe method here)

returns:: (describe returnvalue here)

METHOD:: collect
(describe method here)

ARGUMENT:: func
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: printItemsOn
(describe method here)

ARGUMENT:: stream
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: *
(describe method here)

ARGUMENT:: that
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: sum
(describe method here)

returns:: (describe returnvalue here)

METHOD:: croutSolve
(describe method here)

ARGUMENT:: b
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: adjoint
(describe method here)

returns:: (describe returnvalue here)

METHOD:: sumRow
(describe method here)

ARGUMENT:: row
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isPositive
(describe method here)

returns:: (describe returnvalue here)

METHOD:: get
(describe method here)

ARGUMENT:: row
(describe argument here)

ARGUMENT:: col
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isIntegral
(describe method here)

returns:: (describe returnvalue here)

METHOD:: choleskiSolve
(describe method here)

ARGUMENT:: b
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: doolittlePivot
(describe method here)

returns:: (describe returnvalue here)

METHOD:: center
(describe method here)

ARGUMENT:: mean
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: insertRow
(describe method here)

ARGUMENT:: col
(describe argument here)

ARGUMENT:: rowVals
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isSquare
(describe method here)

returns:: (describe returnvalue here)

METHOD:: insertCol
(describe method here)

ARGUMENT:: row
(describe argument here)

ARGUMENT:: colVals
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: flatten
(describe method here)

returns:: (describe returnvalue here)

METHOD:: +
(describe method here)

ARGUMENT:: summand2
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isNormal
(describe method here)

returns:: (describe returnvalue here)

METHOD:: exchangeRow
(describe method here)

ARGUMENT:: posA
(describe argument here)

ARGUMENT:: posB
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: at
(describe method here)

ARGUMENT:: row
(describe argument here)

ARGUMENT:: col
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: solve
(describe method here)

ARGUMENT:: b
(describe argument here)

ARGUMENT:: method
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: doolittleSolve
(describe method here)

ARGUMENT:: b
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isZero
(describe method here)

returns:: (describe returnvalue here)

METHOD:: doolittlePivotSolve
(describe method here)

ARGUMENT:: b
(describe argument here)

ARGUMENT:: pivot
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: -
(describe method here)

ARGUMENT:: summand2
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: croutPivot
(describe method here)

returns:: (describe returnvalue here)

METHOD:: postmln
(describe method here)

returns:: (describe returnvalue here)

METHOD:: getRow
(describe method here)

ARGUMENT:: row
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: flop
(describe method here)

returns:: (describe returnvalue here)

METHOD:: doRow
(describe method here)

ARGUMENT:: row
(describe argument here)

ARGUMENT:: func
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: trace
(describe method here)

returns:: (describe returnvalue here)

METHOD:: addCol
(describe method here)

ARGUMENT:: colVals
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: flat
(describe method here)

returns:: (describe returnvalue here)

METHOD:: inverse
(describe method here)

returns:: (describe returnvalue here)

METHOD:: sumCols
(describe method here)

ARGUMENT:: function
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isIdentity
(describe method here)

returns:: (describe returnvalue here)

METHOD:: removeCol
(describe method here)

ARGUMENT:: col
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: lowerTriangularInverse
(describe method here)

returns:: (describe returnvalue here)

METHOD:: cols
(describe method here)

returns:: (describe returnvalue here)

METHOD:: removeRow
(describe method here)

ARGUMENT:: row
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: sumRows
(describe method here)

ARGUMENT:: function
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: choleski
(describe method here)

returns:: (describe returnvalue here)

METHOD:: shape
(describe method here)

returns:: (describe returnvalue here)

METHOD:: fromRow
(describe method here)

ARGUMENT:: row
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: put
(describe method here)

ARGUMENT:: row
(describe argument here)

ARGUMENT:: col
(describe argument here)

ARGUMENT:: val
(describe argument here)

returns:: (describe returnvalue here)


EXAMPLES::

code::
(some example code)
::