Difference between revisions of "ParseNum"

m (adding doc status category stub page)
 
Line 1: Line 1:
 +
[[Category:Text Functions]]
 +
[[Category:Data Type Functions]]
 
[[Category:Doc Status D]] <!-- For Lumina use, do not change -->
 
[[Category:Doc Status D]] <!-- For Lumina use, do not change -->
 +
 +
= ParseNum(x) =
 +
 +
Parses a string to a numeric value. 
 +
 +
= Library =
 +
 +
Flat File Library.ana
 +
 +
(Use '''File &rarr; Add Library...''' to add this library)
 +
 +
= Example =
 +
 +
ParseNum("3.14") &rarr; 3.14
 +
 +
= Notes =
 +
 +
If x is already numeric, x is returned.
 +
 +
An array can be passed, in which each cell of the array is parsed.
 +
 +
When x does not parse as a numeric value, such as ParseNum("hello"), the following error occurs:
 +
:''Evaluation Error: In the call to function Coerce_to_numeric, a value passed to the first parameter, x, could not be coerced to type Numeric, while evaluating function ParseNum.''
 +
 +
ParseNum is often useful when reading data from flat files, using [[ReadCsvFile]] or [[ReadTextFile]].
 +
 +
Coercion to numeric can be accomplished in Analytica in other ways.  For example, you can declare a function parameter with the [[Function Parameter Qualifiers|qualifiers]] "coerce numeric".  Then a string value passed to that parameter is parsed.  The calling variable needs to have a non-date number format, since the number format of the calling object determines how the value is interpreted.
 +
 +
= See Also =
 +
 +
* [[ParseDate]]
 +
* [[ReadTextFile]], [[ReadCsvFile]]

Revision as of 18:17, 1 August 2007


ParseNum(x)

Parses a string to a numeric value.

Library

Flat File Library.ana

(Use File → Add Library... to add this library)

Example

ParseNum("3.14") → 3.14

Notes

If x is already numeric, x is returned.

An array can be passed, in which each cell of the array is parsed.

When x does not parse as a numeric value, such as ParseNum("hello"), the following error occurs:

Evaluation Error: In the call to function Coerce_to_numeric, a value passed to the first parameter, x, could not be coerced to type Numeric, while evaluating function ParseNum.

ParseNum is often useful when reading data from flat files, using ReadCsvFile or ReadTextFile.

Coercion to numeric can be accomplished in Analytica in other ways. For example, you can declare a function parameter with the qualifiers "coerce numeric". Then a string value passed to that parameter is parsed. The calling variable needs to have a non-date number format, since the number format of the calling object determines how the value is interpreted.

See Also

Comments


You are not allowed to post comments.