code / tomo

   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Num.floor 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Num.floor \- floor function
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Num.floor\ :\ func(x:\ Num\ ->\ Num)
  13 .fi
  14 .SH DESCRIPTION
  15 Rounds a number down to the nearest 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 down. 
  26 .TE
  27 .SH RETURN
  28 The largest integer less than or equal to `x`.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 assert (3.7).floor() == 3
  33 .EE
  34 .SH SEE ALSO
  35 .BR Tomo-Num (3)