Mercurial > octave-nkf

comparison scripts/set/union.m @ 14327:4d917a6a858b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use Octave coding conventions in @example blocks of docstrings. * accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m, celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m, contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m, dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m, ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m, flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m, idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m, isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m, logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m, moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m, polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m, randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m, shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m, strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m, subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m, voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in @example blocks of docstrings.
author Rik <octave@nomad.inbox5.com>
date Sat, 04 Feb 2012 22:12:50 -0800
parents 72c96de7a403
children f3d52523cde1
comparison
equal deleted inserted replaced
14325:a646cee995cf 14327:4d917a6a858b
25 ## For example: 25 ## For example:
26 ## 26 ##
27 ## @example 27 ## @example
28 ## @group 28 ## @group
29 ## union ([1, 2, 4], [2, 3, 5]) 29 ## union ([1, 2, 4], [2, 3, 5])
30 ## @result{} [1, 2, 3, 4, 5] 30 ## @result{} [1, 2, 3, 4, 5]
31 ## @end group 31 ## @end group
32 ## @end example 32 ## @end example
33 ## 33 ##
34 ## If the optional third input argument is the string "rows" each row of 34 ## If the optional third input argument is the string "rows" each row of
35 ## the matrices @var{a} and @var{b} will be considered an element of sets. 35 ## the matrices @var{a} and @var{b} will be considered an element of sets.
36 ## For example: 36 ## For example:
37 ## 37 ##
38 ## @example 38 ## @example
39 ## @group 39 ## @group
40 ## union([1, 2; 2, 3], [1, 2; 3, 4], "rows") 40 ## union ([1, 2; 2, 3], [1, 2; 3, 4], "rows")
41 ## @result{} 1 2 41 ## @result{} 1 2
42 ## 2 3 42 ## 2 3
43 ## 3 4 43 ## 3 4
44 ## @end group 44 ## @end group
45 ## @end example 45 ## @end example
46 ## 46 ##
47 ## @deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} union (@var{a}, @var{b}) 47 ## @deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} union (@var{a}, @var{b})
48 ## 48 ##
49 ## Return index vectors @var{ia} and @var{ib} such that @code{a(ia)} and 49 ## Return index vectors @var{ia} and @var{ib} such that @code{a(ia)} and
50 ## @code{b(ib)} are 50 ## @code{b(ib)} are disjoint sets whose union is @var{c}.
51 ## disjoint sets whose union is @var{c}.
52 ## 51 ##
53 ## @seealso{intersect, setdiff, unique} 52 ## @seealso{intersect, setdiff, unique}
54 ## @end deftypefn 53 ## @end deftypefn
55 54
56 ## Author: jwe 55 ## Author: jwe