aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Num.rint.3
blob: ca1f9bfa55cbd3f10b4ca27c481ba1ee564a6f80 (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
28
29
30
31
32
33
34
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Num.rint 3 2025-09-21 "Tomo man-pages"
.SH NAME
Num.rint \- round to nearest integer
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.rint\ :\ func(x:\ Num\ ->\ Num)
.fi
.SH DESCRIPTION
Rounds a number to the nearest integer, with ties rounded to the nearest even integer.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
x	Num	The number to be rounded. 	-
.TE
.SH RETURN
The nearest integer value of `x`.

.SH EXAMPLES
.EX
assert (3.5).rint() == 4
assert (2.5).rint() == 2
.EE