Welcome to the lnagb.js documentation!
The goal of the documentation is to provide, in great details, information on
how to use all of lnagb.js’s functions, classes, and their methods. The pages
in this documentation are generated from the docstrings placed along with the
source code of lnagb.js itself using jsdoc-to-markdown. The
documentation can be generated with
npm install # Install dependencies
npm run build-docs # Build the documentation
The whole lnagb.js library is composed of modules. Structurally, the library
contains 3 modules named Equations, Matrices, and Vectors, along
with minor modules such as Functions.js. Each of the major 3 modules contains
sub-modules, each containing a class that encodes the properties and operations
attributed to a mathematical symbol in linear algebra. (e.g. the Vector
sub-module of Vectors contains the Vector class, which encodes the
properties and operations of vector quantities).
This module contains sub-modules which have JavaScript classes for representing linear equations and linear systems.
| Module | Description |
|---|---|
| LinearEquation |
Contains the LinearEquation class, which encodes linear equations of any number of variables.
|
| LinearEquation2 |
Contains the LinearEquation2 class, which encodes linear equations with 2 variables.
|
| LinearEquation3 |
Contains the LinearEquation3 class, which encodes linear equations with 3 variables.
|
| LinearEquation4 |
Contains the LinearEquation2 class, which encodes linear equations with 4 variables.
|
| SystemOfLinearEquations |
Contains the SystemOfLinearEquations class, which encodes systems of linear equations.
|
This module contains sub-modules for working with matrices. Currently supported operations include transposition, elementary row operations, and multiplication.
| Module | Description |
|---|---|
| Matrix |
Contains the Matrix class, which encodes basic matrices of any size in linear algebra.
|
| Matrix2 |
Contains the Matrix2 class, which encodes 2 x 2 matrices in linear algebra.
|
| Matrix3 |
Contains the Matrix3 class, which encodes 3 x 3 matrices in linear algebra.
|
| Matrix4 |
Contains the Matrix4 class, which encodes 4 x 4 matrices in linear algebra.
|
| SquareMatrix |
Contains the SquareMatrix class, which is similar to the Matrix class but only encodes square matrices.
|
| IdentityMatrix |
Contains the IdentityMatrix class, which encodes read-only identity matrices.
|
| AugmentedMatrix |
Contains the AugmentedMatrix class, which encodes augmented matrices.
|
| MatrixTranspose |
Contains the MatrixTranspose class, which storage-efficiently encodes transpositions.
|
This module contains sub-modules that contain vector classes. Basic vector operations such as addition, subtraction, and dot/cross multiplication are implemented within these classes.
| Module | Description |
|---|---|
| Vector |
Contains the Vector class, which encodes vector quantities of any number of entries in linear algebra.
|
| Vector2 |
Contains the Vector2 class, which encodes 2-vectors.
|
| Vector3 |
Contains the Vector3 class, which encodes 3-vectors.
|
| Vector4 |
Contains the Vector4 class, which encodes 4-vectors.
|
Found a mistake in the docs? Have questions? Open an issue or send an e-mail.