tomo-Int.hex.3

(38 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Int.hex 3 2026-01-19 "Tomo man-pages"
   6 .SH NAME
   7 Int.hex \- convert to hexidecimal
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Int.hex\ :\ func(i:\ Int,\ digits:\ Int\ =\ 0,\ uppercase:\ Bool\ =\ yes,\ prefix:\ Bool\ =\ yes\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Converts an integer to its hexadecimal representation.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 i	Int	The integer to be converted. 	-
  26 digits	Int	The minimum number of digits in the output string. 	0
  27 uppercase	Bool	Whether to use uppercase letters for hexadecimal digits. 	yes
  28 prefix	Bool	Whether to include a "0x" prefix. 	yes
  29 .TE
  30 .SH RETURN
  31 The hexadecimal string representation of the integer.
  32 
  33 .SH EXAMPLES
  34 .EX
  35 assert 255.hex(digits=4, uppercase=yes, prefix=yes) == "0x00FF"
  36 .EE
  37 .SH SEE ALSO
  38 .BR Tomo-Int (3)