This is the LINEAR-ALGEBRA Reference Manual, version 0.1.1, generated automatically by Declt version 4.0b2.
Copyright © 2019-2023 Steve Nunez Copyright © 2019-2023 Thomas M. Hermann
Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the section entitled “Copying” is included exactly as in the original.
Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be translated as well.
This program is distributed under the terms of the Microsoft Public License.
The main system appears first, followed by any subsystem dependency.
Linear Algebra for Common Lisp
Linear Algebra for Common Lisp
Steve Nunez <steve@symbolics.tech>
Thomas M. Hermann <thomas.m.hermann@odonata-research.com>
(GIT https://github.com/Lisp-Stat/linear-algebra.git)
MS-PL
This system is a high level interface for linear algebra and matrix manipulation. It was forked from Thomas Hermann’s linear-algebra library (https://github.com/OdonataResearchLLC/linear-algebra) and currently maintained by Brian Eberman and Steve Nunez.
Current goals are to implement backends that use BLAS/LAPACK and CUDA.
0.1.1
Modules are listed depth-first from the system components tree.
linear-algebra (system).
kernel (module).
linear-algebra (system).
interface (module).
linear-algebra (system).
Files are sorted by type and then listed depth-first from the systems components trees.
linear-algebra (system).
kernel (module).
linear-algebra (system).
pkgdcl.lisp (file).
kernel (module).
pkgdcl.lisp (file).
kernel (module).
pkgdcl.lisp (file).
kernel (module).
%abs-vector (function).
pkgdcl.lisp (file).
kernel (module).
unary-operations.lisp (file).
kernel (module).
pkgdcl.lisp (file).
kernel (module).
unary-operations.lisp (file).
kernel (module).
binary-operations.lisp (file).
kernel (module).
conjugate-gradient-solver (function).
pkgdcl.lisp (file).
kernel (module).
tridiagonal-solver (function).
interface (module).
fundamental-ops.lisp (file).
interface (module).
fundamental-ops.lisp (file).
interface (module).
initialize-matrix-contents (generic function).
matrix.lisp (file).
interface (module).
matrix.lisp (file).
interface (module).
sequence (module).
sequence (module).
sequence (module).
interface (module).
linear-algebra (system).
data-vector.lisp (file).
linear-algebra (system).
dense-matrix.lisp (file).
linear-algebra (system).
initialize-matrix-contents (method).
square-matrix.lisp (file).
linear-algebra (system).
square-matrix.lisp (file).
linear-algebra (system).
Packages are listed by definition order.
Definitions are sorted by export status, category, package, and then by lexicographic order.
Iterate over vector returning result.
Array binary addition.
Vector binary addition.
Create a column vector from the numbers.
Return true if object is a column-vector, NIL otherwise.
Return the array type common to both arrays.
Return the common class of the 2 objects or default-class.
Return true if both numbers are complex and equal.
Linear system solver using the conjugate gradient method.
Return true if object is a dense matrix.
Find A^-1 via Gauss algorithm with partial column pivot search.
Gauss algorithm with column pivot search.
Return c,s,r defined from the Givens rotation.
Factor A = LL^T.
Invert a positive definite matrices using the root-free Cholesky decomposition.
Linear system solver for positive definite matrices using the root-free Cholesky decomposition.
Return true if object is a hermitian-matrix, NIL otherwise.
Return Beta, Tau and the Householder vector.
Return true if object is an identity-matrix.
Return the vector inner product.
Return a, b, cos(theta) and sin(theta) terms from the Jacobi rotation.
Return a new matrix instance.
Create the data structure to represent a vector.
Returns a validated range of rows and columns for the matrix.
Return true if object is a matrix, NIL otherwise.
Destructive array binary addition.
Destructive vector binary addition.
Destructive array binary subtraction.
Destructive vector binary subtraction.
Return true if the numbers are equal using the appropriate comparison.
Return true if object is a permutation-matrix.
Return the scaled result of the product of 2 arrays.
Return the result of the array postmultiplied by the vector and scaled.
Return the result of the array premultiplied by the vector and scaled.
Factor A = LDL^t.
Factor A = LDL^t.
Create a row vector from the numbers.
Return true if object is a row-vector, NIL otherwise.
Return the specific type of the element specified by subscripts.
Return true if OBJECT is a square matrix.
Array binary subtraction.
Vector binary subtraction.
Return the scaling parameter and the sum of the squares of the array column.
Return the scaling parameter and the sum of the squares of the array row.
Return the square root of |x|^2 + |y|^2.
Return the square root of |x|^2 + |y|^2 + |z|^2.
Factor A = LL^T.
Invert a positive definite matrices using the root-free Cholesky decomposition.
Linear system solver for positive definite matrices using the root-free Cholesky decomposition.
Return true if object is a symmetric-matrix, NIL otherwise.
Linear equation solver for a tridiagonal matrix.
Vector or matrix binary addition.
Return the addition of the 2 matrices.
Audit the input data.
Return the addition of scalar1*vector1 with scalar2*vector2.
Return the addition of scalar1*vector1 with scalar2*vector2.
Verify that the dimensions are equal.
Return the addition of the 2 arrays.
Return the addition of scalar1*vector1 with scalar2*vector2
Return the plane rotations of vector1 and vector2 by cc and ss.
Return the plane rotations of vector1 and vector2 by cc and ss.
Verify the input to apply-rotation.
Return true if the vector and matrix dimensions are compatible for the operation.
Return true if the array dimensions are compatible for product.
Return true if the array dimensions are compatible for product.
Return true if the array dimensions are compatible for product.
Return true if the array dimensions are compatible for product.
Return true if the array dimensions are compatible for an addition.
Return true if the array dimensions are compatible for product.
Return true if the array dimensions are compatible for product.
Return true if the vector dimensions are compatible for an addition.
Return an element-wise copy of the original array.
Return a copy of the matrix.
Return a copy of the dense matrix.
Return a copy of the permutation matrix.
Return a copy of the matrix.
Return a copy of the vector.
Return a copy of the vector.
Return the invert of the matrix.
Return the invert of the symmetric matrix.
Return the invert of the hermitian matrix.
Return the invert of the square matrix.
Return the invert of the dense matrix.
Return the invert of the array.
Permute the column vector or rows of the array.
Destructively modifies the result vector with the result of applying the function to each element of the vectors.
Destructively modifies the result vector with the result of applying the function to each element of the vectors.
Verify the arguments to map-into-vector.
Calls function on successive sets of vector objects.
Calls function on successive sets of data vectors.
Verify the arguments to map-vector.
Return the number of columns in MATRIX.
Return the number of columns in matrix.
Return the number of columns in matrix.
automatically generated reader method
size.
Return the number of rows and columns in MATRIX.
Return the number of rows and columns in matrix.
Return the number of rows and columns in matrix.
Return the number of rows and columns in matrix.
Return the element type of MATRIX.
Return the element type of the matrix.
Element type of the permutation matrix.
Return the element type of the identity matrix.
Return true if ROW and COLUMN do not exceed the dimensions of MATRIX.
Return true if row and column do not exceed the dimensions of matrix.
Return true if row and column do not exceed the dimensions of matrix.
Return true if row and column do not exceed the dimensions of matrix.
Return the number of rows in MATRIX.
Return the number of rows in matrix.
Return the number of rows in matrix.
automatically generated reader method
size.
Return the matrix element at ROW,COLUMN.
Return the element of matrix at row,column.
Return 1 if a permutation and 0 otherwise.
Return the element of the matrix at row,column.
Set the element at row,column of matrix to data.
Set the element of matrix at row,column.
Set the element at row,column of matrix to data.
Set the element of matrix at row,column.
Swap rows of the permutation matrix.
Destructive vector or matrix addition.
Generate an error if a non-symmetric matrix is destructively added to a symmetric matrix.
Return the addition of the 2 matrices.
Audit the input data.
Return the addition of scalar2*vector2 to scalar1*vector1.
Return the addition of scalar2*vector2 to scalar1*vector1.
Verify that the dimensions are equal.
Destructively add array2 to array1.
Return the addition of scalar2*vector2 to scalar1*vector1.
Return the plane rotations of vector1 and vector2 by cc and ss.
Return the plane rotations of vector1 and vector2 by cc and ss.
Verify the input to napply-rotation.
Return the invert of the matrix with in-place decomposition.
Return the invert of the symmetric matrix.
Return the invert of the hermitian matrix.
Return the invert of the square matrix.
Return the invert of the dense matrix.
Return the invert of the array.
Return the norm according to measure.
Return the norm of the matrix.
Return the p-norm of the vector.
Return the norm of the array.
Return the norm of the array according to the measure.
Return the infinity norm of the array.
Return the Frobenius norm of the array.
Return the max norm of the array.
Return the 1 norm of the array.
Return the norm of the vector according to the measure.
Return the infinity, or maximum, norm of vector.
Return the p-norm of the vector.
Return the Euclidean norm of the vector.
Return the Taxicab norm of the list.
Destructively scale each element by the scalar.
Scale each element of the dense matrix.
Return the vector destructively scaled by scalar.
Scale each element of the array.
Return the vector destructively scaled by scalar.
Return the solution to the system of equations in-place.
Return the solution to the system of equations.
Return the solution to the system of equations.
Return the solution to the system of equations.
Return the solution to the system of equations.
Return the solution to the system of equations.
Destructive vector or matrix subtraction.
Generate an error if a non-symmetric matrix is destructively subtracted to a symmetric matrix.
Return the addition of the 2 matrices.
Audit the input data.
Return the subraction of scalar2*vector2 from scalar1*vector1.
Return the subraction of scalar2*vector2 from scalar1*vector1.
Verify that the dimensions are equal.
Destructively subtract array2 from array1.
Return the subraction of scalar2*vector2 from scalar1*vector1.
Destructively transpose the vector or matrix.
The destructive transpose of a Hermitian matrix is itself.
Replace the contents of the dense matrix with the transpose.
Return a column vector destructively.
Return a row vector destructively.
Replace the contents of the array with the transpose.
Return a row vector destructively.
Permute the vector or matrix.
Return the permutation of the column vector.
Verify that the dimensions are compatible.
Return the permutation of the row vector.
Verify that the dimensions are compatible.
Return the permutation of the list.
Return the permutation of the list.
Return the permutation of the list.
Return the permutation of the list.
Return the vector-vector, matrix-vector or matrix-matrix product.
Return the product of the dense matrices.
Verify the input.
Return a column vector generated by the multiplication of the dense matrix with a column vector.
Verify the input.
Return a row vector generated by the pre-multiplication of a dense matrix by a row vector.
Verify the inputs.
Return the dot product of vector1 and vector2.
Verify that the dimensions are equal.
Return the product of the arrays.
Return a vector generated by the multiplication of the array with a vector.
Return a vector generated by the pre-multiplication of a array by a vector.
Return the dot product of vector1 and vector2.
Destructively replace elements of matrix1 with matrix2.
Replace the elements of MATRIX1 with MATRIX2.
Replace the elements of MATRIX1 with MATRIX2.
Replace the elements of matrix1 with matrix2.
Replace the elements of matrix1 with matrix2.
Replace the elements of matrix1 with matrix2.
Destructively replace the elements of vector1 with vector2.
Destructively replace the elements of vector1 with vector2.
Permute the row vector or columns of the array.
Scale each element by the scalar.
Scale each element of the dense matrix.
Return the vector scaled by scalar.
Scale each element of the array.
Return the vector scaled by scalar.
Compile and return a scaled binary operation.
Return the scaled operation.
Return the scaled operation.
Return the scaled operation.
Return the scaled operation.
Return the scaled operation.
Return the scaled operation.
Return the operation.
Return the solution to the system of equations.
Return the solution to the system of equations.
Return the solution to the system of equations.
Return the solution to the system of equations.
Return the solution to the system of equations.
Return the solution to the system of equations.
Return a submatrix of the matrix.
Return a matrix created from the submatrix of matrix.
Return a matrix created from the submatrix of matrix.
Return a matrix created from the submatrix of matrix.
Return a dense matrix created from the submatrix of a matrix.
Set the submatrix of the matrix.
Set a submatrix of MATRIX.
Set a submatrix of the matrix.
Set a submatrix of the matrix.
Set a submatrix of the matrix.
Set the submatrix of matrix.
Vector or matrix binary subtraction.
Return the addition of the 2 matrices.
Audit the input data.
Return the subraction of scalar2*vector2 from scalar1*vector1.
Return the subraction of scalar2*vector2 from scalar1*vector1.
Verify that the dimensions are equal.
Return the subtraction of the 2 arrays.
Return the subraction of scalar2*vector2 from scalar1*vector1.
Return a new vector that is a subvector of the vector.
Return a new data vector that is a subset of vector.
Set the subvector of the vector.
Set the subvector of the data vector.
Return the scaling parameter and the sum of the P powers.
Return the scaling parameter and the sum of the P powers of the matrix.
Return the scaling parameter and the sum of the powers of p of the vector.
Return the scaling parameter and the sum of the powers of p of the data.
Return the scaling parameter and the sum of the squares.
Return the scaling parameter and the sum of the squares of the array.
Return the scaling parameter and the sum of the squares of the vector.
Return the scaling parameter and the sum of the squares of the list.
Transpose the vector or matrix.
The transpose of a Hermitian matrix is itself.
Return the transpose of the matrix.
Return a column vector.
Return a row vector.
Return the transpose of the array.
Return a row vector.
Transpose the permutation matrix.
Return the element type of vector.
Return the element type of vector.
Return true if index does not exceed the dimensions of vector.
Return true if index does not exceed the dimensions of vector.
Return the length of the vector.
Return the length of the vector.
Return the element of vector at index.
Return the element of vector at index.
Set the element of vector at index to data.
Set the element of vector at index to data.
Initialize the identity matrix.
Verify that the element-type was not set and that rows equals columns.
A column vector.
A data vector.
(array * (*))
:contents
Dense matrix object.
(array * (* *))
:contents
Hermitian matrix object.
Identity matrix object.
fixnum
:size
This slot is read-only.
A superclass for all matrices.
Permutation matrix object.
(array fixnum (*))
:contents
A row vector.
Square matrix object.
Symmetric matrix object.
Return a vector containing absolute value of each element.
Return a default epsilon for the conjugate gradient method.
Return the initial residual vector for the conjugate gradient.
Return an initial solution vector for the conjugate gradient.
Initialize and validate a Hermitian matrix with a sequence.
Initialize and validate a symmetric matrix with a sequence.
Non-validating version of map-vector.
Non-validating version of map-into-vector.
Return the negative of the residual.
Return the result of the product of 2 arrays.
Return the result of the array postmultiplied by the vector.
Return the result of the array premultiplied by the vector.
Destructively replace a subset off the diagonal of matrix1 with matrix2.
Destructively replace a subset on the diagonal of matrix1 with matrix2.
Destructively replace a subset off the diagonal of matrix1 with matrix2.
Destructively replace a subset on the diagonal of matrix1 with matrix2.
Return the scaled result of the product of 2 arrays.
Return the result of the array postmultiplied by the vector and scaled.
Return the result of the array premultiplied by the vector and scaled.
Store the result of the binary operation in vector1.
Store the result of the binary operation in a new vector.
Return the LR pivot of the array.
Return the row index of the maximum value in the column.
Calculate the solution by backsubstitution.
Return the Gauss factorization of the array.
Update the solution vector.
Return a new, initialized, pivot vector.
Interchange the
Perform backsubstitution to obtain the solution.
Return the factorization of the tridiagonal array.
Update the solution vector using the factored array.
Return 1.0 if column equals the value at row of the pivot selection vector, otherwise 0.0.
Return an array of zeros.
Return a vector of zeros.
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated writer method
automatically generated writer method
automatically generated writer method
Initialize the matrix with data.
Initialize a symmetric matrix.
Initialize a symmetric matrix.
Initialize a symmetric matrix.
Initialize the Hermitian matrix with a 2D array.
Initialize the Hermitian matrix with a nested sequence.
Initialize the Hermitian matrix with a nested sequence.
It is an error to initialize a Hermitian matrix with a complex element.
Verify that the number of rows and colums are equal.
Verify that the size of the data is valid.
Initialize the dense matrix with a nested sequence.
Initialize the dense matrix with a nested sequence.
Initialize the dense matrix with an initial element.
Initialize the permutation matrix with a 2D array.
Initialize the permutation matrix with a list.
Initialize the permutation matrix with a list.
automatically generated reader method
size.
Jump to: | %
(
A C D F G H I J L M N P R S T U V Z |
---|
Jump to: | %
(
A C D F G H I J L M N P R S T U V Z |
---|
Jump to: | C S |
---|
Jump to: | C S |
---|
Jump to: | A B C D F G H I K L M P R S T U V |
---|
Jump to: | A B C D F G H I K L M P R S T U V |
---|