Mercurial > octave

changeset 27235:e12571df6466

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update description of "legacy" option for set functions. * intersect.m, union.m, unique.m: Update description of "legacy" option.
author Rik <rik@octave.org>
date Thu, 11 Jul 2019 13:31:23 -0700
parents 279074d7a3b9
children d29a12e8b6d9
files scripts/set/intersect.m scripts/set/union.m scripts/set/unique.m
diffstat 3 files changed, 11 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/set/intersect.m	Thu Jul 11 14:21:37 2019 -0400
+++ b/scripts/set/intersect.m	Thu Jul 11 13:31:23 2019 -0700
@@ -36,9 +36,8 @@
 ## If requested, return column index vectors @var{ia} and @var{ib} such that
 ## @code{@var{c} = @var{a}(@var{ia})} and @code{@var{c} = @var{b}(@var{ib})}.
 ##
-## Programming Note: The input flag @qcode{"legacy"} changes the shape of the
-## outputs (@var{c}, @var{i}, @var{j} to row vectors whenever at least one of
-## the inputs is a row vector.
+## Programming Note: The input flag @qcode{"legacy"} changes the algorithm
+## to be compatible with @sc{matlab} releases prior to R2012b.
 ##
 ## @seealso{unique, union, setdiff, setxor, ismember}
 ## @end deftypefn
--- a/scripts/set/union.m	Thu Jul 11 14:21:37 2019 -0400
+++ b/scripts/set/union.m	Thu Jul 11 13:31:23 2019 -0700
@@ -20,6 +20,7 @@
 ## -*- texinfo -*-
 ## @deftypefn  {} {@var{c} =} union (@var{a}, @var{b})
 ## @deftypefnx {} {@var{c} =} union (@var{a}, @var{b}, "rows")
+## @deftypefnx {} {@var{c} =} union (@dots{}, "legacy")
 ## @deftypefnx {} {[@var{c}, @var{ia}, @var{ib}] =} union (@dots{})
 ##
 ## Return the unique elements that are in either @var{a} or @var{b} sorted in
@@ -37,6 +38,9 @@
 ## that @code{@var{a}(@var{ia})} and @code{@var{b}(@var{ib})} are disjoint sets
 ## whose union is @var{c}.
 ##
+## Programming Note: The input flag @qcode{"legacy"} changes the algorithm
+## to be compatible with @sc{matlab} releases prior to R2012b.
+##
 ## @seealso{unique, intersect, setdiff, setxor, ismember}
 ## @end deftypefn
 
--- a/scripts/set/unique.m	Thu Jul 11 14:21:37 2019 -0400
+++ b/scripts/set/unique.m	Thu Jul 11 13:31:23 2019 -0700
@@ -43,9 +43,11 @@
 ## @qcode{"first"} is specified, return the lowest.  The default is
 ## @qcode{"first"}.
 ##
-## Programming Note: The input flag @qcode{"legacy"} changes the default
-## to @qcode{"last"}, and the shape of the outputs @var{i}, @var{j} will follow
-## the shape of the input @var{x} rather than always being column vectors.
+## Programming Note: The input flag @qcode{"legacy"} changes the algorithm
+## to be compatible with @sc{matlab} releases prior to R2012b.  Specifically,
+## The index ordering flag is changed to @qcode{"last"}, and the shape of the
+## outputs @var{i}, @var{j} will follow the shape of the input @var{x} rather
+## than always being column vectors.
 ##
 ## @seealso{union, intersect, setdiff, setxor, ismember}
 ## @end deftypefn