aboutsummaryrefslogtreecommitdiff
path: root/doc/language/function/cpsc-function-is_num.7.md
blob: efb5f1ac024eed2b123ec0aded99ff0ad5f53180 (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-IS_NUM(7)

# NAME

cpsc-function-is_num - test whether text represents a number

# SYNOPSIS

```text
IS_NUM(text : STRING) RETURNS BOOLEAN
```

# DESCRIPTION

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

Return true for a nonempty string fully consumed by the runtime's numeric conversion. Leading whitespace is accepted; trailing whitespace or other trailing text is rejected.

# EXAMPLE

```text
OUTPUT IS_NUM("12.5")
```

# SEE ALSO

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