Mercurial > octave
view scripts/miscellaneous/cast.m @ 27898:4d6d21839dfd
remove Author: jwe and Adapted-by: jwe lines from source files
These lines have little meaning now in the age of modern version
control systems.
Files affected: url-transfer.cc, url-transfer.h, acot.m, acoth.m,
acsc.m, acsch.m, asec.m, asech.m, cot.m, coth.m, csc.m, csch.m, sec.m,
sech.m, cart2pol.m, cart2sph.m, deal.m, fliplr.m, flipud.m, int2str.m,
logspace.m, num2str.m, pol2cart.m, rot90.m, sortrows.m, sph2cart.m,
waitbar.m, doc.m, hsv2rgb.m, rgb2hsv.m, beep.m, isstr.m, setstr.m,
strmatch.m, cond.m, rank.m, trace.m, bug_report.m, cast.m, delete.m,
dir.m, list_primes.m, ls.m, ls_command.m, menu.m, pack.m, recycle.m,
substruct.m, version.m, glpk.m, axis.m, box.m, grid.m,
__axis_label__.m, text.m, title.m, view.m, xlabel.m, ylabel.m,
zlabel.m, bar.m, barh.m, comet3.m, hist.m, line.m, loglog.m, mesh.m,
patch.m, plot.m, polar.m, __bar__.m, __line__.m, __plt__.m,
__stem__.m, semilogx.m, semilogy.m, sombrero.m, stairs.m, stem.m,
surface.m, __default_plot_options__.m, __gnuplot_drawnow__.m,
__next_line_color__.m, __plt_get_axis_arg__.m, __pltopt__.m, clf.m,
closereq.m, gca.m, gnuplot_binary.in.m, isfigure.m, meshgrid.m,
__gnuplot_draw_axes__.m, __gnuplot_draw_figure__.m, shg.m, addpref.m,
getpref.m, ispref.m, loadprefs.m, prefsfile.m, saveprefs.m, rmpref.m,
setpref.m, ismember.m, setdiff.m, union.m, hankel.m, hilb.m, vander.m,
median.m, std.m, cstrcat.m, isletter.m, str2num.m, strcat.m,
oruntests.m, rundemos.m, asctime.m, clock.m, ctime.m, date.m, etime.m,
is_leap_year.m.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 02 Jan 2020 15:43:01 -0500 |
parents | 00f796120a6d |
children | b442ec6dda5c |
line wrap: on
line source
## Copyright (C) 2007-2019 John W. Eaton ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {} {} cast (@var{val}, "@var{type}") ## Convert @var{val} to data type @var{type}. ## ## Both @var{val} and @var{type} are typically one of the following built-in ## classes: ## ## @example ## @group ## "double" ## "single" ## "logical" ## "char" ## "int8" ## "int16" ## "int32" ## "int64" ## "uint8" ## "uint16" ## "uint32" ## "uint64" ## @end group ## @end example ## ## The value @var{val} may be modified to fit within the range of the new type. ## ## Examples: ## ## @example ## @group ## cast (-5, "uint8") ## @result{} 0 ## cast (300, "int8") ## @result{} 127 ## @end group ## @end example ## ## Programming Note: This function relies on the object @var{val} having a ## conversion method named @var{type}. User-defined classes may implement only ## a subset of the full list of types shown above. In that case, it may be ## necessary to call cast twice in order to reach the desired type. ## For example, the conversion to double is nearly always implemented, but ## the conversion to uint8 might not be. In that case, the following code will ## work ## ## @example ## cast (cast (@var{user_defined_val}, "double"), "uint8") ## @end example ## ## @seealso{typecast, int8, uint8, int16, uint16, int32, uint32, int64, uint64, double, single, logical, char, class, typeinfo} ## @end deftypefn function retval = cast (val, type) if (nargin != 2) print_usage (); endif if (! ischar (type)) error ("cast: TYPE must be a string"); elseif (! any (strcmp (type, {"int8"; "uint8"; "int16"; "uint16"; "int32"; "uint32"; "int64"; "uint64"; "double"; "single"; "logical"; "char"}))) error ("cast: TYPE '%s' is not a built-in type", type); endif retval = feval (type, val); endfunction %!assert (cast (single (2.5), "double"), 2.5) %!assert (cast (2.5, "single"), single (2.5)) %!assert (cast ([5 0 -5], "logical"), [true false true]) %!assert (cast ([65 66 67], "char"), "ABC") %!assert (cast ([-2.5 1.1 2.5], "int8"), int8 ([-3 1 3])) %!assert (cast ([-2.5 1.1 2.5], "uint8"), uint8 ([0 1 3])) %!assert (cast ([-2.5 1.1 2.5], "int16"), int16 ([-3 1 3])) %!assert (cast ([-2.5 1.1 2.5], "uint16"), uint16 ([0 1 3])) %!assert (cast ([-2.5 1.1 2.5], "int32"), int32 ([-3 1 3])) %!assert (cast ([-2.5 1.1 2.5], "uint32"), uint32 ([0 1 3])) %!assert (cast ([-2.5 1.1 2.5], "int64"), int64 ([-3 1 3])) %!assert (cast ([-2.5 1.1 2.5], "uint64"), uint64 ([0 1 3])) ## Test input validation %!error cast () %!error cast (1) %!error cast (1,2,3) %!error <TYPE 'foobar' is not a built-in type> cast (1, "foobar") %!error <TYPE must be a string> cast (1, {"foobar"})