Skip to content

Commit

Permalink
maint: Merge stable to default.
Browse files Browse the repository at this point in the history
  • Loading branch information
mmuetzel committed Nov 21, 2024
2 parents b211c94 + 441c2eb commit 1caf9e6
Show file tree
Hide file tree
Showing 21 changed files with 69 additions and 69 deletions.
56 changes: 28 additions & 28 deletions libinterp/corefcn/data.cc
Original file line number Diff line number Diff line change
Expand Up @@ -778,7 +778,7 @@ x - y .* floor (x ./ y)
@noindent
and is written such that the correct modulus is returned for integer types.
This function handles negative values correctly. That is,
@w{@code{mod (-1, 3)}} is 2, not -1, as @w{@code{rem (-1, 3)}} returns.
@w{@code{mod (-1, 3)}}@ is 2, not -1, as @w{@code{rem (-1, 3)}}@ returns.
An error results if the dimensions of the arguments do not agree, or if
either of the arguments is complex.
Expand Down Expand Up @@ -2567,7 +2567,7 @@ DEFUN (permute, args, ,
Return the generalized transpose for an N-D array object @var{A}.
The permutation vector @var{perm} must contain the elements
@w{@code{1:ndims (A)}} (in any order, but each element must appear only
@w{@code{1:ndims (A)}}@ (in any order, but each element must appear only
once). The @var{N}th dimension of @var{A} gets remapped to dimension
@code{@var{PERM}(@var{N})}. For example:
Expand Down Expand Up @@ -3417,7 +3417,7 @@ DEFUN (isinteger, args, ,
@deftypefn {} {@var{tf} =} isinteger (@var{x})
Return true if @var{x} is an integer object (int8, uint8, int16, etc.).
Note that @w{@code{isinteger (14)}} is false because numeric constants in
Note that @w{@code{isinteger (14)}}@ is false because numeric constants in
Octave are double precision floating point values.
@seealso{isfloat, ischar, islogical, isstring, isnumeric, isa}
@end deftypefn */)
Expand Down Expand Up @@ -3983,7 +3983,7 @@ DEFUN (isrow, args, ,
Return true if @var{x} is a row vector.
A row vector is a 2-D array of any type for which @code{size (@var{x})} returns
@w{@code{[1, N]}} with non-negative N.
@w{@code{[1, N]}}@ with non-negative N.
@seealso{iscolumn, isscalar, isvector, ismatrix, size}
@end deftypefn */)
{
Expand Down Expand Up @@ -4032,7 +4032,7 @@ DEFUN (iscolumn, args, ,
Return true if @var{x} is a column vector.
A column vector is a 2-D array of any type for which @code{size (@var{x})}
returns @w{@code{[N, 1]}} with non-negative N.
returns @w{@code{[N, 1]}}@ with non-negative N.
@seealso{isrow, isscalar, isvector, ismatrix, size}
@end deftypefn */)
{
Expand Down Expand Up @@ -4081,7 +4081,7 @@ DEFUN (ismatrix, args, ,
Return true if @var{x} is a 2-D array.
A matrix is an array of any type where @code{ndims (@var{x}) == 2} and for
which @code{size (@var{x})} returns @w{@code{[M, N]}} with non-negative M and
which @code{size (@var{x})} returns @w{@code{[M, N]}}@ with non-negative M and
N.
@seealso{isscalar, isvector, iscell, isstruct, issparse, isa}
@end deftypefn */)
Expand Down Expand Up @@ -4130,7 +4130,7 @@ DEFUN (issquare, args, ,
Return true if @var{x} is a 2-D square array.
A square array is a 2-D array of any type for which @code{size (@var{x})}
returns @w{@code{[N, N]}} where N is a non-negative integer.
returns @w{@code{[N, N]}}@ where N is a non-negative integer.
@seealso{isscalar, isvector, ismatrix, size}
@end deftypefn */)
{
Expand Down Expand Up @@ -6186,7 +6186,7 @@ DEFUN (norm, args, ,
@deftypefnx {} {@var{n} =} norm (@var{A}, @var{p}, @var{opt})
Compute the p-norm of the matrix @var{A}.
If the second argument is not given, @w{@code{p = 2}} is used.
If the second argument is not given, @w{@code{p = 2}}@ is used.
If @var{A} is a matrix (or sparse matrix):
Expand Down Expand Up @@ -6444,7 +6444,7 @@ This function is equivalent to the operator syntax @w{@code{! @var{x}}}.
DEFUN (uplus, args, ,
doc: /* -*- texinfo -*-
@deftypefn {} {@var{B} =} uplus (@var{A})
This function and @w{@tcode{+ @var{A}}} are equivalent.
This function and @w{@tcode{+ @var{A}}}@ are equivalent.
@seealso{uminus, plus}
@end deftypefn */)
{
Expand All @@ -6454,7 +6454,7 @@ This function and @w{@tcode{+ @var{A}}} are equivalent.
DEFUN (uminus, args, ,
doc: /* -*- texinfo -*-
@deftypefn {} {@var{B} =} uminus (@var{A})
This function and @w{@tcode{- @var{A}}} are equivalent.
This function and @w{@tcode{- @var{A}}}@ are equivalent.
@seealso{uplus, minus}
@end deftypefn */)
{
Expand All @@ -6466,7 +6466,7 @@ DEFUN (transpose, args, ,
@deftypefn {} {@var{B} =} transpose (@var{A})
Return the transpose of @var{A}.
This function and @tcode{@var{A}.'@:} are equivalent.
This function and @tcode{@var{A}.'@:}@ are equivalent.
@seealso{ctranspose}
@end deftypefn */)
{
Expand Down Expand Up @@ -6498,7 +6498,7 @@ DEFUN (ctranspose, args, ,
@deftypefn {} {@var{B} =} ctranspose (@var{A})
Return the complex conjugate transpose of @var{A}.
This function and @tcode{@var{A}'} are equivalent.
This function and @tcode{@var{A}'}@ are equivalent.
@seealso{transpose}
@end deftypefn */)
{
Expand Down Expand Up @@ -6564,7 +6564,7 @@ DEFUN (plus, args, ,
doc: /* -*- texinfo -*-
@deftypefn {} {@var{C} =} plus (@var{A}, @var{B})
@deftypefnx {} {@var{C} =} plus (@var{A1}, @var{A2}, @dots{})
This function and @w{@tcode{@var{A} + @var{B}}} are equivalent.
This function and @w{@tcode{@var{A} + @var{B}}}@ are equivalent.
If more arguments are given, the summation is applied
cumulatively from left to right:
Expand Down Expand Up @@ -6594,7 +6594,7 @@ cumulatively from left to right:
DEFUN (minus, args, ,
doc: /* -*- texinfo -*-
@deftypefn {} {@var{C} =} minus (@var{A}, @var{B})
This function and @w{@tcode{@var{A} - @var{B}}} are equivalent.
This function and @w{@tcode{@var{A} - @var{B}}}@ are equivalent.
@seealso{plus, uminus}
@end deftypefn */)
{
Expand All @@ -6607,7 +6607,7 @@ DEFUN (mtimes, args, ,
@deftypefnx {} {@var{C} =} mtimes (@var{A1}, @var{A2}, @dots{})
Return the matrix multiplication product of inputs.
This function and @w{@tcode{@var{A} * @var{B}}} are equivalent.
This function and @w{@tcode{@var{A} * @var{B}}}@ are equivalent.
If more arguments are given, the multiplication is applied
cumulatively from left to right:
Expand All @@ -6627,7 +6627,7 @@ DEFUN (mrdivide, args, ,
@deftypefn {} {@var{C} =} mrdivide (@var{A}, @var{B})
Return the matrix right division of @var{A} and @var{B}.
This function and @w{@tcode{@var{A} / @var{B}}} are equivalent.
This function and @w{@tcode{@var{A} / @var{B}}}@ are equivalent.
If the system is not square, or if the coefficient matrix is singular, a
minimum norm solution is computed.
Expand All @@ -6642,7 +6642,7 @@ DEFUN (mpower, args, ,
@deftypefn {} {@var{C} =} mpower (@var{A}, @var{B})
Return the matrix power operation of @var{A} raised to the @var{B} power.
This function and @w{@tcode{@var{A} ^ @var{B}}} are equivalent.
This function and @w{@tcode{@var{A} ^ @var{B}}}@ are equivalent.
@seealso{power, mtimes, plus, minus}
@end deftypefn */)
{
Expand All @@ -6654,7 +6654,7 @@ DEFUN (mldivide, args, ,
@deftypefn {} {@var{C} =} mldivide (@var{A}, @var{B})
Return the matrix left division of @var{A} and @var{B}.
This function and @w{@tcode{@var{A} @backslashchar{} @var{B}}} are equivalent.
This function and @w{@tcode{@var{A} @backslashchar{} @var{B}}}@ are equivalent.
If the system is not square, or if the coefficient matrix is singular, a
minimum norm solution is computed.
Expand Down Expand Up @@ -6734,7 +6734,7 @@ DEFUN (times, args, ,
@deftypefnx {} {@var{C} =} times (@var{A1}, @var{A2}, @dots{})
Return the element-by-element multiplication product of inputs.
This function and @w{@tcode{@var{A} .* @var{B}}} are equivalent.
This function and @w{@tcode{@var{A} .* @var{B}}}@ are equivalent.
If more arguments are given, the multiplication is applied
cumulatively from left to right:
Expand All @@ -6754,7 +6754,7 @@ DEFUN (rdivide, args, ,
@deftypefn {} {@var{C} =} rdivide (@var{A}, @var{B})
Return the element-by-element right division of @var{A} and @var{B}.
This function and @w{@tcode{@var{A} ./ @var{B}}} are equivalent.
This function and @w{@tcode{@var{A} ./ @var{B}}}@ are equivalent.
@seealso{ldivide, mrdivide, times, plus}
@end deftypefn */)
{
Expand All @@ -6767,7 +6767,7 @@ DEFUN (power, args, ,
Return the element-by-element operation of @var{A} raised to the
@var{B} power.
This function and @w{@tcode{@var{A} .^ @var{B}}} are equivalent.
This function and @w{@tcode{@var{A} .^ @var{B}}}@ are equivalent.
If several complex results are possible, returns the one with smallest
non-negative argument (angle). Use @code{realpow}, @code{realsqrt},
Expand All @@ -6784,7 +6784,7 @@ DEFUN (ldivide, args, ,
@deftypefn {} {@var{C} =} ldivide (@var{A}, @var{B})
Return the element-by-element left division of @var{A} and @var{B}.
This function and @w{@tcode{@var{A} .@backslashchar{} @var{B}}} are
This function and @w{@tcode{@var{A} .@backslashchar{} @var{B}}}@ are
equivalent.
@seealso{rdivide, mldivide, times, plus}
@end deftypefn */)
Expand Down Expand Up @@ -6842,7 +6842,7 @@ Return the result of the colon expression corresponding to @var{base},
@var{limit}, and optionally, @var{increment}.
This function is equivalent to the operator syntax
@w{@code{@var{base} : @var{limit}}} or
@w{@code{@var{base} : @var{limit}}}@ or
@w{@code{@var{base} : @var{increment} : @var{limit}}}.
@seealso{linspace}
@end deftypefn */)
Expand Down Expand Up @@ -7071,7 +7071,7 @@ For equal elements, the indices are such that equal elements are listed
in the order in which they appeared in the original list.
Sorting of complex entries is done first by magnitude
(@w{@code{abs (@var{z})}}) and for any ties by phase angle
(@w{@code{abs (@var{z})}})@ and for any ties by phase angle
(@w{@code{angle (z)}}). For example:
@example
Expand Down Expand Up @@ -7639,7 +7639,7 @@ not given.
Programming Note: nth_element encapsulates the C++ standard library
algorithms nth_element and partial_sort. On average, the complexity of the
operation is O(M*log(K)), where @w{@code{M = size (@var{x}, @var{dim})}} and
operation is O(M*log(K)), where @w{@code{M = size (@var{x}, @var{dim})}}@ and
@w{@code{K = length (@var{n})}}. This function is intended for cases where
the ratio K/M is small; otherwise, it may be better to use @code{sort}.
@seealso{sort, min, max}
Expand Down Expand Up @@ -8335,7 +8335,7 @@ DEFUN (diff, args, ,
@deftypefn {} {@var{y} =} diff (@var{x})
@deftypefnx {} {@var{y} =} diff (@var{x}, @var{k})
@deftypefnx {} {@var{y} =} diff (@var{x}, @var{k}, @var{dim})
If @var{x} is a vector of length @math{n}, @w{@code{diff (@var{x})}} is the
If @var{x} is a vector of length @math{n}, @w{@code{diff (@var{x})}}@ is the
vector of first differences
@tex
$x_2 - x_1, \ldots{}, x_n - x_{n-1}$.
Expand All @@ -8344,7 +8344,7 @@ vector of first differences
@var{x}(2) - @var{x}(1), @dots{}, @var{x}(n) - @var{x}(n-1).
@end ifnottex
If @var{x} is a matrix, @w{@code{diff (@var{x})}} is the matrix of column
If @var{x} is a matrix, @w{@code{diff (@var{x})}}@ is the matrix of column
differences along the first non-singleton dimension.
The second argument is optional. If supplied,
Expand All @@ -8357,7 +8357,7 @@ non-singleton dimension.
The dimension along which to take the difference can be explicitly
stated with the optional variable @var{dim}. In this case the
@var{k}-th order differences are calculated along this dimension.
In the case where @var{k} exceeds @w{@code{size (@var{x}, @var{dim})}}
In the case where @var{k} exceeds @w{@code{size (@var{x}, @var{dim})}}@
an empty matrix is returned.
@seealso{sort, merge}
@end deftypefn */)
Expand Down
2 changes: 1 addition & 1 deletion scripts/general/cumtrapz.m
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
## Cumulative numerical integration of points @var{y} using the trapezoidal
## method.
##
## @w{@code{cumtrapz (@var{y})}} computes the cumulative integral of @var{y}
## @w{@code{cumtrapz (@var{y})}}@ computes the cumulative integral of @var{y}
## along the first non-singleton dimension. Where @code{trapz} reports only
## the overall integral sum, @code{cumtrapz} reports the current partial sum
## value at each point of @var{y}.
Expand Down
2 changes: 1 addition & 1 deletion scripts/general/interp2.m
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
## @var{x}, @var{y} can be matrices, as returned by @code{meshgrid}, in which
## case the sizes of @var{x}, @var{y}, and @var{z} must be equal. If @var{x},
## @var{y} are vectors describing a grid then
## @w{@code{length (@var{x}) == columns (@var{z})}} and
## @w{@code{length (@var{x}) == columns (@var{z})}}@ and
## @w{@code{length (@var{y}) == rows (@var{z})}}. In either case the input
## data must be strictly monotonic.
##
Expand Down
2 changes: 1 addition & 1 deletion scripts/general/rescale.m
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
## the specified value @var{inmin} with @var{inmin}. Similarly, the optional
## input @qcode{"inputmax"} replaces all elements greater than the specified
## value @var{inmax} with @var{inmax}. If unspecified the minimum and maximum
## are taken from the data itself (@w{@code{@var{inmin} = min (A(:))}} and
## are taken from the data itself (@w{@code{@var{inmin} = min (A(:))}}@ and
## @w{@code{@var{inmax} = max (A(:))}}).
##
## Programming Notes:
Expand Down
2 changes: 1 addition & 1 deletion scripts/general/trapz.m
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
## Numerically evaluate the integral of points @var{y} using the trapezoidal
## method.
##
## @w{@code{trapz (@var{y})}} computes the integral of @var{y} along the first
## @w{@code{trapz (@var{y})}}@ computes the integral of @var{y} along the first
## non-singleton dimension. When the argument @var{x} is omitted an equally
## spaced @var{x} vector with unit spacing (1) is assumed.
## @code{trapz (@var{x}, @var{y})} evaluates the integral with respect to the
Expand Down
2 changes: 1 addition & 1 deletion scripts/help/bessel.m
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
## @item besselh
## Compute Hankel functions of the first (@var{k} = 1) or second (@var{k} = 2)
## kind. If the argument @var{opt} is supplied, the result is multiplied by
## @w{@code{exp (-I*@var{x})}} for @var{k} = 1 or @w{@code{exp (I*@var{x})}}
## @w{@code{exp (-I*@var{x})}}@ for @var{k} = 1 or @w{@code{exp (I*@var{x})}}@
## for @var{k} = 2.
## @end table
##
Expand Down
2 changes: 1 addition & 1 deletion scripts/image/image.m
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
##
## @var{x} and @var{y} are optional 2-element vectors, @w{@code{[min, max]}},
## which specify the coordinates of the centers of the corner pixels.
## If a range is specified as @w{@code{[max, min]}} then the image will be
## If a range is specified as @w{@code{[max, min]}}@ then the image will be
## reversed along that axis. For convenience, @var{x} and @var{y} may be
## specified as N-element vectors matching the length of the data in @var{img}.
## However, only the first and last elements will be used to determine the axis
Expand Down
2 changes: 1 addition & 1 deletion scripts/image/imagesc.m
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
##
## @var{x} and @var{y} are optional 2-element vectors, @w{@code{[min, max]}},
## which specify the coordinates of the centers of the corner pixels.
## If a range is specified as @w{@code{[max, min]}} then the image will be
## If a range is specified as @w{@code{[max, min]}}@ then the image will be
## reversed along that axis. For convenience, @var{x} and @var{y} may be
## specified as N-element vectors matching the length of the data in @var{img}.
## However, only the first and last elements will be used to determine
Expand Down
2 changes: 1 addition & 1 deletion scripts/ode/ode15i.m
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
## field @var{x} containing a row vector of times where the solution was
## evaluated and a field @var{y} containing the solution matrix such that each
## column corresponds to a time in @var{x}. Use
## @w{@code{fieldnames (@var{solution})}} to see the other fields and
## @w{@code{fieldnames (@var{solution})}}@ to see the other fields and
## additional information returned.
##
## If no output arguments are requested, and no @qcode{"OutputFcn"} is
Expand Down
2 changes: 1 addition & 1 deletion scripts/ode/ode15s.m
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
## field @var{x} containing a row vector of times where the solution was
## evaluated and a field @var{y} containing the solution matrix such that each
## column corresponds to a time in @var{x}. Use
## @w{@code{fieldnames (@var{solution})}} to see the other fields and
## @w{@code{fieldnames (@var{solution})}}@ to see the other fields and
## additional information returned.
##
## If no output arguments are requested, and no @qcode{"OutputFcn"} is
Expand Down
2 changes: 1 addition & 1 deletion scripts/ode/ode23.m
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
## field @var{x} containing a row vector of times where the solution was
## evaluated and a field @var{y} containing the solution matrix such that each
## column corresponds to a time in @var{x}. Use
## @w{@code{fieldnames (@var{solution})}} to see the other fields and
## @w{@code{fieldnames (@var{solution})}}@ to see the other fields and
## additional information returned.
##
## If no output arguments are requested, and no @qcode{"OutputFcn"} is
Expand Down
2 changes: 1 addition & 1 deletion scripts/ode/ode23s.m
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
## field @var{x} containing a row vector of times where the solution was
## evaluated and a field @var{y} containing the solution matrix such that each
## column corresponds to a time in @var{x}. Use
## @w{@code{fieldnames (@var{solution})}} to see the other fields and
## @w{@code{fieldnames (@var{solution})}}@ to see the other fields and
## additional information returned.
##
## If using the @qcode{"Events"} option then three additional outputs may be
Expand Down
2 changes: 1 addition & 1 deletion scripts/ode/ode45.m
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
## field @var{x} containing a row vector of times where the solution was
## evaluated and a field @var{y} containing the solution matrix such that each
## column corresponds to a time in @var{x}. Use
## @w{@code{fieldnames (@var{solution})}} to see the other fields and
## @w{@code{fieldnames (@var{solution})}}@ to see the other fields and
## additional information returned.
##
## If no output arguments are requested, and no @qcode{"OutputFcn"} is
Expand Down
2 changes: 1 addition & 1 deletion scripts/plot/draw/fplot.m
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
## @var{fcn} is a function handle, inline function, or string containing the
## name of the function to evaluate.
##
## The limits of the plot are of the form @w{@code{[@var{xlo}, @var{xhi}]}} or
## The limits of the plot are of the form @w{@code{[@var{xlo}, @var{xhi}]}}@ or
## @w{@code{[@var{xlo}, @var{xhi}, @var{ylo}, @var{yhi}]}}. If no limits
## are specified the default is @code{[-5, 5]}.
##
Expand Down
4 changes: 2 additions & 2 deletions scripts/signal/movfun.m
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@
## data array are deleted. For example, with a 10-element data vector and a
## window of length 3, the output will contain only 8 elements. The first
## element would require calculating the function over indices
## @w{@code{[0, 1, 2]}} and is therefore discarded. The last element would
## require calculating the function over indices @w{@code{[9, 10, 11]}} and is
## @w{@code{[0, 1, 2]}}@ and is therefore discarded. The last element would
## require calculating the function over indices @w{@code{[9, 10, 11]}}@ and is
## therefore discarded.
##
## @item @qcode{"fill"}
Expand Down
Loading

0 comments on commit 1caf9e6

Please sign in to comment.