Mojo struct
IntLiteral
@register_passable(trivial)
struct IntLiteral[value: !pop.int_literal]
This type represents a static integer literal value with infinite precision. This type is a compile-time construct which stores its value as a parameter. It is typically materialized into other types (like Int) for use at runtime. This compile-time representation allows for arbitrary precision constants that would overflow on Int and other fixed precision integer types.
Parameters
- value (
!pop.int_literal): The underlying integer value.
Implemented traits
AnyType,
Boolable,
Ceilable,
CollectionElement,
Copyable,
ExplicitlyCopyable,
Floorable,
ImplicitlyBoolable,
ImplicitlyIntable,
Indexer,
Intable,
Movable,
Stringable,
Truncable,
UnknownDestructibility
Methods
__init__
__init__() -> Self
Constructor for any value.
__bool__
__bool__(self) -> Bool
Convert this IntLiteral to Bool.
Returns:
False Bool value if the value is equal to 0 and True otherwise.
__neg__
__neg__(self) -> IntLiteral[(0 - value)]
Return -self.
Returns:
The -self value.
__pos__
__pos__(self) -> Self
Return +self.
Returns:
The +self value.
__invert__
__invert__(self) -> IntLiteral[(value ^ -1)]
Return ~self.
Returns:
The ~self value.
__lt__
__lt__(self, rhs: IntLiteral[value]) -> Bool
Compare this IntLiteral to the RHS using LT comparison.
Args:
- rhs (
IntLiteral[value]): The other IntLiteral to compare against.
Returns:
True if this IntLiteral is less-than the RHS IntLiteral and False otherwise.
__le__
__le__(self, rhs: IntLiteral[value]) -> Bool
Compare this IntLiteral to the RHS using LE comparison.
Args:
- rhs (
IntLiteral[value]): The other IntLiteral to compare against.
Returns:
True if this IntLiteral is less-or-equal than the RHS IntLiteral and False otherwise.
__eq__
__eq__(self, rhs: IntLiteral[value]) -> Bool
Compare this IntLiteral to the RHS using EQ comparison.
Args:
- rhs (
IntLiteral[value]): The other IntLiteral to compare against.
Returns:
True if this IntLiteral is equal to the RHS IntLiteral and False otherwise.
__ne__
__ne__(self, rhs: IntLiteral[value]) -> Bool
Compare this IntLiteral to the RHS using NE comparison.
Args:
- rhs (
IntLiteral[value]): The other IntLiteral to compare against.
Returns:
True if this IntLiteral is non-equal to the RHS IntLiteral and False otherwise.
__gt__
__gt__(self, rhs: IntLiteral[value]) -> Bool
Compare this IntLiteral to the RHS using GT comparison.
Args:
- rhs (
IntLiteral[value]): The other IntLiteral to compare against.
Returns:
True if this IntLiteral is greater-than the RHS IntLiteral and False otherwise.
__ge__
__ge__(self, rhs: IntLiteral[value]) -> Bool
Compare this IntLiteral to the RHS using GE comparison.
Args:
- rhs (
IntLiteral[value]): The other IntLiteral to compare against.
Returns:
True if this IntLiteral is greater-or-equal than the RHS IntLiteral and False otherwise.
__add__
__add__(self, rhs: IntLiteral[value]) -> IntLiteral[(value + value)]
Return self + rhs.
Args:
- rhs (
IntLiteral[value]): The value to add.
Returns:
self + rhs value.
__sub__
__sub__(self, rhs: IntLiteral[value]) -> IntLiteral[(value - value)]
Return self - rhs.
Args:
- rhs (
IntLiteral[value]): The value to subtract.
Returns:
self - rhs value.
__mul__
__mul__(self, rhs: IntLiteral[value]) -> IntLiteral[(value * value)]
Return self * rhs.
Args:
- rhs (
IntLiteral[value]): The value to multiply with.
Returns:
self * rhs value.
__floordiv__
__floordiv__(self, rhs: IntLiteral[value]) -> IntLiteral[(value // value)]
Return self // rhs.
Args:
- rhs (
IntLiteral[value]): The value to divide with.
Returns:
self // rhs value.
__mod__
__mod__(self, rhs: IntLiteral[value]) -> IntLiteral[(value % value)]
Return the remainder of self divided by rhs.
Args:
- rhs (
IntLiteral[value]): The value to divide on.
Returns:
The remainder of dividing self by rhs.
__lshift__
__lshift__(self, rhs: IntLiteral[value]) -> IntLiteral[(value << value)]
Return self << rhs.
Args:
- rhs (
IntLiteral[value]): The value to shift with.
Returns:
self << rhs.
__rshift__
__rshift__(self, rhs: IntLiteral[value]) -> IntLiteral[(value >> value)]
Return self >> rhs.
Args:
- rhs (
IntLiteral[value]): The value to shift with.
Returns:
self >> rhs.
__and__
__and__(self, rhs: IntLiteral[value]) -> IntLiteral[(value & value)]
Return self & rhs.
Args:
- rhs (
IntLiteral[value]): The RHS value.
Returns:
self & rhs.
__or__
__or__(self, rhs: IntLiteral[value]) -> IntLiteral[(value | value)]
Return self | rhs.
Args:
- rhs (
IntLiteral[value]): The RHS value.
Returns:
self | rhs.
__xor__
__xor__(self, rhs: IntLiteral[value]) -> IntLiteral[(value ^ value)]
Return self ^ rhs.
Args:
- rhs (
IntLiteral[value]): The RHS value.
Returns:
self ^ rhs.
__as_bool__
__as_bool__(self) -> Bool
Convert this IntLiteral to Bool.
Returns:
False Bool value if the value is equal to 0 and True otherwise.
__int__
__int__(self) -> Int
Convert from IntLiteral to Int.
Returns:
The value as an integer of platform-specific width.
__as_int__
__as_int__(self) -> Int
Implicitly convert to an Int.
Returns:
An integral value that represents this object.
__uint__
__uint__(self) -> UInt
Convert from IntLiteral to UInt.
Returns:
The value as an unsigned integer of platform-specific width.
__ceil__
__ceil__(self) -> Self
Return the ceiling of the IntLiteral value, which is itself.
Returns:
The IntLiteral value itself.
__floor__
__floor__(self) -> Self
Return the floor of the IntLiteral value, which is itself.
Returns:
The IntLiteral value itself.
__trunc__
__trunc__(self) -> Self
Return the truncated of the IntLiteral value, which is itself.
Returns:
The IntLiteral value itself.
__str__
__str__(self) -> String
Convert from IntLiteral to String.
Returns:
The value as a string.
__ceildiv__
__ceildiv__(self, denominator: IntLiteral[value]) -> IntLiteral[(0 - (value // (0 - value)))]
Return the rounded-up result of dividing self by denominator.
Args:
- denominator (
IntLiteral[value]): The denominator.
Returns:
The ceiling of dividing numerator by denominator.
__index__
__index__(self) -> index
Convert from IntLiteral to index.
Returns:
The corresponding __mlir_type.index value, interpreting as signed.
Was this page helpful?
Thank you! We'll create more content like this.
Thank you for helping us improve!