Mercurial > hg > octave-nkf
changeset 17268:1c21f264d26f
doc: Rename @xcode macro to @tcode (transpose code) for clarity.
* doc/interpreter/macros.texi: Rename macro @xcode to @tcode.
* libinterp/corefcn/data.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/schur.cc, libinterp/dldfcn/symbfact.cc,
scripts/linear-algebra/krylov.m, scripts/sparse/etreeplot.m:
Rename @xcode macro instances to @tcode.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 17 Aug 2013 11:45:20 -0700 |
parents | 27800ef1f7d2 |
children | 5b088598df1d |
files | doc/interpreter/macros.texi libinterp/corefcn/data.cc libinterp/corefcn/lu.cc libinterp/corefcn/schur.cc libinterp/dldfcn/symbfact.cc scripts/linear-algebra/krylov.m scripts/sparse/etreeplot.m |
diffstat | 7 files changed, 25 insertions(+), 25 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/macros.texi +++ b/doc/interpreter/macros.texi @@ -16,8 +16,8 @@ @c along with Octave; see the file COPYING. If not, see @c <http://www.gnu.org/licenses/>. -@c FIXME -- someday, we might replace this with @backslashchar, which -@c has been added to Texinfo. +@c FIXME: someday, when Texinfo 5.X is standard, we might replace this with +@c @backslashchar, which is an new addition to Texinfo. @macro xbackslashchar \\ @@ -62,12 +62,12 @@ @c expansion of the @code{XXX} macro is `XXX'. The use of the apostrophe @c can be confusing if the code segment itself ends with a transpose operator. @ifinfo -@macro xcode{arg} +@macro tcode{arg} \arg\ @end macro @end ifinfo @ifnotinfo -@macro xcode{arg} +@macro tcode{arg} @code{\arg\} @end macro @end ifnotinfo
--- a/libinterp/corefcn/data.cc +++ b/libinterp/corefcn/data.cc @@ -5369,7 +5369,7 @@ DEFUN (uplus, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} uplus (@var{x})\n\ -This function and @w{@xcode{+ x}} are equivalent.\n\ +This function and @w{@tcode{+ x}} are equivalent.\n\ @seealso{uminus, plus, minus}\n\ @end deftypefn") { @@ -5379,7 +5379,7 @@ DEFUN (uminus, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} uminus (@var{x})\n\ -This function and @w{@xcode{- x}} are equivalent.\n\ +This function and @w{@tcode{- x}} are equivalent.\n\ @seealso{uplus, minus}\n\ @end deftypefn") { @@ -5390,7 +5390,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} transpose (@var{x})\n\ Return the transpose of @var{x}.\n\ -This function and @xcode{x.'} are equivalent.\n\ +This function and @tcode{x.'} are equivalent.\n\ @seealso{ctranspose}\n\ @end deftypefn") { @@ -5421,7 +5421,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} ctranspose (@var{x})\n\ Return the complex conjugate transpose of @var{x}.\n\ -This function and @xcode{x'} are equivalent.\n\ +This function and @tcode{x'} are equivalent.\n\ @seealso{transpose}\n\ @end deftypefn") { @@ -5495,7 +5495,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} plus (@var{x}, @var{y})\n\ @deftypefnx {Built-in Function} {} plus (@var{x1}, @var{x2}, @dots{})\n\ -This function and @w{@xcode{x + y}} are equivalent.\n\ +This function and @w{@tcode{x + y}} are equivalent.\n\ If more arguments are given, the summation is applied\n\ cumulatively from left to right:\n\ \n\ @@ -5514,7 +5514,7 @@ DEFUN (minus, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} minus (@var{x}, @var{y})\n\ -This function and @w{@xcode{x - y}} are equivalent.\n\ +This function and @w{@tcode{x - y}} are equivalent.\n\ @seealso{plus, uminus}\n\ @end deftypefn") { @@ -5526,7 +5526,7 @@ @deftypefn {Built-in Function} {} mtimes (@var{x}, @var{y})\n\ @deftypefnx {Built-in Function} {} mtimes (@var{x1}, @var{x2}, @dots{})\n\ Return the matrix multiplication product of inputs.\n\ -This function and @w{@xcode{x * y}} are equivalent.\n\ +This function and @w{@tcode{x * y}} are equivalent.\n\ If more arguments are given, the multiplication is applied\n\ cumulatively from left to right:\n\ \n\ @@ -5546,7 +5546,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} mrdivide (@var{x}, @var{y})\n\ Return the matrix right division of @var{x} and @var{y}.\n\ -This function and @w{@xcode{x / y}} are equivalent.\n\ +This function and @w{@tcode{x / y}} are equivalent.\n\ @seealso{mldivide, rdivide, plus, minus}\n\ @end deftypefn") { @@ -5557,7 +5557,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} mpower (@var{x}, @var{y})\n\ Return the matrix power operation of @var{x} raised to the @var{y} power.\n\ -This function and @w{@xcode{x ^ y}} are equivalent.\n\ +This function and @w{@tcode{x ^ y}} are equivalent.\n\ @seealso{power, mtimes, plus, minus}\n\ @end deftypefn") { @@ -5568,7 +5568,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} mldivide (@var{x}, @var{y})\n\ Return the matrix left division of @var{x} and @var{y}.\n\ -This function and @w{@xcode{x @xbackslashchar{} y}} are equivalent.\n\ +This function and @w{@tcode{x @xbackslashchar{} y}} are equivalent.\n\ @seealso{mrdivide, ldivide, rdivide}\n\ @end deftypefn") { @@ -5642,7 +5642,7 @@ @deftypefn {Built-in Function} {} times (@var{x}, @var{y})\n\ @deftypefnx {Built-in Function} {} times (@var{x1}, @var{x2}, @dots{})\n\ Return the element-by-element multiplication product of inputs.\n\ -This function and @w{@xcode{x .* y}} are equivalent.\n\ +This function and @w{@tcode{x .* y}} are equivalent.\n\ If more arguments are given, the multiplication is applied\n\ cumulatively from left to right:\n\ \n\ @@ -5662,7 +5662,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} rdivide (@var{x}, @var{y})\n\ Return the element-by-element right division of @var{x} and @var{y}.\n\ -This function and @w{@xcode{x ./ y}} are equivalent.\n\ +This function and @w{@tcode{x ./ y}} are equivalent.\n\ @seealso{ldivide, mrdivide, times, plus}\n\ @end deftypefn") { @@ -5678,7 +5678,7 @@ @code{realpow}, @code{realsqrt}, @code{cbrt}, or @code{nthroot} if a\n\ real result is preferred.\n\ \n\ -This function and @w{@xcode{x .^ y}} are equivalent.\n\ +This function and @w{@tcode{x .^ y}} are equivalent.\n\ @seealso{mpower, realpow, realsqrt, cbrt, nthroot}\n\ @end deftypefn") { @@ -5689,7 +5689,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} ldivide (@var{x}, @var{y})\n\ Return the element-by-element left division of @var{x} and @var{y}.\n\ -This function and @w{@xcode{x .@xbackslashchar{} y}} are equivalent.\n\ +This function and @w{@tcode{x .@xbackslashchar{} y}} are equivalent.\n\ @seealso{rdivide, mldivide, times, plus}\n\ @end deftypefn") {
--- a/libinterp/corefcn/lu.cc +++ b/libinterp/corefcn/lu.cc @@ -615,7 +615,7 @@ @end example\n\ \n\ @noindent\n\ -then a factorization of @xcode{@var{A}+@var{x}*@var{y}.'} can be obtained\n\ +then a factorization of @tcode{@var{A}+@var{x}*@var{y}.'} can be obtained\n\ either as\n\ \n\ @example\n\
--- a/libinterp/corefcn/schur.cc +++ b/libinterp/corefcn/schur.cc @@ -305,7 +305,7 @@ $U^{\\dagger} U$ is the identity matrix I.\n\ @end tex\n\ @ifnottex\n\ -@xcode{@var{UR} * @var{TR} * @var{UR}' = @var{U} * @var{T} * @var{U}'} and\n\ +@tcode{@var{UR} * @var{TR} * @var{UR}' = @var{U} * @var{T} * @var{U}'} and\n\ @code{@var{U}' * @var{U}} is the identity matrix I.\n\ @end ifnottex\n\ \n\
--- a/libinterp/dldfcn/symbfact.cc +++ b/libinterp/dldfcn/symbfact.cc @@ -63,10 +63,10 @@ Factorize @code{@var{S}' * @var{S}}.\n\ \n\ @item row\n\ -Factorize @xcode{@var{S} * @var{S}'}.\n\ +Factorize @tcode{@var{S} * @var{S}'}.\n\ \n\ @item lo\n\ -Factorize @xcode{@var{S}'}\n\ +Factorize @tcode{@var{S}'}\n\ @end table\n\ \n\ @item mode\n\
--- a/scripts/linear-algebra/krylov.m +++ b/scripts/linear-algebra/krylov.m @@ -28,8 +28,8 @@ ## Using Householder reflections to guard against loss of orthogonality. ## ## If @var{V} is a vector, then @var{h} contains the Hessenberg matrix -## such that @nospell{@xcode{a*u == u*h+rk*ek'}}, in which @code{rk = -## a*u(:,k)-u*h(:,k)}, and @nospell{@xcode{ek'}} is the vector +## such that @nospell{@tcode{a*u == u*h+rk*ek'}}, in which @code{rk = +## a*u(:,k)-u*h(:,k)}, and @nospell{@tcode{ek'}} is the vector ## @code{[0, 0, @dots{}, 1]} of length @code{k}. Otherwise, @var{h} is ## meaningless. ##
--- a/scripts/sparse/etreeplot.m +++ b/scripts/sparse/etreeplot.m @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {} etreeplot (@var{A}) ## @deftypefnx {Function File} {} etreeplot (@var{A}, @var{node_style}, @var{edge_style}) ## Plot the elimination tree of the matrix @var{A} or -## @xcode{@var{A}+@var{A}'} if @var{A} in not symmetric. The optional +## @tcode{@var{A}+@var{A}'} if @var{A} in not symmetric. The optional ## parameters @var{node_style} and @var{edge_style} define the output ## style. ## @seealso{treeplot, gplot}