Mercurial > octave
diff libinterp/corefcn/max.cc @ 27955:179ece36a2eb
doc: Clarify two-input argument form for max() and min() (bug #57573).
* max.cc (Fmax, Fmin): Add explanation that two-input form uses broadcasting
and place an @ref link to the Broadcasting node in the documentation.
| author | Rik <rik@octave.org> |
|---|---|
| date | Fri, 17 Jan 2020 08:51:24 -0800 |
| parents | bd51beb6205e |
| children | a3db48e66ef8 0a5b15007766 |
line wrap: on
line diff
--- a/libinterp/corefcn/max.cc Fri Jan 17 08:23:45 2020 -0800 +++ b/libinterp/corefcn/max.cc Fri Jan 17 08:51:24 2020 -0800 @@ -452,7 +452,8 @@ this dimension. In this case the second argument is ignored and should be set to the empty matrix. -For two matrices (or a matrix and a scalar), return the pairwise minimum. +For two inputs (@var{x} and @var{y}), return the pairwise minimum according to +the rules for @ref{Broadcasting}. Thus, @@ -673,7 +674,8 @@ this dimension. In this case the second argument is ignored and should be set to the empty matrix. -For two matrices (or a matrix and a scalar), return the pairwise maximum. +For two inputs (@var{x} and @var{y}), return the pairwise maximum according to +the rules for @ref{Broadcasting}. Thus,