aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Num.scientific.3
blob: aa10f2bc693034731607cdd39208596c22165439 (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
35
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Num.scientific 3 2025-04-21T14:54:02.047013 "Tomo man-pages"
.SH NAME
Num.scientific \- format in scientific notation
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.scientific\ :\ func(n:\ Num,\ precision:\ Int\ =\ 0\ ->\ Text)
.fi
.SH DESCRIPTION
Formats a number in scientific notation with a specified precision.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
n	Num	The number to be formatted. 	-
precision	Int	The number of decimal places. Default is `0`. 	0
.TE
.SH RETURN
A text representation of the number in scientific notation with the specified precision.

.SH EXAMPLES
.EX
>> (12345.6789).scientific(precision=2)
= "1.23e+04"
.EE