annotate scripts/miscellaneous/orderfields.m @ 14363:f3d52523cde1

Use Octave coding conventions in all m-file %!test blocks * wavread.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m, asec.m, asecd.m, asech.m, asind.m, atand.m, cosd.m, cot.m, cotd.m, coth.m, csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m, accumarray.m, accumdim.m, bitcmp.m, bitget.m, bitset.m, blkdiag.m, cart2pol.m, cart2sph.m, celldisp.m, chop.m, circshift.m, colon.m, common_size.m, cplxpair.m, cumtrapz.m, curl.m, dblquad.m, deal.m, divergence.m, flipdim.m, fliplr.m, flipud.m, genvarname.m, gradient.m, idivide.m, int2str.m, interp1.m, interp1q.m, interp2.m, interp3.m, interpft.m, interpn.m, isa.m, isdir.m, isequal.m, isequalwithequalnans.m, issquare.m, logspace.m, nargchk.m, narginchk.m, nargoutchk.m, nextpow2.m, nthargout.m, num2str.m, pol2cart.m, polyarea.m, postpad.m, prepad.m, profile.m, profshow.m, quadgk.m, quadv.m, randi.m, rat.m, repmat.m, rot90.m, rotdim.m, shift.m, shiftdim.m, sph2cart.m, structfun.m, trapz.m, triplequad.m, convhull.m, dsearch.m, dsearchn.m, griddata3.m, griddatan.m, rectint.m, tsearchn.m, __makeinfo__.m, doc.m, get_first_help_sentence.m, help.m, type.m, unimplemented.m, which.m, imread.m, imwrite.m, dlmwrite.m, fileread.m, is_valid_file_id.m, strread.m, textread.m, textscan.m, commutation_matrix.m, cond.m, condest.m, cross.m, duplication_matrix.m, expm.m, housh.m, isdefinite.m, ishermitian.m, issymmetric.m, logm.m, normest.m, null.m, onenormest.m, orth.m, planerot.m, qzhess.m, rank.m, rref.m, trace.m, vech.m, ans.m, bincoeff.m, bug_report.m, bzip2.m, comma.m, compare_versions.m, computer.m, edit.m, fileparts.m, fullfile.m, getfield.m, gzip.m, info.m, inputname.m, isappdata.m, isdeployed.m, ismac.m, ispc.m, isunix.m, list_primes.m, ls.m, mexext.m, namelengthmax.m, news.m, orderfields.m, paren.m, recycle.m, rmappdata.m, semicolon.m, setappdata.m, setfield.m, substruct.m, symvar.m, ver.m, version.m, warning_ids.m, xor.m, fminbnd.m, fsolve.m, fzero.m, lsqnonneg.m, optimset.m, pqpnonneg.m, sqp.m, matlabroot.m, __gnuplot_drawnow__.m, __plt_get_axis_arg__.m, ancestor.m, cla.m, clf.m, close.m, colorbar.m, colstyle.m, comet3.m, contourc.m, figure.m, gca.m, gcbf.m, gcbo.m, gcf.m, ginput.m, graphics_toolkit.m, gtext.m, hggroup.m, hist.m, hold.m, isfigure.m, ishghandle.m, ishold.m, isocolors.m, isonormals.m, isosurface.m, isprop.m, legend.m, line.m, loglog.m, loglogerr.m, meshgrid.m, ndgrid.m, newplot.m, orient.m, patch.m, plot3.m, plotyy.m, __print_parse_opts__.m, quiver3.m, refreshdata.m, ribbon.m, semilogx.m, semilogxerr.m, semilogy.m, stem.m, stem3.m, subplot.m, title.m, uigetfile.m, view.m, whitebg.m, compan.m, conv.m, deconv.m, mkpp.m, mpoles.m, pchip.m, poly.m, polyaffine.m, polyder.m, polyfit.m, polygcd.m, polyint.m, polyout.m, polyval.m, polyvalm.m, ppder.m, ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, intersect.m, ismember.m, powerset.m, setdiff.m, setxor.m, union.m, unique.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m, fftconv.m, fftfilt.m, fftshift.m, freqz.m, hamming.m, hanning.m, ifftshift.m, sinc.m, sinetone.m, sinewave.m, unwrap.m, bicg.m, bicgstab.m, gmres.m, gplot.m, nonzeros.m, pcg.m, pcr.m, spaugment.m, spconvert.m, spdiags.m, speye.m, spfun.m, spones.m, sprand.m, sprandsym.m, spstats.m, spy.m, svds.m, treelayout.m, bessel.m, beta.m, betaln.m, factor.m, factorial.m, isprime.m, lcm.m, legendre.m, nchoosek.m, nthroot.m, perms.m, pow2.m, primes.m, reallog.m, realpow.m, realsqrt.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, rosser.m, vander.m, __finish__.m, center.m, cloglog.m, corr.m, cov.m, gls.m, histc.m, iqr.m, kendall.m, kurtosis.m, logit.m, mahalanobis.m, mean.m, meansq.m, median.m, mode.m, moment.m, ols.m, ppplot.m, prctile.m, probit.m, quantile.m, range.m, ranks.m, run_count.m, runlength.m, skewness.m, spearman.m, statistics.m, std.m, table.m, var.m, zscore.m, betacdf.m, betainv.m, betapdf.m, betarnd.m, binocdf.m, binoinv.m, binopdf.m, binornd.m, cauchy_cdf.m, cauchy_inv.m, cauchy_pdf.m, cauchy_rnd.m, chi2cdf.m, chi2inv.m, chi2pdf.m, chi2rnd.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m, empirical_inv.m, empirical_pdf.m, empirical_rnd.m, expcdf.m, expinv.m, exppdf.m, exprnd.m, fcdf.m, finv.m, fpdf.m, frnd.m, gamcdf.m, gaminv.m, gampdf.m, gamrnd.m, geocdf.m, geoinv.m, geopdf.m, geornd.m, hygecdf.m, hygeinv.m, hygepdf.m, hygernd.m, kolmogorov_smirnov_cdf.m, laplace_cdf.m, laplace_inv.m, laplace_pdf.m, laplace_rnd.m, logistic_cdf.m, logistic_inv.m, logistic_pdf.m, logistic_rnd.m, logncdf.m, logninv.m, lognpdf.m, lognrnd.m, nbincdf.m, nbininv.m, nbinpdf.m, nbinrnd.m, normcdf.m, norminv.m, normpdf.m, normrnd.m, poisscdf.m, poissinv.m, poisspdf.m, poissrnd.m, stdnormal_cdf.m, stdnormal_inv.m, stdnormal_pdf.m, stdnormal_rnd.m, tcdf.m, tinv.m, tpdf.m, trnd.m, unidcdf.m, unidinv.m, unidpdf.m, unidrnd.m, unifcdf.m, unifinv.m, unifpdf.m, unifrnd.m, wblcdf.m, wblinv.m, wblpdf.m, wblrnd.m, kolmogorov_smirnov_test.m, kruskal_wallis_test.m, base2dec.m, bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m, findstr.m, hex2dec.m, index.m, isletter.m, mat2str.m, rindex.m, str2num.m, strcat.m, strjust.m, strmatch.m, strsplit.m, strtok.m, strtrim.m, strtrunc.m, substr.m, validatestring.m, demo.m, example.m, fail.m, speed.m, addtodate.m, asctime.m, clock.m, ctime.m, date.m, datenum.m, datetick.m, datevec.m, eomday.m, etime.m, is_leap_year.m, now.m: Use Octave coding conventions in all m-file %!test blocks
author Rik <octave@nomad.inbox5.com>
date Mon, 13 Feb 2012 07:29:44 -0800
parents 4d917a6a858b
children 5d3a684236b0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13930
diff changeset
1 ## Copyright (C) 2006-2012 Paul Kienzle
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
2 ##
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
4 ##
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6862
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6862
diff changeset
8 ## your option) any later version.
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
9 ##
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
14 ##
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6862
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6862
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
18
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
11563
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
20 ## @deftypefn {Function File} {[@var{t}, @var{p}] =} orderfields (@var{s1})
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
21 ## @deftypefnx {Function File} {[@var{t}, @var{p}] =} orderfields (@var{s1}, @var{s2})
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
22 ## Return a copy of @var{s1} with fields arranged alphabetically or
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
23 ## as specified by @var{s2}.
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
24 ##
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
25 ## Given one struct, arrange field names in @var{s1} alphabetically.
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
26 ##
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
27 ## If the second argument is a struct, arrange field names in @var{s1}
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
28 ## as they appear in @var{s2}. The second argument may also specify the
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
29 ## order in a permutation vector or a cell array of strings containing
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
30 ## the fieldnames of @var{s1} in the desired order.
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
31 ##
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
32 ## The optional second output argument @var{p} is assigned the permutation
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
33 ## vector
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
34 ## which converts the original name order into the new name order.
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
35 ##
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
36 ## Examples:
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
37 ##
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
38 ## @example
13930
fe088cef3503 doc: Add missing @group/@end group to orderfields docstring
Rik <octave@nomad.inbox5.com>
parents: 13929
diff changeset
39 ## @group
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
40 ## s = struct("d", 4, "b", 2, "a", 1, "c", 3);
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
41 ## t1 = orderfields (s)
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11567
diff changeset
42 ## @result{} t1 =
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
43 ## @{
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
44 ## a = 1
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
45 ## b = 2
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
46 ## c = 3
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
47 ## d = 4
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
48 ## @}
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
49 ## @end group
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
50 ## @group
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
51 ## t = struct("d", @{@}, "c", @{@}, "b", "a", @{@});
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
52 ## t2 = orderfields (s, t)
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
53 ## @result{} t2 =
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
54 ## @{
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
55 ## d = 4
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
56 ## c = 3
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
57 ## b = 2
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
58 ## a = 1
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
59 ## @}
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
60 ## @end group
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
61 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
62 ## t3 = orderfields (s, [3, 2, 4, 1]);
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
63 ## @result{} t3 =
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
64 ## @{
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
65 ## a = 1
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
66 ## b = 2
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
67 ## c = 3
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
68 ## d = 4
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
69 ## @}
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
70 ## @end group
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
71 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
72 ## [t4, p] = orderfields (s, @{"d", "c", "b", "a"@})
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
73 ## @result{} t4 =
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
74 ## @{
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
75 ## d = 4
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
76 ## c = 3
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
77 ## b = 2
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
78 ## a = 1
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
79 ## @}
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
80 ## p =
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
81 ## 1
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
82 ## 4
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
83 ## 2
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
84 ## 3
13930
fe088cef3503 doc: Add missing @group/@end group to orderfields docstring
Rik <octave@nomad.inbox5.com>
parents: 13929
diff changeset
85 ## @end group
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
86 ## @end example
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
87 ##
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
88 ## @seealso{getfield, rmfield, isfield, isstruct, fieldnames, struct}
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
89 ## @end deftypefn
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
90
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
91 ## Author: Paul Kienzle <pkienzle@users.sf.net>
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
92 ## Adapted-By: jwe
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
93
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
94 function [t, p] = orderfields (s1, s2)
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
95
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
96 if (nargin == 1 || nargin == 2)
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
97 if (! isstruct (s1))
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
98 error ("orderfields: expecting argument to be a struct");
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
99 endif
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
100 else
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
101 print_usage ();
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
102 endif
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
103
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
104 if (nargin == 1)
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
105 ## One structure: return the fields in alphabetical order.
6862
d63339cbb205 [project @ 2007-09-05 06:49:29 by jwe]
jwe
parents: 6713
diff changeset
106 if (isstruct (s1))
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
107 names = sort (fieldnames (s1));
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
108 endif
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
109 elseif (nargin == 2)
6862
d63339cbb205 [project @ 2007-09-05 06:49:29 by jwe]
jwe
parents: 6713
diff changeset
110 if (isstruct (s2))
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
111 ## Two structures: return the fields in the order of s2.
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
112 names = fieldnames (s2);
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
113 if (! isequal (sort (fieldnames (s1)), sort (names)))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10122
diff changeset
114 error ("orderfields: structures do not have same fields");
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
115 endif
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
116 elseif (iscellstr (s2))
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
117 ## A structure and a list of fields: order by the list of fields.
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
118 t1 = sort (fieldnames (s1));
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
119 t2 = sort (s2(:));
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
120 if (! isequal (t1, t2))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10122
diff changeset
121 error ("orderfields: name list does not match structure fields");
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
122 endif
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
123 names = s2;
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
124 elseif (isvector (s2))
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
125 ## A structure and a permutation vector: permute the order of s1.
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
126 names = fieldnames (s1);
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
127 t1 = sort (s2);
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
128 t1 = t1(:)';
6862
d63339cbb205 [project @ 2007-09-05 06:49:29 by jwe]
jwe
parents: 6713
diff changeset
129 t2 = 1:numel (names);
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
130 if (! isequal (t1, t2))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10122
diff changeset
131 error ("orderfields: invalid permutation vector");
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
132 endif
6862
d63339cbb205 [project @ 2007-09-05 06:49:29 by jwe]
jwe
parents: 6713
diff changeset
133 names = names (s2);
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
134 endif
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
135 endif
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
136
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
137 ## Find permutation vector which converts the original name order
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
138 ## into the new name order. Note: could save a couple of sorts
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
139 ## in some cases, but performance isn't critical.
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
140
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
141 if (nargout == 2)
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
142 [oldel, oldidx] = sort (fieldnames (s1));
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
143 [newel, newidx] = sort (names);
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
144 p = oldidx(newidx);
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
145 endif
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
146
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
147 ## Permute the names in the structure.
6862
d63339cbb205 [project @ 2007-09-05 06:49:29 by jwe]
jwe
parents: 6713
diff changeset
148 if (numel (s1) == 0)
8605
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
149 args = cell (1, 2 * numel (names));
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
150 args(1:2:end) = names;
8455
fd11a08a9b31 disallow invalid {}-indexed assigments
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
151 args(2:2:end) = {[]};
8605
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
152 t = struct (args{:});
6862
d63339cbb205 [project @ 2007-09-05 06:49:29 by jwe]
jwe
parents: 6713
diff changeset
153 else
8612
20d23d65cc84 fix & optimize orderfields
Jaroslav Hajek <highegg@gmail.com>
parents: 8605
diff changeset
154 n = numel (s1);
8605
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
155 for i = 1:numel (names)
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
156 el = names(i);
8612
20d23d65cc84 fix & optimize orderfields
Jaroslav Hajek <highegg@gmail.com>
parents: 8605
diff changeset
157 [t(1:n).(el)] = s1(:).(el);
8605
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
158 endfor
8612
20d23d65cc84 fix & optimize orderfields
Jaroslav Hajek <highegg@gmail.com>
parents: 8605
diff changeset
159 ## inherit dimensions
20d23d65cc84 fix & optimize orderfields
Jaroslav Hajek <highegg@gmail.com>
parents: 8605
diff changeset
160 t = reshape (t, size (s1));
6862
d63339cbb205 [project @ 2007-09-05 06:49:29 by jwe]
jwe
parents: 6713
diff changeset
161 endif
5881
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
162
70b3f8f1a793 [project @ 2006-07-08 03:54:17 by jwe]
jwe
parents:
diff changeset
163 endfunction
8594
756b0ba61350 orderfields.m: avoid loop for non-empty cases. New tests.
Jason Riedy <jason@acm.org>
parents: 8455
diff changeset
164
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
165
8605
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
166 %!shared a, b, c
8594
756b0ba61350 orderfields.m: avoid loop for non-empty cases. New tests.
Jason Riedy <jason@acm.org>
parents: 8455
diff changeset
167 %! a = struct ("foo", {1, 2}, "bar", {3, 4});
756b0ba61350 orderfields.m: avoid loop for non-empty cases. New tests.
Jason Riedy <jason@acm.org>
parents: 8455
diff changeset
168 %! b = struct ("bar", 6, "foo", 5);
8605
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
169 %! c = struct ("bar", {7, 8}, "foo", 9);
8594
756b0ba61350 orderfields.m: avoid loop for non-empty cases. New tests.
Jason Riedy <jason@acm.org>
parents: 8455
diff changeset
170 %!test
756b0ba61350 orderfields.m: avoid loop for non-empty cases. New tests.
Jason Riedy <jason@acm.org>
parents: 8455
diff changeset
171 %! a(2) = orderfields (b, a);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
172 %! assert (a(2).foo, 5);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
173 %! assert (a(2).bar, 6);
8594
756b0ba61350 orderfields.m: avoid loop for non-empty cases. New tests.
Jason Riedy <jason@acm.org>
parents: 8455
diff changeset
174 %!test
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
175 %! [a(2), p] = orderfields (b, [2 1]);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
176 %! assert (a(2).foo, 5);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
177 %! assert (a(2).bar, 6);
10122
9d1a14e12431 Update docs and add tests for container functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8920
diff changeset
178 %! assert (p, [2; 1]);
8594
756b0ba61350 orderfields.m: avoid loop for non-empty cases. New tests.
Jason Riedy <jason@acm.org>
parents: 8455
diff changeset
179 %!test
756b0ba61350 orderfields.m: avoid loop for non-empty cases. New tests.
Jason Riedy <jason@acm.org>
parents: 8455
diff changeset
180 %! a(2) = orderfields (b, fieldnames (a));
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
181 %! assert (a(2).foo, 5);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
182 %! assert (a(2).bar, 6);
8605
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
183 %!test
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
184 %! a(1:2) = orderfields (c, fieldnames (a));
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
185 %! assert (a(2).foo, 9);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
186 %! assert (a(2).bar, 8);
8605
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
187
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
188 %!test
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
189 %! aa.x = {1, 2};
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
190 %! aa.y = 3;
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
191 %! aa(2).x = {4, 5};
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
192 %! bb.y = {6, 7};
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
193 %! bb.x = 8;
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
194 %! aa(2) = orderfields (bb, aa);
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
195 %! assert (aa(2).x, 8);
9fc72c114ce1 Really fix indexing in orderfields.m
Jason Riedy <jason@acm.org>
parents: 8594
diff changeset
196 %! assert (aa(2).y{1}, 6);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
197