annotate scripts/miscellaneous/cast.m @ 19631:db92e7e28e1f

strip trailing whitespace from most source files * NEWS, doc/interpreter/contributors.in, doc/interpreter/func.txi, doc/interpreter/genpropdoc.m, doc/interpreter/octave_logo.eps, doc/interpreter/plot.txi, doc/interpreter/stmt.txi, examples/data/Makefile.am, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/gl-render.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/graphics.in.h, libinterp/corefcn/load-path.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/toplev.h, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/variables.cc, libinterp/octave-value/ov-classdef.cc, libinterp/octave-value/ov-classdef.h, libinterp/octave.cc, libinterp/parse-tree/lex.h, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-classdef.h, liboctave/system/file-ops.cc, liboctave/system/oct-env.cc, m4/acinclude.m4, scripts/deprecated/finite.m, scripts/deprecated/fmod.m, scripts/deprecated/fnmatch.m, scripts/deprecated/luinc.m, scripts/deprecated/octave_tmp_file_name.m, scripts/deprecated/syl.m, scripts/deprecated/usage.m, scripts/general/inputParser.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/isequal.m, scripts/general/private/__isequal__.m, scripts/geometry/voronoi.m, scripts/image/image.m, scripts/image/imshow.m, scripts/image/ind2rgb.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/isbanded.m, scripts/miscellaneous/bzip2.m, scripts/miscellaneous/cast.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/delete.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/getappdata.m, scripts/miscellaneous/gunzip.m, scripts/miscellaneous/isappdata.m, scripts/miscellaneous/ls.m, scripts/miscellaneous/mex.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/orderfields.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/rmappdata.m, scripts/miscellaneous/setfield.m, scripts/miscellaneous/symvar.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/ver.m, scripts/miscellaneous/what.m, scripts/miscellaneous/xor.m, scripts/miscellaneous/zip.m, scripts/optimization/fminbnd.m, scripts/optimization/sqp.m, scripts/path/private/getsavepath.m, scripts/path/savepath.m, scripts/pkg/pkg.m, scripts/pkg/private/installed_packages.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfnorm.m, scripts/plot/util/copyobj.m, scripts/plot/util/hgload.m, scripts/plot/util/hgsave.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/set/setdiff.m, scripts/set/union.m, scripts/signal/periodogram.m, scripts/sparse/eigs.m, scripts/sparse/ilu.m, scripts/sparse/qmr.m, scripts/sparse/sprand.m, scripts/sparse/sprandn.m, scripts/specfun/beta.m, scripts/specfun/ellipke.m, scripts/specfun/isprime.m, scripts/statistics/base/lscov.m, scripts/testfun/__run_test_suite__.m, scripts/testfun/test.m: Strip trailing whitespace.
author John W. Eaton <jwe@octave.org>
date Tue, 20 Jan 2015 10:29:54 -0500
parents 3d24778a8b12
children 4197fc428c7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17338
diff changeset
1 ## Copyright (C) 2007-2013 John W. Eaton
6403
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
2 ##
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
4 ##
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5011ac2fc23d [project @ 2007-03-13 14:45:51 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: 6403
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: 6403
diff changeset
8 ## your option) any later version.
6403
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
9 ##
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
14 ##
5011ac2fc23d [project @ 2007-03-13 14:45:51 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: 6403
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: 6403
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6403
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
18
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
19207
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
20 ## @deftypefn {Function File} {} cast (@var{val}, "@var{type}")
6403
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
21 ## Convert @var{val} to data type @var{type}.
18291
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
22 ##
19207
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
23 ## @var{val} must be one of the numeric classes:
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19207
diff changeset
24 ##
19207
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
25 ## @example
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
26 ## @group
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
27 ## "double"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
28 ## "single"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
29 ## "logical"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
30 ## "char"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
31 ## "int8"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
32 ## "int16"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
33 ## "int32"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
34 ## "int64"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
35 ## "uint8"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
36 ## "uint16"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
37 ## "uint32"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
38 ## "uint64"
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
39 ## @end group
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
40 ## @end example
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
41 ##
18291
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
42 ## The value @var{val} may be modified to fit within the range of the new type.
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
43 ##
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
44 ## Examples:
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
45 ##
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
46 ## @example
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
47 ## @group
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
48 ## cast (-5, "uint8")
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
49 ## @result{} 0
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
50 ## cast (300, "int8")
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
51 ## @result{} 127
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
52 ## @end group
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
53 ## @end example
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
54 ##
19207
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
55 ## @seealso{typecast, int8, uint8, int16, uint16, int32, uint32, int64, uint64, double, single, logical, char, class, typeinfo}
6403
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
56 ## @end deftypefn
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
57
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
58 ## Author: jwe
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
59
19207
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
60 function retval = cast (val, type)
6403
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
61
18291
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
62 if (nargin != 2)
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
63 print_usage ();
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
64 endif
9b163d6c1de7 cast.m: Improve documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
65
19207
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
66 if (! ischar (type))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
67 error ("cast: TYPE must be a string");
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
68 elseif (! any (strcmp (type, {"int8"; "uint8"; "int16"; "uint16";
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
69 "int32"; "uint32"; "int64"; "uint64";
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
70 "double"; "single"; "logical"; "char"})))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
71 error ("cast: TYPE '%s' is not a built-in type", type);
6403
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
72 endif
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19207
diff changeset
73
19207
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
74 retval = feval (type, val);
6403
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
75
5011ac2fc23d [project @ 2007-03-13 14:45:51 by jwe]
jwe
parents:
diff changeset
76 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 15466
diff changeset
77
19207
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
78
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
79 %!assert (cast (single (2.5), "double"), 2.5)
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
80 %!assert (cast (2.5, "single"), single (2.5))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
81 %!assert (cast ([5 0 -5], "logical"), [true false true])
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
82 %!assert (cast ([65 66 67], "char"), "ABC")
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
83 %!assert (cast ([-2.5 1.1 2.5], "int8"), int8 ([-3 1 3]))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
84 %!assert (cast ([-2.5 1.1 2.5], "uint8"), uint8 ([0 1 3]))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
85 %!assert (cast ([-2.5 1.1 2.5], "int16"), int16 ([-3 1 3]))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
86 %!assert (cast ([-2.5 1.1 2.5], "uint16"), uint16 ([0 1 3]))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
87 %!assert (cast ([-2.5 1.1 2.5], "int32"), int32 ([-3 1 3]))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
88 %!assert (cast ([-2.5 1.1 2.5], "uint32"), uint32 ([0 1 3]))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
89 %!assert (cast ([-2.5 1.1 2.5], "int64"), int64 ([-3 1 3]))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
90 %!assert (cast ([-2.5 1.1 2.5], "uint64"), uint64 ([0 1 3]))
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
91
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
92 ## Test input validation
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
93 %!error cast ()
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
94 %!error cast (1)
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
95 %!error cast (1,2,3)
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
96 %!error <TYPE 'foobar' is not a built-in type> cast (1, "foobar")
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
97 %!error <TYPE must be a string> cast (1, {"foobar"})
3d24778a8b12 cast.m: Overhaul function.
Rik <rik@octave.org>
parents: 18291
diff changeset
98