Mercurial > octave-antonio
comparison scripts/linear-algebra/cross.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 | 4197fc428c7d |
| children |
comparison
equal
deleted
inserted
replaced
| 20159:597991b19e40 | 20160:03b9d17a2d95 |
|---|---|
| 17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} cross (@var{x}, @var{y}) | 20 ## @deftypefn {Function File} {} cross (@var{x}, @var{y}) |
| 21 ## @deftypefnx {Function File} {} cross (@var{x}, @var{y}, @var{dim}) | 21 ## @deftypefnx {Function File} {} cross (@var{x}, @var{y}, @var{dim}) |
| 22 ## Compute the vector cross product of two 3-dimensional vectors | 22 ## Compute the vector cross product of two 3-dimensional vectors @var{x} and |
| 23 ## @var{x} and @var{y}. | 23 ## @var{y}. |
| 24 ## | |
| 25 ## If @var{x} and @var{y} are matrices, the cross product is applied along the | |
| 26 ## first dimension with three elements. | |
| 27 ## | |
| 28 ## The optional argument @var{dim} forces the cross product to be calculated | |
| 29 ## along the specified dimension. | |
| 30 ## | |
| 31 ## Example Code: | |
| 24 ## | 32 ## |
| 25 ## @example | 33 ## @example |
| 26 ## @group | 34 ## @group |
| 27 ## cross ([1,1,0], [0,1,1]) | 35 ## cross ([1,1,0], [0,1,1]) |
| 28 ## @result{} [ 1; -1; 1 ] | 36 ## @result{} [ 1; -1; 1 ] |
| 29 ## @end group | 37 ## @end group |
| 30 ## @end example | 38 ## @end example |
| 31 ## | 39 ## |
| 32 ## If @var{x} and @var{y} are matrices, the cross product is applied | |
| 33 ## along the first dimension with 3 elements. The optional argument | |
| 34 ## @var{dim} forces the cross product to be calculated along | |
| 35 ## the specified dimension. | |
| 36 ## @seealso{dot, curl, divergence} | 40 ## @seealso{dot, curl, divergence} |
| 37 ## @end deftypefn | 41 ## @end deftypefn |
| 38 | 42 |
| 39 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at> | 43 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at> |
| 40 ## Created: 15 October 1994 | 44 ## Created: 15 October 1994 |