comparison scripts/linear-algebra/isbanded.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} {} isbanded (@var{x}, @var{lower}, @var{upper}) 20 ## @deftypefn {Function File} {} isbanded (@var{A}, @var{lower}, @var{upper})
21 ## Return true if @var{x} is a matrix with entries confined between 21 ## Return true if @var{A} is a matrix with entries confined between
22 ## @var{lower} diagonals below the main diagonal and @var{upper} diagonals 22 ## @var{lower} diagonals below the main diagonal and @var{upper} diagonals
23 ## above the main diagonal. 23 ## above the main diagonal.
24 ## 24 ##
25 ## @var{lower} and @var{upper} must be non-negative integers. 25 ## @var{lower} and @var{upper} must be non-negative integers.
26 ## @seealso{isdiag, istril, istriu, bandwidth} 26 ## @seealso{isdiag, istril, istriu, bandwidth}