float
A floating-point number.
A limited-precision representation of a real number. Typst uses 64 bits to store floats. Wherever a float is expected, you can also pass an integer.
You can convert a value to a float with this type's constructor.
NaN and positive infinity are available as float.nan and float.inf
respectively.
Example
#3.14 \
#1e4 \
#(10 / 4)
ConstructorParameterParameters are input values for functions. Specify them in parentheses after the function name.
Converts a value to a float.
- Booleans are converted to
0.0or1.0. - Integers are converted to the closest 64-bit float. For integers with
absolute value less than
calc.pow(2, 53), this conversion is exact. - Ratios are divided by 100%.
- Strings are parsed in base 10 to the closest 64-bit float. Exponential notation is supported.
#float(false) \
#float(true) \
#float(4) \
#float(40%) \
#float("2.7") \
#float("1e5")
DefinitionDefinitionThese functions and types can have related definitions. To access a definition, specify the name of the function or type, followed by the definition name separated by a period.
is-nan
Checks if a float is not a number.
In IEEE 754, more than one bit pattern represents a NaN. This function
returns true if the float is any of those bit patterns.
Show example
#float.is-nan(0) \
#float.is-nan(1) \
#float.is-nan(float.nan)
is-infinite
Checks if a float is infinite.
Floats can represent positive infinity and negative infinity. This
function returns true if the float is an infinity.
Show example
#float.is-infinite(0) \
#float.is-infinite(1) \
#float.is-infinite(float.inf)
signum
Calculates the sign of a floating point number.
- If the number is positive (including
+0.0), returns1.0. - If the number is negative (including
-0.0), returns-1.0. - If the number is NaN, returns
float.nan.
Show example
#(5.0).signum() \
#(-5.0).signum() \
#(0.0).signum() \
#float.nan.signum()
from-bytes
Interprets bytes as a float.
Show example
#float.from-bytes(bytes((0, 0, 0, 0, 0, 0, 240, 63))) \
#float.from-bytes(bytes((63, 240, 0, 0, 0, 0, 0, 0)), endian: "big")
bytesRequiredRequiredRequired parameters must be specified when calling the function.PositionalPositionalPositional parameters can be set by specifying them in order, omitting the parameter name.
The bytes that should be converted to a float.
Must have a length of either 4 or 8. The bytes are then interpreted in IEEE 754's binary32 (single-precision) or binary64 (double-precision) format depending on the length of the bytes.
endian
The endianness of the conversion.
Available string values:
bigBig-endian byte order: The highest-value byte is at the beginning of the bytes.
littleLittle-endian byte order: The lowest-value byte is at the beginning of the bytes.
Default value: "little"
to-bytes
Converts a float to bytes.
Show example
#array(1.0.to-bytes(endian: "big")) \
#array(1.0.to-bytes())
endian
The endianness of the conversion.
Available string values:
bigBig-endian byte order: The highest-value byte is at the beginning of the bytes.
littleLittle-endian byte order: The lowest-value byte is at the beginning of the bytes.
Default value: "little"