aboutsummaryrefslogtreecommitdiff
path: root/doc/language/function/cpsc-function-str_to_num.7.md
blob: acdf60b04d403227a522e597f3b478bc9ca64143 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

% CPSC-FUNCTION-STR_TO_NUM(7)

# NAME

cpsc-function-str_to_num - convert text to a real number

# SYNOPSIS

```text
STR_TO_NUM(text : STRING) RETURNS REAL
```

# DESCRIPTION

Provided by the standard string library, loaded and linked by default.

Return REAL, including for integer-looking text. The whole string must be consumed. Invalid text, trailing junk and values outside the REAL range throw a catchable exception. Use IS_NUM first to check numeric text without throwing for invalid input.

# EXAMPLE

```text
OUTPUT STR_TO_NUM("12.5")
```

# SEE ALSO

[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-is_num(7)](cpsc-function-is_num.7.md), [cpsc-function-num_to_str(7)](cpsc-function-num_to_str.7.md).