Mercurial > hg > octave-lyh

annotate scripts/strings/validatestring.m @ 17346:1c89599167a6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: End m-files with 1 blank line. Simplifies automated grammarchecking script. * scripts/@ftp/ascii.m, scripts/@ftp/binary.m, scripts/@ftp/cd.m, scripts/@ftp/close.m, scripts/@ftp/delete.m, scripts/@ftp/dir.m, scripts/@ftp/display.m, scripts/@ftp/ftp.m, scripts/@ftp/loadobj.m, scripts/@ftp/mget.m, scripts/@ftp/mkdir.m, scripts/@ftp/mput.m, scripts/@ftp/rename.m, scripts/@ftp/rmdir.m, scripts/@ftp/saveobj.m, scripts/audio/lin2mu.m, scripts/audio/loadaudio.m, scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/saveaudio.m, scripts/audio/setaudio.m, scripts/deprecated/__error_text__.m, scripts/deprecated/cut.m, scripts/deprecated/error_text.m, scripts/deprecated/isstr.m, scripts/deprecated/polyderiv.m, scripts/deprecated/studentize.m, scripts/deprecated/sylvester_matrix.m, scripts/general/bicubic.m, scripts/general/celldisp.m, scripts/general/colon.m, scripts/general/cplxpair.m, scripts/general/del2.m, scripts/general/display.m, scripts/general/isdir.m, scripts/general/isequaln.m, scripts/general/loadobj.m, scripts/general/private/__isequal__.m, scripts/general/private/__splinen__.m, scripts/general/profexplore.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/repmat.m, scripts/general/saveobj.m, scripts/geometry/delaunay.m, scripts/help/__unimplemented__.m, scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m, scripts/help/help.m, scripts/help/print_usage.m, scripts/help/private/__additional_help_message__.m, scripts/help/private/__strip_html_tags__.m, scripts/help/type.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imwrite.m, scripts/image/private/__imfinfo__.m, scripts/image/private/__imread__.m, scripts/image/private/__imwrite__.m, scripts/image/private/imageIO.m, scripts/image/private/imwrite_filename.m, scripts/image/private/ind2x.m, scripts/io/beep.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/subspace.m, scripts/miscellaneous/bug_report.m, scripts/miscellaneous/bunzip2.m, scripts/miscellaneous/cast.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/dump_prefs.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/gunzip.m, scripts/miscellaneous/isdeployed.m, scripts/miscellaneous/ismac.m, scripts/miscellaneous/mex.m, scripts/miscellaneous/mexext.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/namelengthmax.m, scripts/miscellaneous/news.m, scripts/miscellaneous/pack.m, scripts/miscellaneous/perl.m, scripts/miscellaneous/private/display_info_file.m, scripts/miscellaneous/python.m, scripts/miscellaneous/rmappdata.m, scripts/miscellaneous/run.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tempname.m, scripts/miscellaneous/untar.m, scripts/miscellaneous/unzip.m, scripts/miscellaneous/what.m, scripts/miscellaneous/zip.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/optimget.m, scripts/optimization/optimset.m, scripts/optimization/qp.m, scripts/optimization/sqp.m, scripts/path/pathdef.m, scripts/pkg/pkg.m, scripts/pkg/private/build.m, scripts/pkg/private/describe.m, scripts/pkg/private/dirempty.m, scripts/pkg/private/get_forge_download.m, scripts/pkg/private/get_forge_pkg.m, scripts/pkg/private/get_unsatisfied_deps.m, scripts/pkg/private/install.m, scripts/pkg/private/is_architecture_dependent.m, scripts/pkg/private/list_forge_packages.m, scripts/pkg/private/rebuild.m, scripts/pkg/private/shell.m, scripts/pkg/private/uninstall.m, scripts/plot/axes.m, scripts/plot/box.m, scripts/plot/closereq.m, scripts/plot/diffuse.m, scripts/plot/ezpolar.m, scripts/plot/findfigs.m, scripts/plot/gco.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/linkprop.m, scripts/plot/peaks.m, scripts/plot/print.m, scripts/plot/private/__add_datasource__.m, scripts/plot/private/__axis_label__.m, scripts/plot/private/__clabel__.m, scripts/plot/private/__color_str_rgb__.m, scripts/plot/private/__contour__.m, scripts/plot/private/__default_plot_options__.m, scripts/plot/private/__errcomm__.m, scripts/plot/private/__file_filter__.m, scripts/plot/private/__fltk_file_filter__.m, scripts/plot/private/__getlegenddata__.m, scripts/plot/private/__gnuplot_open_stream__.m, scripts/plot/private/__gnuplot_print__.m, scripts/plot/private/__go_draw_axes__.m, scripts/plot/private/__interp_cube__.m, scripts/plot/private/__is_function__.m, scripts/plot/private/__line__.m, scripts/plot/private/__marching_cube__.m, scripts/plot/private/__next_line_style__.m, scripts/plot/private/__patch__.m, scripts/plot/private/__pie__.m, scripts/plot/private/__pltopt__.m, scripts/plot/private/__quiver__.m, scripts/plot/private/__scatter__.m, scripts/plot/private/__stem__.m, scripts/plot/private/__uigetdir_fltk__.m, scripts/plot/private/__uigetfile_fltk__.m, scripts/plot/private/__uiobject_split_args__.m, scripts/plot/private/__uiputfile_fltk__.m, scripts/plot/refresh.m, scripts/plot/saveas.m, scripts/plot/shg.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/uicontextmenu.m, scripts/plot/uicontrol.m, scripts/plot/uipanel.m, scripts/plot/uipushtool.m, scripts/plot/uiresume.m, scripts/plot/uitoggletool.m, scripts/plot/uitoolbar.m, scripts/plot/uiwait.m, scripts/plot/waitforbuttonpress.m, scripts/polynomial/pchip.m, scripts/polynomial/polyeig.m, scripts/polynomial/ppval.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/private/loadprefs.m, scripts/prefs/private/prefsfile.m, scripts/prefs/private/saveprefs.m, scripts/prefs/setpref.m, scripts/set/private/validargs.m, scripts/set/unique.m, scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m, scripts/signal/arch_test.m, scripts/signal/arma_rnd.m, scripts/signal/durbinlevinson.m, scripts/signal/fractdiff.m, scripts/signal/freqz.m, scripts/signal/freqz_plot.m, scripts/signal/hurst.m, scripts/signal/periodogram.m, scripts/signal/private/rectangle_lw.m, scripts/signal/private/rectangle_sw.m, scripts/signal/private/triangle_sw.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/signal/stft.m, scripts/signal/synthesis.m, scripts/signal/yulewalker.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/private/__sprand_impl__.m, scripts/sparse/spdiags.m, scripts/sparse/sprandn.m, scripts/specfun/bessel.m, scripts/specfun/betaln.m, scripts/specfun/expint.m, scripts/special-matrix/gallery.m, scripts/startup/__finish__.m, scripts/statistics/base/qqplot.m, scripts/statistics/distributions/tcdf.m, scripts/statistics/distributions/wienrnd.m, scripts/statistics/models/logistic_regression.m, scripts/statistics/models/private/logistic_regression_derivatives.m, scripts/statistics/models/private/logistic_regression_likelihood.m, scripts/statistics/tests/anova.m, scripts/statistics/tests/bartlett_test.m, scripts/statistics/tests/chisquare_test_homogeneity.m, scripts/statistics/tests/chisquare_test_independence.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/f_test_regression.m, scripts/statistics/tests/hotelling_test.m, scripts/statistics/tests/hotelling_test_2.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/manova.m, scripts/statistics/tests/mcnemar_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/run_test.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m, scripts/strings/strcat.m, scripts/strings/strjoin.m, scripts/strings/strsplit.m, scripts/testfun/__have_feature__.m, scripts/testfun/__printf_assert__.m, scripts/testfun/__prog_output_assert__.m, scripts/testfun/__run_test_suite__.m, scripts/time/clock.m, scripts/time/datenum.m, scripts/ui/errordlg.m, scripts/ui/private/message_dialog.m: End m-files with 1 blank line.
author Rik <rik@octave.org>
date Wed, 28 Aug 2013 08:33:02 -0700
parents bc924baa2c4e
children 3f0ed69d21c6
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: 14093
diff changeset
1 ## Copyright (C) 2008-2012 Bill Denney
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
2 ##
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
3 ## This file is part of Octave.
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
4 ##
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
8 ## your option) any later version.
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
9 ##
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
13 ## General Public License for more details.
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
14 ##
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
18
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9209
diff changeset
20 ## @deftypefn {Function File} {@var{validstr} =} validatestring (@var{str}, @var{strarray})
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
21 ## @deftypefnx {Function File} {@var{validstr} =} validatestring (@var{str}, @var{strarray}, @var{funcname})
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
22 ## @deftypefnx {Function File} {@var{validstr} =} validatestring (@var{str}, @var{strarray}, @var{funcname}, @var{varname})
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
23 ## @deftypefnx {Function File} {@var{validstr} =} validatestring (@dots{}, @var{position})
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
24 ## Verify that @var{str} is an element, or substring of an element, in
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
25 ## @var{strarray}.
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
26 ##
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
27 ## When @var{str} is a character string to be tested, and @var{strarray} is a
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
28 ## cellstr of valid values, then @var{validstr} will be the validated form
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
29 ## of @var{str} where validation is defined as @var{str} being a member
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
30 ## or substring of @var{validstr}. This is useful for both verifying
17289
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 14363
diff changeset
31 ## and expanding short options, such as @qcode{"r"}, to their longer forms,
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 14363
diff changeset
32 ## such as @qcode{"red"}. If @var{str} is a substring of @var{validstr}, and
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 14363
diff changeset
33 ## there are multiple matches, the shortest match will be returned if all
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 14363
diff changeset
34 ## matches are substrings of each other. Otherwise, an error will be raised
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 14363
diff changeset
35 ## because the expansion of @var{str} is ambiguous. All comparisons are case
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 14363
diff changeset
36 ## insensitive.
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
37 ##
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
38 ## The additional inputs @var{funcname}, @var{varname}, and @var{position}
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
39 ## are optional and will make any generated validation error message more
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
40 ## specific.
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
41 ##
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
42 ## Examples:
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 13708
diff changeset
43 ## @c Set example in small font to prevent overfull line
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
44 ##
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 13708
diff changeset
45 ## @smallexample
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
46 ## @group
13708
ee28bf4c3c29 doc: Use @{ macro for curly brace in validatestring Texinfo docstring
Rik <octave@nomad.inbox5.com>
parents: 13707
diff changeset
47 ## validatestring ("r", @{"red", "green", "blue"@})
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 13708
diff changeset
48 ## @result{} "red"
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
49 ##
13708
ee28bf4c3c29 doc: Use @{ macro for curly brace in validatestring Texinfo docstring
Rik <octave@nomad.inbox5.com>
parents: 13707
diff changeset
50 ## validatestring ("b", @{"red", "green", "blue", "black"@})
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 13708
diff changeset
51 ## @result{} error: validatestring: multiple unique matches were found for 'b':
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 13708
diff changeset
52 ## blue, black
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
53 ## @end group
14093
050bc580cb60 doc: Various docstring improvements before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents: 13708
diff changeset
54 ## @end smallexample
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
55 ##
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
56 ## @seealso{strcmp, strcmpi}
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
57 ## @end deftypefn
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
58
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
59 ## Author: Bill Denney <bill@denney.ws>
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
60
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
61 function str = validatestring (str, strarray, varargin)
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
62
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
63 if (nargin < 2 || nargin > 5)
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
64 print_usage ();
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
65 endif
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
66
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
67 position = 0;
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
68 ## Process input arguments
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
69 if (! isempty (varargin) && isnumeric (varargin{end}))
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
70 position = varargin{end};
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
71 varargin(end) = [];
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
72 endif
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
73
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
74 funcname = varname = "";
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
75 char_idx = cellfun ("isclass", varargin, "char");
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
76 n_chararg = sum (char_idx);
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
77 if (n_chararg > 2)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
78 error ("validatestring: invalid number of character inputs (3)");
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
79 elseif (n_chararg == 2)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
80 [funcname, varname] = deal (varargin{char_idx});
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
81 elseif (n_chararg == 1)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
82 funcname = varargin{char_idx};
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
83 endif
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
84
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
85 ## Check the inputs
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
86 if (! ischar (str))
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
87 error ("validatestring: STR must be a character string");
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
88 elseif (! isrow (str))
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
89 error ("validatestring: STR must be a single row vector");
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
90 elseif (! iscellstr (strarray))
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
91 error ("validatestring: STRARRAY must be a cellstr");
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
92 elseif (! isempty (funcname) && ! isrow (funcname))
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
93 error ("validatestring: FUNCNAME must be a single row vector");
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
94 elseif (! isempty (varname) && ! isrow (varname))
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
95 error ("validatestring: VARNAME must be a single row vector");
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
96 elseif (position < 0)
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
97 error ("validatestring: POSITION must be >= 0");
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
98 endif
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
99
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
100 ## Make static part of error string that uses funcname, varname, and position
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
101 errstr = "";
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
102 if (! isempty (funcname))
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
103 errstr = sprintf ("Function: %s ", funcname);
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
104 endif
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
105 if (! isempty (varname))
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
106 errstr = sprintf ("%sVariable: %s ", errstr, varname);
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
107 endif
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
108 if (position > 0)
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
109 errstr = sprintf ("%sArgument position %d ", errstr, position);
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
110 endif
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
111 if (! isempty (errstr))
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
112 errstr(end:end+1) = ":\n";
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
113 endif
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
114
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
115 matches = strncmpi (str, strarray(:), numel (str));
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
116 nmatches = sum (matches);
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
117 if (nmatches == 0)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
118 error ("validatestring: %s'%s' does not match any of\n%s", errstr, str,
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
119 sprintf ("%s, ", strarray{:})(1:end-2));
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
120 elseif (nmatches == 1)
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
121 str = strarray{matches};
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
122 else
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
123 ## Are the matches substrings of each other?
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
124 ## If true, choose the shortest. If not, raise an error.
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
125 match_idx = find (matches);
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
126 match_len = cellfun ("length", strarray(match_idx));
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
127 [min_len, min_idx] = min (match_len);
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
128 short_str = strarray{match_idx(min_idx)};
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
129 submatch = strncmpi (short_str, strarray(match_idx), min_len);
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
130 if (all (submatch))
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
131 str = short_str;
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
132 else
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
133 error ("validatestring: %smultiple unique matches were found for '%s':\n%s",
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
134 errstr, str, sprintf ("%s, ", strarray{match_idx})(1:end-2));
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
135 endif
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
136 endif
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
137
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
138 endfunction
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
139
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
140
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
141 %!shared strarray
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
142 %! strarray = {"octave" "Oct" "octopus" "octaves"};
7658
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
143 %!assert (validatestring ("octave", strarray), "octave")
1ce6460aebdf nargoutchk.m, validatestring.m, addtodate.m: new functions
bill@denney.ws
parents:
diff changeset
144 %!assert (validatestring ("oct", strarray), "Oct")
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
145 %!assert (validatestring ("octa", strarray), "octave")
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
146 %! strarray = {"abc1" "def" "abc2"};
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
147 %!assert (validatestring ("d", strarray), "def")
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
148
13707
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
149 %!error <'xyz' does not match any> validatestring ("xyz", strarray)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
150 %!error <Function: DUMMY_TEST> validatestring ("xyz", strarray, "DUMMY_TEST")
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
151 %!error <Function: DUMMY_TEST Variable: DUMMY_VAR:> validatestring ("xyz", strarray, "DUMMY_TEST", "DUMMY_VAR")
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
152 %!error <Function: DUMMY_TEST Variable: DUMMY_VAR Argument position 5> validatestring ("xyz", strarray, "DUMMY_TEST", "DUMMY_VAR", 5)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
153 %!error <multiple unique matches were found for 'abc'> validatestring ("abc", strarray)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
154
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
155 %% Test input validation
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
156 %!error validatestring ("xyz")
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
157 %!error validatestring ("xyz", {"xyz"}, "3", "4", 5, 6)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
158 %!error <invalid number of character inputs> validatestring ("xyz", {"xyz"}, "3", "4", "5")
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
159 %!error <STR must be a character string> validatestring (1, {"xyz"}, "3", "4", 5)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
160 %!error <STR must be a single row vector> validatestring ("xyz".', {"xyz"}, "3", "4", 5)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
161 %!error <STRARRAY must be a cellstr> validatestring ("xyz", "xyz", "3", "4", 5)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
162 %!error <FUNCNAME must be a single row vector> validatestring ("xyz", {"xyz"}, "33".', "4", 5)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
163 %!error <VARNAME must be a single row vector> validatestring ("xyz", {"xyz"}, "3", "44".', 5)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
164 %!error <POSITION must be> validatestring ("xyz", {"xyz"}, "3", "4", -5)
35f7cbf09c77 validatestring.m: Overhaul code for Matlab compatability and performance.
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
165