lnagb.js Documentation

SystemOfLinearEquations

Contains the SystemOfLinearEquations class, which encodes systems of linear equations.

Author: Zach / cszach@proton.me

• SystemOfLinearEquations
  • ~SystemOfLinearEquations
    • new SystemOfLinearEquations(equations)
    • instance
      • .equations : Array.<LinearEquation>
      • .numberOfVariables : number
      • .numberOfEquations : number
      • .coefficientMatrix : Matrix
      • .constantMatrix : Matrix
      • .augmentedMatrix : AugmentedMatrix
      • .clone() ⇒ SystemOfLinearEquations
      • .computeCoefficientMatrix()
      • .computeConstantMatrix()
      • .computeAugmentedMatrix()
      • .lazyComputeAugmentedMatrix()
      • .forEach(callback, thisArg)
    • inner
      • ~forEach : function

---

SystemOfLinearEquations~SystemOfLinearEquations

Encodes systems of linear equations by storing instances of LinearEquations in an array.

Kind: inner class of SystemOfLinearEquations

• ~SystemOfLinearEquations
  • new SystemOfLinearEquations(equations)
  • instance
    • .equations : Array.<LinearEquation>
    • .numberOfVariables : number
    • .numberOfEquations : number
    • .coefficientMatrix : Matrix
    • .constantMatrix : Matrix
    • .augmentedMatrix : AugmentedMatrix
    • .clone() ⇒ SystemOfLinearEquations
    • .computeCoefficientMatrix()
    • .computeConstantMatrix()
    • .computeAugmentedMatrix()
    • .lazyComputeAugmentedMatrix()
    • .forEach(callback, thisArg)
  • inner
    • ~forEach : function

---

new SystemOfLinearEquations(equations)

Constructs a new instance of SystemOfLinearEquations, which encodes a system of linear equations.

Param	Type	Description
equations	Array.<LinearEquation>	Instances of LinearEquation for the system.

---

systemOfLinearEquations.equations : Array.<LinearEquation>

Array of linear equations of this system.

Kind: instance property of SystemOfLinearEquations

---

systemOfLinearEquations.numberOfVariables : number

The number of variables of this system.

Kind: instance property of SystemOfLinearEquations

---

systemOfLinearEquations.numberOfEquations : number

The number of linear equations in this system.

Kind: instance property of SystemOfLinearEquations

---

systemOfLinearEquations.coefficientMatrix : Matrix

The coefficient matrix of this system of linear equations, obtained by calling computeCoefficientMatrix.

Kind: instance property of SystemOfLinearEquations

---

systemOfLinearEquations.constantMatrix : Matrix

The constant matrix of this system of linear equations, obtained by calling computeConstantMatrix.

Kind: instance property of SystemOfLinearEquations

---

systemOfLinearEquations.augmentedMatrix : AugmentedMatrix

The augmented matrix of this system of linear equations, obtained by calling computeAugmentedMatrix.

Kind: instance property of SystemOfLinearEquations

---

systemOfLinearEquations.clone() ⇒ SystemOfLinearEquations

Creates and returns a new instance that is the same as this instance.

Kind: instance method of SystemOfLinearEquations
Returns: SystemOfLinearEquations - A clone of this instance

---

systemOfLinearEquations.computeCoefficientMatrix()

Computes the coefficient matrix of this system of linear equations and assigns the matrix to the coefficientMatrix property.

Kind: instance method of SystemOfLinearEquations

---

systemOfLinearEquations.computeConstantMatrix()

Computes the constant matrix of this system of linear equations and assigns the matrix to the constantMatrix property.

Kind: instance method of SystemOfLinearEquations

---

systemOfLinearEquations.computeAugmentedMatrix()

Computes the augmented matrix of this system of linear equations and assigns the matrix to the augmentedMatrix property.

Kind: instance method of SystemOfLinearEquations

---

systemOfLinearEquations.lazyComputeAugmentedMatrix()

Computes the augmented matrix of this system of linear equations and assigns the matrix to the augmentedMatrix property provided that the coefficient matrix and the constant matrix have been computed.

Kind: instance method of SystemOfLinearEquations

---

systemOfLinearEquations.forEach(callback, thisArg)

Executes a function for each equation in this system.

Kind: instance method of SystemOfLinearEquations

Param	Type	Description
callback	forEach	The function to execute per iteration.
thisArg	object	The argument to use as this in the function.

---

SystemOfLinearEquations~forEach : function

Kind: inner typedef of SystemOfLinearEquations

Param	Type	Description
equation	LinearEquation	The current equation being processed.
coefficients	Array.<number>	The coefficients of the equation.
constant	number	The constant term of the equation.
index	number	The 0-based position of the equation in this.equations.
system	SystemOfLinearEquations	The instance that this method was called upon.

---

This site is open source. Improve this page.