From da361ae71f79c3dc2edf2bdfaa30c2516dd62eff Mon Sep 17 00:00:00 2001 From: Harry Sarson Date: Wed, 1 Mar 2017 22:59:21 +0000 Subject: [PATCH] better documented return type for lup function --- lib/function/algebra/decomposition/lup.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/function/algebra/decomposition/lup.js b/lib/function/algebra/decomposition/lup.js index 964f1375c..0e5f69b85 100644 --- a/lib/function/algebra/decomposition/lup.js +++ b/lib/function/algebra/decomposition/lup.js @@ -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.}} The lower triangular matrix, the upper triangular matrix and the permutation matrix. */ var lup = typed('lup', {