Mojo trait
DivModable
The DivModable trait describes a type that defines division and modulo operations returning both quotient and remainder.
Types that conform to DivModable will work with the builtin divmod function,
which will return the same type as the inputs.
For example:
@fieldwise_init
struct Bytes(DivModable):
var size: Int
def __divmod__(self, other: Self) -> Tuple[Self, Self]:
var quotient_int = self.size // other.size
var remainder_int = self.size % other.size
return (Bytes(quotient_int), Bytes(remainder_int))Implemented traits
AnyType,
Copyable,
ImplicitlyCopyable,
ImplicitlyDestructible,
Movable
Required methods
__init__
__init__(out self: _Self, *, copy: _Self)
Create a new instance of the value by copying an existing one.
Args:
- copy (
_Self): The value to copy.
Returns:
_Self
__init__(out self: _Self, *, deinit take: _Self)
Create a new instance of the value by moving the value of another.
Args:
- take (
_Self): The value to move.
Returns:
_Self
__divmod__
__divmod__(self: _Self, denominator: _Self) -> Tuple[_Self, _Self]
Performs division and returns the quotient and the remainder.
Args:
- denominator (
_Self): The value to divide by.
Returns:
Tuple: A Tuple containing the quotient and the remainder.
Provided methods
copy
copy(self: _Self) -> _Self
Explicitly construct a copy of self, a convenience method for Self(copy=self) when the type is inconvenient to write out.
Returns:
_Self: A copy of this value.
Was this page helpful?
Thank you! We'll create more content like this.
Thank you for helping us improve!