Mercurial > octave-libgccjit
comparison scripts/linear-algebra/istril.m @ 18921:d0d0858cfab1
doc: Match docstring variable names to function variable names for linear-algebra m-files.
* isbanded.m, isdefinite.m, isdiag.m, ishermitian.m, issymmetric.m, istril.m,
istriu.m: Use 'A' for input matrix in linear algebra routines. Change docstrings
from 'x' to 'A'.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 14 Jul 2014 08:54:45 -0700 |
parents | 9addb5ad9426 |
children |
comparison
equal
deleted
inserted
replaced
18920:c4def7ab39e7 | 18921:d0d0858cfab1 |
---|---|
15 ## You should have received a copy of the GNU General Public License | 15 ## You should have received a copy of the GNU General Public License |
16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {} istril (@var{x}) | 20 ## @deftypefn {Function File} {} istril (@var{A}) |
21 ## Return true if @var{x} is a lower triangular matrix. | 21 ## Return true if @var{A} is a lower triangular matrix. |
22 ## | 22 ## |
23 ## A lower triangular matrix has nonzero entries only on the main diagonal | 23 ## A lower triangular matrix has nonzero entries only on the main diagonal |
24 ## and below. | 24 ## and below. |
25 ## @seealso{istriu, isbanded, isdiag, tril, bandwidth} | 25 ## @seealso{istriu, isbanded, isdiag, tril, bandwidth} |
26 ## @end deftypefn | 26 ## @end deftypefn |