{"route":"/en-US-v0.14.1/reference/foundations/float/","title":"Float","description":"Documentation for the Float type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"constructor","name":"Constructor","children":[{"id":"constructor-value","name":"value","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-is-nan","name":"Is Nan","children":[]},{"id":"definitions-is-infinite","name":"Is Infinite","children":[]},{"id":"definitions-signum","name":"Signum","children":[]},{"id":"definitions-from-bytes","name":"From Bytes","children":[{"id":"definitions-from-bytes-bytes","name":"bytes","children":[]},{"id":"definitions-from-bytes-endian","name":"endian","children":[]}]},{"id":"definitions-to-bytes","name":"To Bytes","children":[{"id":"definitions-to-bytes-endian","name":"endian","children":[]},{"id":"definitions-to-bytes-size","name":"size","children":[]}]}]}],"body":{"kind":"type","content":{"name":"float","title":"Float","keywords":[],"oneliner":"A floating-point number.","details":"

A floating-point number.

\n

A limited-precision representation of a real number. Typst uses 64 bits to\nstore floats. Wherever a float is expected, you can also pass an\ninteger.

\n

You can convert a value to a float with this type's constructor.

\n

NaN and positive infinity are available as float.nan and float.inf\nrespectively.

\n

Example

\n
#3.14 \\\n#1e4 \\\n#(10 / 4)\n
\"Preview\"
","constructor":{"path":[],"name":"float","title":"Construct","keywords":[],"oneliner":"Converts a value to a float.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Converts a value to a float.

\n"},{"kind":"example","content":{"body":"
#float(false) \\\n#float(true) \\\n#float(4) \\\n#float(40%) \\\n#float("2.7") \\\n#float("1e5")\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The value that should be converted to a float.

"}],"types":["bool","int","float","ratio","str","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},"scope":[{"path":["float"],"name":"is-nan","title":"Is Nan","keywords":[],"oneliner":"Checks if a float is not a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Checks if a float is not a number.

\n

In IEEE 754, more than one bit pattern represents a NaN. This function\nreturns true if the float is any of those bit patterns.

"},{"kind":"example","content":{"body":"
#float.is-nan(0) \\\n#float.is-nan(1) \\\n#float.is-nan(float.nan)\n
\"Preview\"
","title":null}}],"self":true,"params":[],"returns":["bool"],"scope":[]},{"path":["float"],"name":"is-infinite","title":"Is Infinite","keywords":[],"oneliner":"Checks if a float is infinite.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Checks if a float is infinite.

\n

Floats can represent positive infinity and negative infinity. This\nfunction returns true if the float is an infinity.

"},{"kind":"example","content":{"body":"
#float.is-infinite(0) \\\n#float.is-infinite(1) \\\n#float.is-infinite(float.inf)\n
\"Preview\"
","title":null}}],"self":true,"params":[],"returns":["bool"],"scope":[]},{"path":["float"],"name":"signum","title":"Signum","keywords":[],"oneliner":"Calculates the sign of a floating point number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the sign of a floating point number.

\n"},{"kind":"example","content":{"body":"
#(5.0).signum() \\\n#(-5.0).signum() \\\n#(0.0).signum() \\\n#float.nan.signum()\n
\"Preview\"
","title":null}}],"self":true,"params":[],"returns":["float"],"scope":[]},{"path":["float"],"name":"from-bytes","title":"From Bytes","keywords":[],"oneliner":"Interprets bytes as a float.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Interprets bytes as a float.

"},{"kind":"example","content":{"body":"
#float.from-bytes(bytes((0, 0, 0, 0, 0, 0, 240, 63))) \\\n#float.from-bytes(bytes((63, 240, 0, 0, 0, 0, 0, 0)), endian: "big")\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"bytes","details":[{"kind":"html","content":"

The bytes that should be converted to a float.

\n

Must have a length of either 4 or 8. The bytes are then\ninterpreted in IEEE 754's\nbinary32 (single-precision) or binary64 (double-precision) format\ndepending on the length of the bytes.

"}],"types":["bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"endian","details":[{"kind":"html","content":"

The endianness of the conversion.

"}],"types":["str"],"strings":[{"string":"big","details":"

Big-endian byte order: The highest-value byte is at the beginning of the\nbytes.

"},{"string":"little","details":"

Little-endian byte order: The lowest-value byte is at the beginning of\nthe bytes.

"}],"default":""little"","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["float"],"name":"to-bytes","title":"To Bytes","keywords":[],"oneliner":"Converts a float to bytes.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Converts a float to bytes.

"},{"kind":"example","content":{"body":"
#array(1.0.to-bytes(endian: "big")) \\\n#array(1.0.to-bytes())\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"endian","details":[{"kind":"html","content":"

The endianness of the conversion.

"}],"types":["str"],"strings":[{"string":"big","details":"

Big-endian byte order: The highest-value byte is at the beginning of the\nbytes.

"},{"string":"little","details":"

Little-endian byte order: The lowest-value byte is at the beginning of\nthe bytes.

"}],"default":""little"","positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"size","details":[{"kind":"html","content":"

The size of the resulting bytes.

\n

This must be either 4 or 8. The call will return the\nrepresentation of this float in either\nIEEE 754's binary32\n(single-precision) or binary64 (double-precision) format\ndepending on the provided size.

"}],"types":["int"],"strings":[],"default":"8","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["bytes"],"scope":[]}]}}}