{"route":"/en-US-v0.14.1/reference/foundations/int/","title":"Integer","description":"Documentation for the Integer 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-signum","name":"Signum","children":[]},{"id":"definitions-bit-not","name":"Bitwise NOT","children":[]},{"id":"definitions-bit-and","name":"Bitwise AND","children":[{"id":"definitions-bit-and-rhs","name":"rhs","children":[]}]},{"id":"definitions-bit-or","name":"Bitwise OR","children":[{"id":"definitions-bit-or-rhs","name":"rhs","children":[]}]},{"id":"definitions-bit-xor","name":"Bitwise XOR","children":[{"id":"definitions-bit-xor-rhs","name":"rhs","children":[]}]},{"id":"definitions-bit-lshift","name":"Bitwise Left Shift","children":[{"id":"definitions-bit-lshift-shift","name":"shift","children":[]}]},{"id":"definitions-bit-rshift","name":"Bitwise Right Shift","children":[{"id":"definitions-bit-rshift-shift","name":"shift","children":[]},{"id":"definitions-bit-rshift-logical","name":"logical","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-from-bytes-signed","name":"signed","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":"int","title":"Integer","keywords":[],"oneliner":"A whole number.","details":"

A whole number.

\n

The number can be negative, zero, or positive. As Typst uses 64 bits to\nstore integers, integers cannot be smaller than -9223372036854775808 or\nlarger than 9223372036854775807. Integer literals are always positive,\nso a negative integer such as -1 is semantically the negation - of the\npositive literal 1. A positive integer greater than the maximum value and\na negative integer less than or equal to the minimum value cannot be\nrepresented as an integer literal, and are instead parsed as a float.\nThe minimum integer value can still be obtained through integer arithmetic.

\n

The number can also be specified as hexadecimal, octal, or binary by\nstarting it with a zero followed by either x, o, or b.

\n

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

\n

Example

\n
#(1 + 2) \\\n#(2 - 5) \\\n#(3 + 4 < 8)\n\n#0xff \\\n#0o10 \\\n#0b1001\n
\"Preview\"
","constructor":{"path":[],"name":"int","title":"Construct","keywords":[],"oneliner":"Converts a value to an integer.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Converts a value to an integer. Raises an error if there is an attempt\nto produce an integer larger than the maximum 64-bit signed integer\nor smaller than the minimum 64-bit signed integer.

\n"},{"kind":"example","content":{"body":"
#int(false) \\\n#int(true) \\\n#int(2.7) \\\n#int(decimal("3.8")) \\\n#(int("27") + int("4"))\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The value that should be converted to an integer.

"}],"types":["bool","int","float","str","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},"scope":[{"path":["int"],"name":"signum","title":"Signum","keywords":[],"oneliner":"Calculates the sign of an integer.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the sign of an integer.

\n"},{"kind":"example","content":{"body":"
#(5).signum() \\\n#(-5).signum() \\\n#(0).signum()\n
\"Preview\"
","title":null}}],"self":true,"params":[],"returns":["int"],"scope":[]},{"path":["int"],"name":"bit-not","title":"Bitwise NOT","keywords":[],"oneliner":"Calculates the bitwise NOT of an integer.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the bitwise NOT of an integer.

\n

For the purposes of this function, the operand is treated as a signed\ninteger of 64 bits.

"},{"kind":"example","content":{"body":"
#4.bit-not() \\\n#(-1).bit-not()\n
\"Preview\"
","title":null}}],"self":true,"params":[],"returns":["int"],"scope":[]},{"path":["int"],"name":"bit-and","title":"Bitwise AND","keywords":[],"oneliner":"Calculates the bitwise AND between two integers.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the bitwise AND between two integers.

\n

For the purposes of this function, the operands are treated as signed\nintegers of 64 bits.

"},{"kind":"example","content":{"body":"
#128.bit-and(192)\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"rhs","details":[{"kind":"html","content":"

The right-hand operand of the bitwise AND.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["int"],"name":"bit-or","title":"Bitwise OR","keywords":[],"oneliner":"Calculates the bitwise OR between two integers.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the bitwise OR between two integers.

\n

For the purposes of this function, the operands are treated as signed\nintegers of 64 bits.

"},{"kind":"example","content":{"body":"
#64.bit-or(32)\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"rhs","details":[{"kind":"html","content":"

The right-hand operand of the bitwise OR.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["int"],"name":"bit-xor","title":"Bitwise XOR","keywords":[],"oneliner":"Calculates the bitwise XOR between two integers.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the bitwise XOR between two integers.

\n

For the purposes of this function, the operands are treated as signed\nintegers of 64 bits.

"},{"kind":"example","content":{"body":"
#64.bit-xor(96)\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"rhs","details":[{"kind":"html","content":"

The right-hand operand of the bitwise XOR.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["int"],"name":"bit-lshift","title":"Bitwise Left Shift","keywords":[],"oneliner":"Shifts the operand's bits to the left by the specified amount.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Shifts the operand's bits to the left by the specified amount.

\n

For the purposes of this function, the operand is treated as a signed\ninteger of 64 bits. An error will occur if the result is too large to\nfit in a 64-bit integer.

"},{"kind":"example","content":{"body":"
#33.bit-lshift(2) \\\n#(-1).bit-lshift(3)\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"shift","details":[{"kind":"html","content":"

The amount of bits to shift. Must not be negative.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["int"],"name":"bit-rshift","title":"Bitwise Right Shift","keywords":[],"oneliner":"Shifts the operand's bits to the right by the specified amount.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Shifts the operand's bits to the right by the specified amount.\nPerforms an arithmetic shift by default (extends the sign bit to the left,\nsuch that negative numbers stay negative), but that can be changed by the\nlogical parameter.

\n

For the purposes of this function, the operand is treated as a signed\ninteger of 64 bits.

"},{"kind":"example","content":{"body":"
#64.bit-rshift(2) \\\n#(-8).bit-rshift(2) \\\n#(-8).bit-rshift(2, logical: true)\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"shift","details":[{"kind":"html","content":"

The amount of bits to shift. Must not be negative.

\n

Shifts larger than 63 are allowed and will cause the return value to\nsaturate. For non-negative numbers, the return value saturates at\n0, while, for negative numbers, it saturates at -1 if\nlogical is set to false, or 0 if it is true. This\nbehavior is consistent with just applying this operation multiple\ntimes. Therefore, the shift will always succeed.

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

Toggles whether a logical (unsigned) right shift should be performed\ninstead of arithmetic right shift.\nIf this is true, negative operands will not preserve their sign\nbit, and bits which appear to the left after the shift will be\n0. This parameter has no effect on non-negative operands.

"}],"types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["int"],"name":"from-bytes","title":"From Bytes","keywords":[],"oneliner":"Converts bytes to an integer.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Converts bytes to an integer.

"},{"kind":"example","content":{"body":"
#int.from-bytes(bytes((0, 0, 0, 0, 0, 0, 0, 1))) \\\n#int.from-bytes(bytes((1, 0, 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 an integer.

\n

Must be of length at most 8 so that the result fits into a 64-bit\nsigned integer.

"}],"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},{"name":"signed","details":[{"kind":"html","content":"

Whether the bytes should be treated as a signed integer. If this is\ntrue and the most significant bit is set, the resulting number\nwill negative.

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

Converts an integer to bytes.

"},{"kind":"example","content":{"body":"
#array(10000.to-bytes(endian: "big")) \\\n#array(10000.to-bytes(size: 4))\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 in bytes of the resulting bytes (must be at least zero). If\nthe integer is too large to fit in the specified size, the\nconversion will truncate the remaining bytes based on the\nendianness. To keep the same resulting value, if the endianness is\nbig-endian, the truncation will happen at the rightmost bytes.\nOtherwise, if the endianness is little-endian, the truncation will\nhappen at the leftmost bytes.

\n

Be aware that if the integer is negative and the size is not enough\nto make the number fit, when passing the resulting bytes to\nint.from-bytes, the resulting number might be positive, as the\nmost significant bit might not be set to 1.

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