tomo-Num.rint.3

(36 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Num.rint 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Num.rint \- round to nearest integer
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Num.rint\ :\ func(x:\ Num\ ->\ Num)
  13 .fi
  14 .SH DESCRIPTION
  15 Rounds a number to the nearest integer, with ties rounded to the nearest even integer.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 x	Num	The number to be rounded. 
  26 .TE
  27 .SH RETURN
  28 The nearest integer value of `x`.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 assert (3.5).rint() == 4
  33 assert (2.5).rint() == 2
  34 .EE
  35 .SH SEE ALSO
  36 .BR Tomo-Num (3)