better documented return type for lup function

This commit is contained in:
Harry Sarson 2017-03-01 22:59:21 +00:00
parent 2f5fd8005c
commit da361ae71f

View File

@ -44,7 +44,7 @@ function factory (type, config, load, typed) {
*
* @param {Matrix | Array} A A two dimensional matrix or array for which to get the LUP decomposition.
*
* @return {Object} The lower triangular matrix, the upper triangular matrix and the permutation matrix.
* @return {{L: Array | Matrix, U: Array | Matrix, P: Array.<number>}} The lower triangular matrix, the upper triangular matrix and the permutation matrix.
*/
var lup = typed('lup', {