octave-antonio: scripts/strings/bin2dec.m annotate

annotate scripts/strings/bin2dec.m @ 20164:df437a52bcaf stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Mon, 04 May 2015 14:22:02 -0700
parents	9fc020886ae9
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 1996-2015 Daniel Calvelo
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	2 ##
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 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: 5924 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: 5924 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 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: 5924 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: 5924 diff changeset	17 ## <http://www.gnu.org/licenses/>.
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	18
3446 5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe] jwe parents: 2355 diff changeset	19 ## -- texinfo --
5666 4a48a1df26b7 [project @ 2006-03-15 02:37:55 by jwe] jwe parents: 5642 diff changeset	20 ## @deftypefn {Function File} {} bin2dec (@var{s})
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	21 ## Return the decimal number corresponding to the binary number represented
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	22 ## by the string @var{s}.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	23 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## For example:
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	25 ##
3446 5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe] jwe parents: 2355 diff changeset	26 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	27 ## @group
5666 4a48a1df26b7 [project @ 2006-03-15 02:37:55 by jwe] jwe parents: 5642 diff changeset	28 ## bin2dec ("1110")
3446 5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe] jwe parents: 2355 diff changeset	29 ## @result{} 14
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	30 ## @end group
3446 5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe] jwe parents: 2355 diff changeset	31 ## @end example
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: 3446 diff changeset	32 ##
14478 e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	33 ## Spaces are ignored during conversion and may be used to make the binary
e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	34 ## number more readable.
e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	35 ##
e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	36 ## @example
e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	37 ## @group
e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	38 ## bin2dec ("1000 0001")
e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	39 ## @result{} 129
e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	40 ## @end group
e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	41 ## @end example
e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	42 ##
13164 36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	43 ## If @var{s} is a string matrix, return a column vector with one converted
36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	44 ## number per row of @var{s}; Invalid rows evaluate to NaN@.
36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	45 ##
36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	46 ## If @var{s} is a cell array of strings, return a column vector with one
36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	47 ## converted number per cell element in @var{s}.
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	48 ## @seealso{dec2bin, base2dec, hex2dec}
3446 5ee5afb3981a [project @ 2000-01-17 09:42:43 by jwe] jwe parents: 2355 diff changeset	49 ## @end deftypefn
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	50
3791 c1c532a0acb2 [project @ 2001-02-09 15:28:23 by jwe] jwe parents: 3789 diff changeset	51 ## Author: Daniel Calvelo <dcalvelo@yahoo.com>
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: 3446 diff changeset	52 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	53
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	54 function d = bin2dec (s)
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	55
13164 36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	56 if (nargin != 1)
5924 87fcda0eda04 [project @ 2006-08-14 18:41:15 by jwe] jwe parents: 5666 diff changeset	57 print_usage ();
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	58 endif
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	59
13164 36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	60 d = base2dec (s, 2);
36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	61
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	62 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	63
13164 36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	64
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14491 diff changeset	65 %!assert (bin2dec ("0000"), 0)
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14491 diff changeset	66 %!assert (bin2dec ("1110"), 14)
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14491 diff changeset	67 %!assert (bin2dec ("11111111111111111111111111111111111111111111111111111"), 2^53-1)
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14491 diff changeset	68 %!assert (bin2dec ({"1110", "1111"}), [14; 15])
14478 e995b1c97e13 Fix regression in bin2dec which did not allow space-separated input. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	69 %!assert (bin2dec ("1 0 1"), 5)
14491 5bd9e47e9277 maint: periodic merge of stable to default Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14402 14478 diff changeset	70 %!assert (bin2dec (char ("1 0 1", " 1111")), [5; 15])
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	71
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	72 ## Test input validation
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	73 %!error bin2dec ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	74 %!error bin2dec (1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	75 %!error bin2dec ("1", 2)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	76

Mercurial > octave-antonio

annotate scripts/strings/bin2dec.m @ 20164:df437a52bcaf stable