tomo-Int.sqrt.3

(36 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Int.sqrt 3 2026-01-19 "Tomo man-pages"
   6 .SH NAME
   7 Int.sqrt \- square root
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Int.sqrt\ :\ func(x:\ Int\ ->\ Int)
  13 .fi
  14 .SH DESCRIPTION
  15 Calculates the nearest square root of an 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	Int	The integer whose square root is to be calculated. 
  26 .TE
  27 .SH RETURN
  28 The integer part of the square root of `x`.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 assert 16.sqrt() == 4
  33 assert 17.sqrt() == 4
  34 .EE
  35 .SH SEE ALSO
  36 .BR Tomo-Int (3)