Mercurial > octave

annotate scripts/strings/dec2bin.m @ 22323:bac0d6f07a3e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Update copyright notices for 2016.
author John W. Eaton <jwe@octave.org>
date Wed, 17 Aug 2016 01:05:19 -0400
parents 516bb87ea72e
children 3a2b891d0b33 e9a0469dedd9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22323
bac0d6f07a3e maint: Update copyright notices for 2016.
John W. Eaton <jwe@octave.org>
parents: 20852
diff changeset
1 ## Copyright (C) 1996-2016 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: 6046
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: 6046
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: 6046
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: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
18
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
19 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20164
diff changeset
20 ## @deftypefn {} {} dec2bin (@var{d}, @var{len})
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
21 ## Return a binary number corresponding to the non-negative integer @var{d},
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
22 ## as a string of ones and zeros.
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:
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
25 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 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
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
28 ## dec2bin (14)
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
29 ## @result{} "1110"
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
30 ## @end group
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
31 ## @end example
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3426
diff changeset
32 ##
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
33 ## If @var{d} is a matrix or cell array, return a string matrix with one row
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
34 ## per element in @var{d}, padded with leading zeros to the width of the
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
35 ## largest value.
4492
819e3c246702 [project @ 2003-08-29 17:09:38 by jwe]
jwe
parents: 3791
diff changeset
36 ##
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
37 ## The optional second argument, @var{len}, specifies the minimum number of
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
38 ## digits in the result.
11172
7e8ce65f73cf Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
39 ## @seealso{bin2dec, dec2base, dec2hex}
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
40 ## @end deftypefn
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
41
3791
c1c532a0acb2 [project @ 2001-02-09 15:28:23 by jwe]
jwe
parents: 3789
diff changeset
42 ## Author: Daniel Calvelo <dcalvelo@yahoo.com>
4492
819e3c246702 [project @ 2003-08-29 17:09:38 by jwe]
jwe
parents: 3791
diff changeset
43 ## 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
44
11172
7e8ce65f73cf Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
45 function b = dec2bin (d, len)
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
46
4492
819e3c246702 [project @ 2003-08-29 17:09:38 by jwe]
jwe
parents: 3791
diff changeset
47 if (nargin == 1)
11172
7e8ce65f73cf Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
48 b = dec2base (d, 2);
4492
819e3c246702 [project @ 2003-08-29 17:09:38 by jwe]
jwe
parents: 3791
diff changeset
49 elseif (nargin == 2)
11172
7e8ce65f73cf Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
50 b = dec2base (d, 2, len);
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3426
diff changeset
51 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
52 print_usage ();
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
53 endif
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
54
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
55 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
56
13167
f7cb824dc8c0 Allow cellstr inputs for dec2* conversion functions.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
58 %!assert (dec2bin (14), "1110")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
59 %!assert (dec2bin (14, 6), "001110")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
60 %!assert (dec2bin ({1, 2; 3, 4}), ["001"; "011"; "010"; "100"])
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
61
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
62 ## Test input validation
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
63 %!error dec2bin ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
64 %!error dec2bin (1, 2, 3)
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
65