Mercurial > hg > octave-lyh
comparison scripts/strings/base2dec.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | 58604c45ca74 |
children | 952d4df5b686 |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
20 ## @deftypefn {Function File} {} base2dec (@var{s}, @var{b}) | 20 ## @deftypefn {Function File} {} base2dec (@var{s}, @var{b}) |
21 ## Convert @var{s} from a string of digits of base @var{b} into an | 21 ## Convert @var{s} from a string of digits of base @var{b} into an |
22 ## integer. | 22 ## integer. |
23 ## | 23 ## |
24 ## @example | 24 ## @example |
25 ## @group | |
25 ## base2dec ("11120", 3) | 26 ## base2dec ("11120", 3) |
26 ## @result{} 123 | 27 ## @result{} 123 |
28 ## @end group | |
27 ## @end example | 29 ## @end example |
28 ## | 30 ## |
29 ## If @var{s} is a matrix, returns a column vector with one value per | 31 ## If @var{s} is a matrix, returns a column vector with one value per |
30 ## row of @var{s}. If a row contains invalid symbols then the | 32 ## row of @var{s}. If a row contains invalid symbols then the |
31 ## corresponding value will be NaN. Rows are right-justified before | 33 ## corresponding value will be NaN. Rows are right-justified before |
34 ## If @var{b} is a string, the characters of @var{b} are used as the | 36 ## If @var{b} is a string, the characters of @var{b} are used as the |
35 ## symbols for the digits of @var{s}. Space (' ') may not be used as a | 37 ## symbols for the digits of @var{s}. Space (' ') may not be used as a |
36 ## symbol. | 38 ## symbol. |
37 ## | 39 ## |
38 ## @example | 40 ## @example |
41 ## @group | |
39 ## base2dec ("yyyzx", "xyz") | 42 ## base2dec ("yyyzx", "xyz") |
40 ## @result{} 123 | 43 ## @result{} 123 |
44 ## @end group | |
41 ## @end example | 45 ## @end example |
42 ## @seealso{dec2base, dec2bin, bin2dec, hex2dec, dec2hex} | 46 ## @seealso{dec2base, dec2bin, bin2dec, hex2dec, dec2hex} |
43 ## @end deftypefn | 47 ## @end deftypefn |
44 | 48 |
45 ## Author: Daniel Calvelo <dcalvelo@yahoo.com> | 49 ## Author: Daniel Calvelo <dcalvelo@yahoo.com> |