DivModable | Modular

Mojo trait

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))

Implemented traits

AnyType, Copyable, ImplicitlyCopyable, ImplicitlyDestructible, Movable

comptime members

__copy_ctor_is_trivial

comptime __copy_ctor_is_trivial

A flag (often compiler generated) to indicate whether the implementation of the copy constructor is trivial.

A copy constructor is considered to be trivial if:

  • The struct has a compiler-generated trivial copy constructor because all its fields have trivial copy constructors.

In practice, it means the value can be copied by copying the bits from one location to another without side effects.

__del__is_trivial

comptime __del__is_trivial

A flag (often compiler generated) to indicate whether the implementation of __del__ is trivial.

The implementation of __del__ is considered to be trivial if:

  • The struct has a compiler-generated trivial destructor and all its fields have a trivial __del__ method.

In practice, it means that the __del__ can be considered as no-op.

__move_ctor_is_trivial

comptime __move_ctor_is_trivial

A flag (often compiler generated) to indicate whether the implementation of move constructor is trivial.

The implementation of a move constructor is considered to be trivial if:

  • The struct has a compiler-generated trivial move constructor because all its fields have trivial move constructors.

In practice, it means the value can be moved by moving the bits from one location to another without side effects.

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.