Class Solver Abstract

Base class for constraint solvers.

Hierarchy

Solver
- GSSolver

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Solver(options?: SolverOptions, type: 1): Solver

- Defined in solver/Solver.ts:35
Parameters
- options: SolverOptions = {}
- type: 1
Returns Solver

Properties

Optional equationSortFunction

equationSortFunction?: ((a: Equation, b: Equation) => number)

Type declaration

- (a: Equation, b: Equation): number
- Function that is used to sort all equations before each solve.
  
  Parameters
  - a: Equation
  - b: Equation
  Returns number

equations

equations: Equation[]

Current equations in the solver.

type

type: number

The type of solver.

Static GS

GS: 1

Gauss-Seidel solver.

Methods

addEquation

addEquation(eq: Equation): void

- Defined in solver/Solver.ts:61
Add an equation to be solved.

Parameters
- eq: Equation
Returns void

addEquations

addEquations(eqs: Equation[]): void

- Defined in solver/Solver.ts:71
Add equations. Same as .addEquation, but this time the argument is an array of Equations

Parameters
- eqs: Equation[]
Returns void

removeAllEquations

removeAllEquations(): void

- Defined in solver/Solver.ts:94
Removes all currently added equations

Returns void

removeEquation

removeEquation(eq: Equation): void

- Defined in solver/Solver.ts:84
Removes an equation

Parameters
- eq: Equation
Returns void

Abstract solve

solve(dt: number, world: World): void

- Defined in solver/Solver.ts:46
Method to be implemented in each subclass

Parameters
- dt: number
- world: World
Returns void

sortEquations

sortEquations(): void

- Defined in solver/Solver.ts:51
Sort all equations using the .equationSortFunction. Should be called by subclasses before solving.

Returns void