tomo-Num.with_precision.3

(38 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Num.with_precision 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Num.with_precision \- round to a given precision
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Num.with_precision\ :\ func(n:\ Num,\ precision:\ Num\ ->\ Num)
  13 .fi
  14 .SH DESCRIPTION
  15 Round a number to the given precision level (specified as `10`, `.1`, `.001` etc).
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 n	Num	The number to be rounded to a given precision. 
  26 precision	Num	The precision to which the number should be rounded. 
  27 .TE
  28 .SH RETURN
  29 The number, rounded to the given precision level.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert (0.1234567).with_precision(0.01) == 0.12
  34 assert (123456.).with_precision(100) == 123500
  35 assert (1234567.).with_precision(5) == 1234565
  36 .EE
  37 .SH SEE ALSO
  38 .BR Tomo-Num (3)