Mercurial > octave-nkf

comparison src/data.cc @ 5061:4689ee5e88ec

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2004-11-03 21:23:42 by jwe]
author jwe
date Wed, 03 Nov 2004 21:23:43 +0000
parents 11bea7392e69
children 9eab94f5fadf
comparison
equal deleted inserted replaced
5060:34a904ac130d 5061:4689ee5e88ec
404 "-*- texinfo -*-\n\ 404 "-*- texinfo -*-\n\
405 @deftypefn {Built-in Function} {} cumprod (@var{x}, @var{dim})\n\ 405 @deftypefn {Built-in Function} {} cumprod (@var{x}, @var{dim})\n\
406 Cumulative product of elements along dimension @var{dim}. If\n\ 406 Cumulative product of elements along dimension @var{dim}. If\n\
407 @var{dim} is omitted, it defaults to 1 (column-wise cumulative\n\ 407 @var{dim} is omitted, it defaults to 1 (column-wise cumulative\n\
408 products).\n\ 408 products).\n\
409 \n\
410 As a special case, if @var{x} is a vector and @var{dim} is omitted,\n\
411 return the cumulative product of the elements as a vector with the\n\
412 same orientation as @var{x}.\n\
409 @end deftypefn") 413 @end deftypefn")
410 { 414 {
411 DATA_REDUCTION (cumprod); 415 DATA_REDUCTION (cumprod);
412 } 416 }
413 417
414 DEFUN (cumsum, args, , 418 DEFUN (cumsum, args, ,
415 "-*- texinfo -*-\n\ 419 "-*- texinfo -*-\n\
416 @deftypefn {Built-in Function} {} cumsum (@var{x}, @var{dim})\n\ 420 @deftypefn {Built-in Function} {} cumsum (@var{x}, @var{dim})\n\
417 Cumulative sum of elements along dimension @var{dim}. If @var{dim}\n\ 421 Cumulative sum of elements along dimension @var{dim}. If @var{dim}\n\
418 is omitted, it defaults to 1 (column-wise cumulative sums).\n\ 422 is omitted, it defaults to 1 (column-wise cumulative sums).\n\
423 \n\
424 As a special case, if @var{x} is a vector and @var{dim} is omitted,\n\
425 return the cumulative sum of the elements as a vector with the\n\
426 same orientation as @var{x}.\n\
419 @end deftypefn") 427 @end deftypefn")
420 { 428 {
421 DATA_REDUCTION (cumsum); 429 DATA_REDUCTION (cumsum);
422 } 430 }
423 431
661 DEFUN (prod, args, , 669 DEFUN (prod, args, ,
662 "-*- texinfo -*-\n\ 670 "-*- texinfo -*-\n\
663 @deftypefn {Built-in Function} {} prod (@var{x}, @var{dim})\n\ 671 @deftypefn {Built-in Function} {} prod (@var{x}, @var{dim})\n\
664 Product of elements along dimension @var{dim}. If @var{dim} is\n\ 672 Product of elements along dimension @var{dim}. If @var{dim} is\n\
665 omitted, it defaults to 1 (column-wise products).\n\ 673 omitted, it defaults to 1 (column-wise products).\n\
674 \n\
675 As a special case, if @var{x} is a vector and @var{dim} is omitted,\n\
676 return the product of the elements.\n\
666 @end deftypefn") 677 @end deftypefn")
667 { 678 {
668 DATA_REDUCTION (prod); 679 DATA_REDUCTION (prod);
669 } 680 }
670 681
1056 DEFUN (sum, args, , 1067 DEFUN (sum, args, ,
1057 "-*- texinfo -*-\n\ 1068 "-*- texinfo -*-\n\
1058 @deftypefn {Built-in Function} {} sum (@var{x}, @var{dim})\n\ 1069 @deftypefn {Built-in Function} {} sum (@var{x}, @var{dim})\n\
1059 Sum of elements along dimension @var{dim}. If @var{dim} is\n\ 1070 Sum of elements along dimension @var{dim}. If @var{dim} is\n\
1060 omitted, it defaults to 1 (column-wise sum).\n\ 1071 omitted, it defaults to 1 (column-wise sum).\n\
1072 \n\
1073 As a special case, if @var{x} is a vector and @var{dim} is omitted,\n\
1074 return the sum of the elements.\n\
1061 @end deftypefn") 1075 @end deftypefn")
1062 { 1076 {
1063 DATA_REDUCTION (sum); 1077 DATA_REDUCTION (sum);
1064 } 1078 }
1065 1079
1067 "-*- texinfo -*-\n\ 1081 "-*- texinfo -*-\n\
1068 @deftypefn {Built-in Function} {} sumsq (@var{x}, @var{dim})\n\ 1082 @deftypefn {Built-in Function} {} sumsq (@var{x}, @var{dim})\n\
1069 Sum of squares of elements along dimension @var{dim}. If @var{dim}\n\ 1083 Sum of squares of elements along dimension @var{dim}. If @var{dim}\n\
1070 is omitted, it defaults to 1 (column-wise sum of squares).\n\ 1084 is omitted, it defaults to 1 (column-wise sum of squares).\n\
1071 \n\ 1085 \n\
1072 This function is equivalent to computing\n\ 1086 As a special case, if @var{x} is a vector and @var{dim} is omitted,\n\
1087 return the sum of squares of the elements.\n\
1088 \n\
1089 This function is conceptually equivalent to computing\n\
1073 @example\n\ 1090 @example\n\
1074 sum (x .* conj (x), dim)\n\ 1091 sum (x .* conj (x), dim)\n\
1075 @end example\n\ 1092 @end example\n\
1076 but it uses less memory and avoids calling conj if @var{x} is real.\n\ 1093 but it uses less memory and avoids calling conj if @var{x} is real.\n\
1077 @end deftypefn") 1094 @end deftypefn")