aboutsummaryrefslogtreecommitdiff
path: root/doc/language/function/cpsc-function-str_to_num.7.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/language/function/cpsc-function-str_to_num.7.md')
-rw-r--r--doc/language/function/cpsc-function-str_to_num.7.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/language/function/cpsc-function-str_to_num.7.md b/doc/language/function/cpsc-function-str_to_num.7.md
new file mode 100644
index 0000000..341b757
--- /dev/null
+++ b/doc/language/function/cpsc-function-str_to_num.7.md
@@ -0,0 +1,28 @@
+% 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
+
+Return REAL, including for integer-looking text. Conversion can stop at
+trailing text; invalid text returns zero. Use IS_NUM first when the whole
+string must be a valid number.
+
+# 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).
+