Mercurial > octave-nkf

comparison libinterp/corefcn/str2double.cc @ 17410:f47cfca56eb9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Rephrase a few sentences in str2double docstring. * libinterp/corefcn/str2double.cc: Rephrase a few sentences in str2double docstring.
author Rik <rik@octave.org>
date Wed, 11 Sep 2013 08:35:09 -0700
parents 3baf8e7ec3dd
children d63878346099
comparison
equal deleted inserted replaced
17409:3baf8e7ec3dd 17410:f47cfca56eb9
318 If present, a and/or b are of the form @nospell{[+-]d[,.]d[[eE][+-]d]} where\n\ 318 If present, a and/or b are of the form @nospell{[+-]d[,.]d[[eE][+-]d]} where\n\
319 the brackets indicate optional arguments and @qcode{'d'} indicates zero or\n\ 319 the brackets indicate optional arguments and @qcode{'d'} indicates zero or\n\
320 more digits. The special input values @code{Inf}, @code{NaN}, and @code{NA}\n\ 320 more digits. The special input values @code{Inf}, @code{NaN}, and @code{NA}\n\
321 are also accepted.\n\ 321 are also accepted.\n\
322 \n\ 322 \n\
323 @var{s} can be a character string, a character matrix or a cell array.\n\ 323 @var{s} may be a character string, character matrix, or cell array.\n\
324 For character arrays the conversion is repeated for every row, and\n\ 324 For character arrays the conversion is repeated for every row, and\n\
325 a double or complex array is returned in which rows corresponding to\n\ 325 a double or complex array is returned. Empty rows in @var{s} are deleted\n\
326 zero-length rows in @var{s} are deleted. In case of a cell array @var{s} each\n\ 326 and not returned in the numeric array. For cell arrays each character\n\
327 character string element is processed and a double or complex array of the\n\ 327 string element is processed and a double or complex array of the same\n\
328 same dimensions as @var{s} is returned.\n\ 328 dimensions as @var{s} is returned.\n\
329 \n\ 329 \n\
330 For unconvertible scalar or character string input @code{str2double} returns\n\ 330 For unconvertible scalar or character string input @code{str2double} returns\n\
331 a NaN. Similarly, for character array input @code{str2double} returns a NaN\n\ 331 a NaN@. Similarly, for character array input @code{str2double} returns a\n\
332 for any row of @var{s} that could not be converted. For a cell array\n\ 332 NaN for any row of @var{s} that could not be converted. For a cell array,\n\
333 @code{str2double} returns a NaN for any element of @var{s} for which\n\ 333 @code{str2double} returns a NaN for any element of @var{s} for which\n\
334 conversion fails, which includes numeric elements.\n\ 334 conversion fails. Note that numeric elements in a mixed string/numeric\n\
335 cell array are not strings and the conversion will fail for these elements\n\
336 and return NaN.\n\
335 \n\ 337 \n\
336 @code{str2double} can replace @code{str2num}, and it avoids the security\n\ 338 @code{str2double} can replace @code{str2num}, and it avoids the security\n\
337 risk of using @code{eval} on unknown data.\n\ 339 risk of using @code{eval} on unknown data.\n\
338 @seealso{str2num}\n\ 340 @seealso{str2num}\n\
339 @end deftypefn") 341 @end deftypefn")