Mercurial > octave-antonio
comparison scripts/linear-algebra/expm.m @ 20160:03b9d17a2d95 stable
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 |
---|---|
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} {} expm (@var{A}) | 20 ## @deftypefn {Function File} {} expm (@var{A}) |
21 ## Return the exponential of a matrix, defined as the infinite Taylor | 21 ## Return the exponential of a matrix. |
22 ## series | 22 ## |
23 ## The matrix exponential is defined as the infinite Taylor series | |
23 ## @tex | 24 ## @tex |
24 ## $$ | 25 ## $$ |
25 ## \exp (A) = I + A + {A^2 \over 2!} + {A^3 \over 3!} + \cdots | 26 ## \exp (A) = I + A + {A^2 \over 2!} + {A^3 \over 3!} + \cdots |
26 ## $$ | 27 ## $$ |
27 ## @end tex | 28 ## @end tex |
30 ## @example | 31 ## @example |
31 ## expm (A) = I + A + A^2/2! + A^3/3! + @dots{} | 32 ## expm (A) = I + A + A^2/2! + A^3/3! + @dots{} |
32 ## @end example | 33 ## @end example |
33 ## | 34 ## |
34 ## @end ifnottex | 35 ## @end ifnottex |
35 ## The Taylor series is @emph{not} the way to compute the matrix | 36 ## However, the Taylor series is @emph{not} the way to compute the matrix |
36 ## exponential; see @nospell{Moler and Van Loan}, @cite{Nineteen Dubious Ways | 37 ## exponential; see @nospell{Moler and Van Loan}, @cite{Nineteen Dubious Ways |
37 ## to Compute the Exponential of a Matrix}, SIAM Review, 1978. This routine | 38 ## to Compute the Exponential of a Matrix}, SIAM Review, 1978. This routine |
38 ## uses Ward's diagonal Pad@'e approximation method with three step | 39 ## uses Ward's diagonal Pad@'e approximation method with three step |
39 ## preconditioning (SIAM Journal on Numerical Analysis, 1977). Diagonal | 40 ## preconditioning (SIAM Journal on Numerical Analysis, 1977). Diagonal |
40 ## Pad@'e approximations are rational polynomials of matrices | 41 ## Pad@'e approximations are rational polynomials of matrices |