Mercurial > hg > octave-lyh
comparison scripts/linear-algebra/trace.m @ 16960:7c575556e817
trace.m: Use @deftypefn instead of @deftypefnx in docstring.
* scripts/linear-algebra/trace.m: Use @deftypefn instead of @deftypefnx in
docstring.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 11 Jul 2013 13:08:43 -0700 |
parents | ec6ced0ece87 |
children |
comparison
equal
deleted
inserted
replaced
16959:22ec459cf7ba | 16960:7c575556e817 |
---|---|
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 ## @deftypefnx {Function File} {} trace (@var{A}) | 20 ## @deftypefn {Function File} {} trace (@var{A}) |
21 ## Compute the trace of @var{A}, the sum of the elements along the main | 21 ## Compute the trace of @var{A}, the sum of the elements along the main |
22 ## diagonal. | 22 ## diagonal. |
23 ## | 23 ## |
24 ## The implementation is straightforward: @code{sum (diag (@var{A}))}. | 24 ## The implementation is straightforward: @code{sum (diag (@var{A}))}. |
25 ## @seealso{eig} | 25 ## @seealso{eig} |