Mercurial > octave-antonio
comparison scripts/strings/dec2base.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 |
comparison
equal
deleted
inserted
replaced
| 20163:075a5e2e1ba5 | 20164:df437a52bcaf |
|---|---|
| 17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} dec2base (@var{d}, @var{base}) | 20 ## @deftypefn {Function File} {} dec2base (@var{d}, @var{base}) |
| 21 ## @deftypefnx {Function File} {} dec2base (@var{d}, @var{base}, @var{len}) | 21 ## @deftypefnx {Function File} {} dec2base (@var{d}, @var{base}, @var{len}) |
| 22 ## Return a string of symbols in base @var{base} corresponding to | 22 ## Return a string of symbols in base @var{base} corresponding to the |
| 23 ## the non-negative integer @var{d}. | 23 ## non-negative integer @var{d}. |
| 24 ## | 24 ## |
| 25 ## @example | 25 ## @example |
| 26 ## @group | 26 ## @group |
| 27 ## dec2base (123, 3) | 27 ## dec2base (123, 3) |
| 28 ## @result{} "11120" | 28 ## @result{} "11120" |
| 29 ## @end group | 29 ## @end group |
| 30 ## @end example | 30 ## @end example |
| 31 ## | 31 ## |
| 32 ## If @var{d} is a matrix or cell array, return a string matrix with one | 32 ## If @var{d} is a matrix or cell array, return a string matrix with one row |
| 33 ## row per element in @var{d}, padded with leading zeros to the width of | 33 ## per element in @var{d}, padded with leading zeros to the width of the |
| 34 ## the largest value. | 34 ## largest value. |
| 35 ## | 35 ## |
| 36 ## If @var{base} is a string then the characters of @var{base} are used as | 36 ## If @var{base} is a string then the characters of @var{base} are used as |
| 37 ## the symbols for the digits of @var{d}. Space (' ') may not be used | 37 ## the symbols for the digits of @var{d}. Space (' ') may not be used as a |
| 38 ## as a symbol. | 38 ## symbol. |
| 39 ## | 39 ## |
| 40 ## @example | 40 ## @example |
| 41 ## @group | 41 ## @group |
| 42 ## dec2base (123, "aei") | 42 ## dec2base (123, "aei") |
| 43 ## @result{} "eeeia" | 43 ## @result{} "eeeia" |
| 44 ## @end group | 44 ## @end group |
| 45 ## @end example | 45 ## @end example |
| 46 ## | 46 ## |
| 47 ## The optional third argument, @var{len}, specifies the minimum | 47 ## The optional third argument, @var{len}, specifies the minimum number of |
| 48 ## number of digits in the result. | 48 ## digits in the result. |
| 49 ## @seealso{base2dec, dec2bin, dec2hex} | 49 ## @seealso{base2dec, dec2bin, dec2hex} |
| 50 ## @end deftypefn | 50 ## @end deftypefn |
| 51 | 51 |
| 52 ## Author: Daniel Calvelo <dcalvelo@yahoo.com> | 52 ## Author: Daniel Calvelo <dcalvelo@yahoo.com> |
| 53 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> | 53 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> |