Mercurial > octave-nkf
annotate scripts/strings/str2num.m @ 17281:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m,
scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m,
scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m,
scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.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/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 19 Aug 2013 20:46:38 -0700 |
parents | f3d52523cde1 |
children | d63878346099 |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13931
diff
changeset
|
1 ## Copyright (C) 1996-2012 Kurt Hornik |
2558 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
2558 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
2558 | 18 |
3361 | 19 ## -*- texinfo -*- |
13178
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
20 ## @deftypefn {Function File} {@var{x} =} str2num (@var{s}) |
12945
0c74237b3479
str2num.m: Add second output indicating state of the conversion.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
21 ## @deftypefnx {Function File} {[@var{x}, @var{state}] =} str2num (@var{s}) |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
22 ## Convert the string (or character array) @var{s} to a number (or an |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
23 ## array). Examples: |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
24 ## |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
25 ## @example |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
26 ## @group |
13035
8abb190e6cc8
doc: Improve strnum() docstring
Rik <octave@nomad.inbox5.com>
parents:
12945
diff
changeset
|
27 ## str2num ("3.141596") |
8abb190e6cc8
doc: Improve strnum() docstring
Rik <octave@nomad.inbox5.com>
parents:
12945
diff
changeset
|
28 ## @result{} 3.141596 |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
29 ## |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
30 ## str2num (["1, 2, 3"; "4, 5, 6"]) |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
31 ## @result{} 1 2 3 |
13035
8abb190e6cc8
doc: Improve strnum() docstring
Rik <octave@nomad.inbox5.com>
parents:
12945
diff
changeset
|
32 ## 4 5 6 |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
33 ## @end group |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
34 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
35 ## |
12945
0c74237b3479
str2num.m: Add second output indicating state of the conversion.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
36 ## The optional second output, @var{state}, is logically true when the |
13931
9de488c6c59c
doc: Spellcheck documentation before 3.6.0 release
Rik <octave@nomad.inbox5.com>
parents:
13315
diff
changeset
|
37 ## conversion is successful. If the conversion fails the numeric output, |
13035
8abb190e6cc8
doc: Improve strnum() docstring
Rik <octave@nomad.inbox5.com>
parents:
12945
diff
changeset
|
38 ## @var{x}, is empty and @var{state} is false. |
12945
0c74237b3479
str2num.m: Add second output indicating state of the conversion.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
39 ## |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
40 ## @strong{Caution:} As @code{str2num} uses the @code{eval} function |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
41 ## to do the conversion, @code{str2num} will execute any code contained |
13035
8abb190e6cc8
doc: Improve strnum() docstring
Rik <octave@nomad.inbox5.com>
parents:
12945
diff
changeset
|
42 ## in the string @var{s}. Use @code{str2double} for a safer and faster |
8abb190e6cc8
doc: Improve strnum() docstring
Rik <octave@nomad.inbox5.com>
parents:
12945
diff
changeset
|
43 ## conversion. |
13178
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
44 ## |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
45 ## For cell array of strings use @code{str2double}. |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
46 ## @seealso{str2double, eval} |
3361 | 47 ## @end deftypefn |
2558 | 48 |
49 ## Author: jwe | |
50 | |
12945
0c74237b3479
str2num.m: Add second output indicating state of the conversion.
Ben Abbott <bpabbott@mac.com>
parents:
11587
diff
changeset
|
51 function [m, state] = str2num (s) |
2558 | 52 |
13178
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
53 if (nargin != 1) |
6046 | 54 print_usage (); |
13315
fa1b2b394195
str2num.m: Simplify and speed up code by using indexing.
Rik <octave@nomad.inbox5.com>
parents:
13178
diff
changeset
|
55 elseif (! ischar (s)) |
13178
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
56 error ("str2num: S must be a string or string array"); |
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
57 endif |
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
58 |
13315
fa1b2b394195
str2num.m: Simplify and speed up code by using indexing.
Rik <octave@nomad.inbox5.com>
parents:
13178
diff
changeset
|
59 s(:, end+1) = ";"; |
fa1b2b394195
str2num.m: Simplify and speed up code by using indexing.
Rik <octave@nomad.inbox5.com>
parents:
13178
diff
changeset
|
60 s = sprintf ("m = [%s];", reshape (s', 1, numel (s))); |
13178
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
61 state = true; |
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
62 eval (s, "m = []; state = false;"); |
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
63 if (ischar (m)) |
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
64 m = []; |
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
65 state = false; |
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
66 endif |
2558 | 67 |
68 endfunction | |
7411 | 69 |
13178
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
70 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
71 %!assert (str2num ("-1.3e2"), -130) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
72 %!assert (str2num ("[1, 2; 3, 4]"), [1, 2; 3, 4]) |
7411 | 73 |
13315
fa1b2b394195
str2num.m: Simplify and speed up code by using indexing.
Rik <octave@nomad.inbox5.com>
parents:
13178
diff
changeset
|
74 %!test |
fa1b2b394195
str2num.m: Simplify and speed up code by using indexing.
Rik <octave@nomad.inbox5.com>
parents:
13178
diff
changeset
|
75 %! [x, state] = str2num ("pi"); |
fa1b2b394195
str2num.m: Simplify and speed up code by using indexing.
Rik <octave@nomad.inbox5.com>
parents:
13178
diff
changeset
|
76 %! assert (state); |
fa1b2b394195
str2num.m: Simplify and speed up code by using indexing.
Rik <octave@nomad.inbox5.com>
parents:
13178
diff
changeset
|
77 %! [x, state] = str2num ("Hello World"); |
fa1b2b394195
str2num.m: Simplify and speed up code by using indexing.
Rik <octave@nomad.inbox5.com>
parents:
13178
diff
changeset
|
78 %! assert (! state); |
fa1b2b394195
str2num.m: Simplify and speed up code by using indexing.
Rik <octave@nomad.inbox5.com>
parents:
13178
diff
changeset
|
79 |
13178
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
80 %% Test input validation |
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
81 %!error str2num () |
89fb0e668825
str2num.m: Use more modern code practices
Rik <octave@nomad.inbox5.com>
parents:
13035
diff
changeset
|
82 %!error str2num ("string", 1) |
13315
fa1b2b394195
str2num.m: Simplify and speed up code by using indexing.
Rik <octave@nomad.inbox5.com>
parents:
13178
diff
changeset
|
83 %!error <S must be a string> str2num ({"string"}) |
7411 | 84 |