Mercurial > octave-antonio

comparison scripts/linear-algebra/logm.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 20
21 ## -*- texinfo -*- 21 ## -*- texinfo -*-
22 ## @deftypefn {Function File} {@var{s} =} logm (@var{A}) 22 ## @deftypefn {Function File} {@var{s} =} logm (@var{A})
23 ## @deftypefnx {Function File} {@var{s} =} logm (@var{A}, @var{opt_iters}) 23 ## @deftypefnx {Function File} {@var{s} =} logm (@var{A}, @var{opt_iters})
24 ## @deftypefnx {Function File} {[@var{s}, @var{iters}] =} logm (@dots{}) 24 ## @deftypefnx {Function File} {[@var{s}, @var{iters}] =} logm (@dots{})
25 ## Compute the matrix logarithm of the square matrix @var{A}. The 25 ## Compute the matrix logarithm of the square matrix @var{A}.
26 ## implementation utilizes a Pad@'e approximant and the identity 26 ##
27 ## The implementation utilizes a Pad@'e approximant and the identity
27 ## 28 ##
28 ## @example 29 ## @example
29 ## logm (@var{A}) = 2^k * logm (@var{A}^(1 / 2^k)) 30 ## logm (@var{A}) = 2^k * logm (@var{A}^(1 / 2^k))
30 ## @end example 31 ## @end example
31 ## 32 ##
32 ## The optional argument @var{opt_iters} is the maximum number of square roots 33 ## The optional input @var{opt_iters} is the maximum number of square roots
33 ## to compute and defaults to 100. The optional output @var{iters} is the 34 ## to compute and defaults to 100.
34 ## number of square roots actually computed. 35 ##
36 ## The optional output @var{iters} is the number of square roots actually
37 ## computed.
35 ## @seealso{expm, sqrtm} 38 ## @seealso{expm, sqrtm}
36 ## @end deftypefn 39 ## @end deftypefn
37 40
38 ## Reference: N. J. Higham, Functions of Matrices: Theory and Computation 41 ## Reference: N. J. Higham, Functions of Matrices: Theory and Computation
39 ## (SIAM, 2008.) 42 ## (SIAM, 2008.)