comparison scripts/strings/base2dec.m @ 11469:c776f063fefe

Overhaul m-script files to use common variable name between code and documentation.
author Rik <octave@nomad.inbox5.com>
date Sun, 09 Jan 2011 12:41:21 -0800
parents 7e8ce65f73cf
children fd0a3ac60b0e
comparison
equal deleted inserted replaced
11468:e1edf0ba3bcb 11469:c776f063fefe
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} base2dec (@var{s}, @var{b}) 20 ## @deftypefn {Function File} {} base2dec (@var{s}, @var{base})
21 ## Convert @var{s} from a string of digits in base @var{b} to a decimal 21 ## Convert @var{s} from a string of digits in base @var{base} to a decimal
22 ## integer (base 10). 22 ## integer (base 10).
23 ## 23 ##
24 ## @example 24 ## @example
25 ## @group 25 ## @group
26 ## base2dec ("11120", 3) 26 ## base2dec ("11120", 3)
31 ## 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
32 ## 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
33 ## corresponding value will be NaN@. Rows are right-justified before 33 ## corresponding value will be NaN@. Rows are right-justified before
34 ## converting so that trailing spaces are ignored. 34 ## converting so that trailing spaces are ignored.
35 ## 35 ##
36 ## If @var{b} is a string, the characters of @var{b} are used as the 36 ## If @var{base} is a string, the characters of @var{base} are used as the
37 ## 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
38 ## symbol. 38 ## symbol.
39 ## 39 ##
40 ## @example 40 ## @example
41 ## @group 41 ## @group