Mercurial > octave-antonio

comparison scripts/linear-algebra/bandwidth.m @ 20160:03b9d17a2d95 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 15:36:23 -0700
parents 9fc020886ae9
children
comparison
equal deleted inserted replaced
20159:597991b19e40 20160:03b9d17a2d95
20 ## @deftypefn {Function File} {@var{bw} =} bandwidth (@var{A}, @var{type}) 20 ## @deftypefn {Function File} {@var{bw} =} bandwidth (@var{A}, @var{type})
21 ## @deftypefnx {Function File} {[@var{lower}, @var{upper}] =} bandwidth (@var{A}) 21 ## @deftypefnx {Function File} {[@var{lower}, @var{upper}] =} bandwidth (@var{A})
22 ## Compute the bandwidth of @var{A}. 22 ## Compute the bandwidth of @var{A}.
23 ## 23 ##
24 ## The @var{type} argument is the string @qcode{"lower"} for the lower 24 ## The @var{type} argument is the string @qcode{"lower"} for the lower
25 ## bandwidth and @qcode{"upper"} for the upper bandwidth. 25 ## bandwidth and @qcode{"upper"} for the upper bandwidth. If no @var{type} is
26 ## If no @var{type} is specified return both the lower and upper bandwidth 26 ## specified return both the lower and upper bandwidth of @var{A}.
27 ## of @var{A}.
28 ## 27 ##
29 ## The lower/upper bandwidth of a matrix is the number of 28 ## The lower/upper bandwidth of a matrix is the number of
30 ## subdiagonals/superdiagonals with nonzero entries. 29 ## subdiagonals/superdiagonals with nonzero entries.
31 ## 30 ##
32 ## @seealso{isbanded, isdiag, istril, istriu} 31 ## @seealso{isbanded, isdiag, istril, istriu}