Skip to main content

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

fn __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))
@fieldwise_init
struct Bytes(DivModable):
var size: Int

fn __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, Movable, UnknownDestructibility

Methods

__copyinit__

__copyinit__(out self: _Self, existing: _Self, /)

Create a new instance of the value by copying an existing one.

Args:

  • existing (_Self): The value to copy.

Returns:

_Self

__moveinit__

__moveinit__(out self: _Self, var existing: _Self, /)

Create a new instance of the value by moving the value of another.

Args:

  • existing (_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.

Returns:

Tuple: A Tuple containing the quotient and the remainder.

Was this page helpful?