Skip to content

Commit 9d4c235

Browse files
committed
readme: add instance method 'isInvertible()' api
1 parent 8f6b392 commit 9d4c235

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

+44
Original file line numberDiff line numberDiff line change
@@ -693,6 +693,7 @@ $ npm install eigenjs --msvs_version=2012
693693
* [fplu.martixU()](#fplumatrixu)
694694
* [fplu.determinant()](#fpludeterminant)
695695
* [fplu.inverse()](#fpluinverse)
696+
* [fplu.isInvertible()](#fpluisinvertible)
696697
* [fplu.solve(mat)](#fplusolvemat)
697698
* [fplu.solve(vec)](#fplusolvevec)
698699
* [fplu.rank()](#fplurank)
@@ -709,6 +710,7 @@ $ npm install eigenjs --msvs_version=2012
709710
* [cfplu.martixU()](#cfplumatrixu)
710711
* [cfplu.determinant()](#cfpludeterminant)
711712
* [cfplu.inverse()](#cfpluinverse)
713+
* [cfplu.isInvertible()](#cfpluisinvertible)
712714
* [cfplu.solve(cmat)](#cfplusolvecmat)
713715
* [cfplu.solve(cvec)](#cfplusolvecvec)
714716
* [cfplu.rank()](#cfplurank)
@@ -6487,6 +6489,27 @@ console.log('%s', inv.isApprox(mat.inverse()));
64876489
true
64886490
```
64896491

6492+
#### fplu.isInvertible()
6493+
6494+
Returns true if the matrix of which *this is the LU decomposition is invertible.
6495+
6496+
```js
6497+
var Eigen = require('eigenjs')
6498+
, M = Eigen.Matrix
6499+
, FPLU = Eigen.FullPivLU
6500+
, mat = new M(3, 3).set([
6501+
1, 4, 5,
6502+
4, 2, 6,
6503+
5, 6, 3
6504+
])
6505+
, fplu = new FPLU(mat);
6506+
console.log('%s', fplu.isInvertible());
6507+
```
6508+
6509+
```txt
6510+
true
6511+
```
6512+
64906513
#### fplu.solve(mat)
64916514
#### fplu.solve(vec)
64926515

@@ -6765,6 +6788,27 @@ console.log('%s', inv.isApprox(cmat.inverse()));
67656788
true
67666789
```
67676790

6791+
#### cfplu.isInvertible()
6792+
6793+
Returns true if the complex matrix of which *this is the LU decomposition is invertible.
6794+
6795+
```js
6796+
var Eigen = require('eigenjs')
6797+
, CM = Eigen.Matrix
6798+
, CFPLU = Eigen.CFullPivLU
6799+
, cmat = new CM(3, 3).set([
6800+
1, 4, 5,
6801+
4, 2, 6,
6802+
5, 6, 3
6803+
])
6804+
, cfplu = new CFPLU(cmat);
6805+
console.log('%s', cfplu.isInvertible());
6806+
```
6807+
6808+
```txt
6809+
true
6810+
```
6811+
67686812
#### cfplu.solve(cmat)
67696813
#### cfplu.solve(cvec)
67706814

0 commit comments

Comments
 (0)