tomo-Num.parse.3

(41 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Num.parse 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Num.parse \- convert text to number
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Num.parse\ :\ func(text:\ Text,\ remainder:\ &Text?\ =\ none\ ->\ Num?)
  13 .fi
  14 .SH DESCRIPTION
  15 Converts a text representation of a number into a floating-point number.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 text	Text	The text containing the number. 	-
  26 remainder	&Text?	If non-none, this argument will be set to the remainder of the text after the matching part. If none, parsing will only succeed if the entire text matches. 	none
  27 .TE
  28 .SH RETURN
  29 The number represented by the text or `none` if the entire text can't be parsed as a number.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert Num.parse("3.14") == 3.14
  34 assert Num.parse("1e3") == 1000
  35 assert Num.parse("1.5junk") == none
  36 remainder : Text
  37 assert Num.parse("1.5junk", &remainder) == 1.5
  38 assert remainder == "junk"
  39 .EE
  40 .SH SEE ALSO
  41 .BR Tomo-Num (3)