Mercurial > hg > octave-nkf
view scripts/strings/base2dec.m @ 20368:7503499a252b stable
doc: Update docstrings to have one sentence summary as first line.
Update scripts in audio, elfun, general, geometry, and image directories.
* scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m,
scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m,
scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m,
scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m,
scripts/general/accumarray.m, scripts/general/accumdim.m,
scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m,
scripts/general/blkdiag.m, scripts/general/cart2pol.m,
scripts/general/cart2sph.m, scripts/general/cell2mat.m,
scripts/general/celldisp.m, scripts/general/chop.m,
scripts/general/circshift.m, scripts/general/common_size.m,
scripts/general/cplxpair.m, scripts/general/cumtrapz.m,
scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m,
scripts/general/display.m, scripts/general/divergence.m,
scripts/general/fieldnames.m, scripts/general/flip.m,
scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m,
scripts/general/gradient.m, scripts/general/interp3.m,
scripts/general/interpft.m, scripts/general/interpn.m,
scripts/general/loadobj.m, scripts/general/logspace.m,
scripts/general/methods.m, scripts/general/nargchk.m,
scripts/general/narginchk.m, scripts/general/nargoutchk.m,
scripts/general/nextpow2.m, scripts/general/nthargout.m,
scripts/general/num2str.m, scripts/general/pol2cart.m,
scripts/general/polyarea.m, scripts/general/postpad.m,
scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m,
scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m,
scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m,
scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m,
scripts/general/shiftdim.m, scripts/general/sortrows.m,
scripts/general/sph2cart.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/trapz.m,
scripts/general/triplequad.m, scripts/geometry/delaunayn.m,
scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m,
scripts/geometry/rectint.m, scripts/geometry/tsearchn.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/help/__unimplemented__.m, scripts/help/doc.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m,
scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m,
scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m,
scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m,
scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m,
scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m,
scripts/image/hot.m, scripts/image/hsv.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/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m,
scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m,
scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m,
scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m,
scripts/image/white.m, scripts/image/winter.m:
Update docstrings to have one sentence summary as first line.
Re-structure to have line lengths <= 80 chars.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 09:36:20 -0700 |
parents | 9fc020886ae9 |
children | df437a52bcaf |
line wrap: on
line source
## Copyright (C) 2000-2015 Daniel Calvelo ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} base2dec (@var{s}, @var{base}) ## Convert @var{s} from a string of digits in base @var{base} to a decimal ## integer (base 10). ## ## @example ## @group ## base2dec ("11120", 3) ## @result{} 123 ## @end group ## @end example ## ## If @var{s} is a string matrix, return a column vector with one value per ## row of @var{s}. If a row contains invalid symbols then the ## corresponding value will be NaN@. ## ## If @var{s} is a cell array of strings, return a column vector with one ## value per cell element in @var{s}. ## ## If @var{base} is a string, the characters of @var{base} are used as the ## symbols for the digits of @var{s}. Space (' ') may not be used as a ## symbol. ## ## @example ## @group ## base2dec ("yyyzx", "xyz") ## @result{} 123 ## @end group ## @end example ## @seealso{dec2base, bin2dec, hex2dec} ## @end deftypefn ## Author: Daniel Calvelo <dcalvelo@yahoo.com> ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> function out = base2dec (s, base) if (nargin != 2) print_usage (); endif if (iscellstr (s)) s = char (s); elseif (! ischar (s)) error ("base2dec: S must be a string or cellstring"); endif symbols = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"; if (ischar (base)) symbols = base; base = length (symbols); if (length (unique (symbols)) != base) error ("base2dec: symbols representing digits must be unique"); endif if (any (isspace (symbols))) error ("base2dec: whitespace characters are not valid symbols"); endif elseif (! isscalar (base)) error ("base2dec: cannot convert from several bases at once"); elseif (base < 2 || base > length (symbols)) error ("base2dec: BASE must be between 2 and 36, or a string of symbols"); else s = toupper (s); endif ## Right justify the values and squeeze out any spaces. ## This looks complicated, but indexing solution is very fast ## compared to alternatives which use cellstr or cellfun or looping. [nr, nc] = size (s); if (nc > 1) # Bug #35621 s = s.'; nonbl = s != " "; num_nonbl = sum (nonbl); nc = max (num_nonbl); num_blank = nc - num_nonbl; R = repmat ([1 2; 0 0], 1, nr); R(2, 1:2:2*nr) = num_blank; R(2, 2:2:2*nr) = num_nonbl; idx = repelems ([false, true], R); idx = reshape (idx, nc, nr); ## Create a blank matrix and position the nonblank characters. s2 = repmat (" ", nc, nr); s2(idx) = s(nonbl); s = s2.'; endif ## Lookup value of symbols in symbol table, with invalid symbols ## evaluating to NaN and space evaluating to 0. table = NaN (1, 256); table(toascii (symbols(1:base))) = 0 : base-1; table(toascii (" ")) = 0; s = reshape (table(toascii (s)), size (s)); ## Multiply the resulting digits by the appropriate power ## and sum the rows. out = s * (base .^ (columns(s)-1 : -1 : 0)'); endfunction %!assert (base2dec ("11120", 3), 123) %!assert (base2dec ("yyyzx", "xyz"), 123) %!assert (base2dec ("-1", 2), NaN) %!assert (base2dec ({"A1", "1A"}, 16), [161; 26]) ## Bug #35621 %!assert (base2dec (["0"; "1"], 2), [0; 1]) ## Test input validation %!error base2dec () %!error base2dec ("11120") %!error base2dec ("11120", 3, 4) %!error base2dec ("11120", "1231") %!error base2dec ("11120", "12 3") %!error base2dec ("11120", ones (2)) %!error base2dec ("11120", 37)