Mojo function

assert_equal

assert_equal[T: EqualityComparable & Stringable, //](lhs: T, rhs: T, msg: String = __init__[__mlir_type.!kgen.string](""), *, location: Optional[_SourceLocation] = Optional(None))

Asserts that the input values are equal. If it is not then an Error is raised.

Parameters:

T (EqualityComparable & Stringable): The type of the input values.

Args:

lhs (T): The lhs of the equality.
rhs (T): The rhs of the equality.
msg (String): The message to be printed if the assertion fails.
location (Optional[_SourceLocation]): The location of the error (defaults to __call_location).

Raises:

An Error with the provided message if assert fails and None otherwise.

assert_equal(lhs: String, rhs: String, msg: String = __init__[__mlir_type.!kgen.string](""), *, location: Optional[_SourceLocation] = Optional(None))

Asserts that the input values are equal. If it is not then an Error is raised.

Args:

lhs (String): The lhs of the equality.
rhs (String): The rhs of the equality.
msg (String): The message to be printed if the assertion fails.
location (Optional[_SourceLocation]): The location of the error (defaults to __call_location).

Raises:

An Error with the provided message if assert fails and None otherwise.

assert_equal[dtype: DType, size: Int](lhs: SIMD[dtype, size], rhs: SIMD[dtype, size], msg: String = __init__[__mlir_type.!kgen.string](""), *, location: Optional[_SourceLocation] = Optional(None))

Asserts that the input values are equal. If it is not then an Error is raised.

Parameters:

dtype (DType): The dtype of the left- and right-hand-side SIMD vectors.
size (Int): The width of the left- and right-hand-side SIMD vectors.

Args:

lhs (SIMD[dtype, size]): The lhs of the equality.
rhs (SIMD[dtype, size]): The rhs of the equality.
msg (String): The message to be printed if the assertion fails.
location (Optional[_SourceLocation]): The location of the error (defaults to __call_location).

Raises:

An Error with the provided message if assert fails and None otherwise.

assert_equal[T: Copyable & Movable & EqualityComparable & Representable, //](lhs: List[T], rhs: List[T], msg: String = __init__[__mlir_type.!kgen.string](""), *, location: Optional[_SourceLocation] = Optional(None))

Asserts that two lists are equal.

Parameters:

T (Copyable & Movable & EqualityComparable & Representable): The type of the elements in the lists.

Args:

lhs (List[T]): The left-hand side list.
rhs (List[T]): The right-hand side list.
msg (String): The message to be printed if the assertion fails.
location (Optional[_SourceLocation]): The location of the error (defaults to __call_location).

Raises:

An Error with the provided message if assert fails and None otherwise.

assert_equal[O1: ImmutableOrigin, O2: ImmutableOrigin](lhs: List[StringSlice[O1]], rhs: List[StringSlice[O2]], msg: String = __init__[__mlir_type.!kgen.string](""), *, location: Optional[_SourceLocation] = Optional(None))

Asserts that two lists are equal.

Parameters:

O1 (ImmutableOrigin): The origin of lhs.
O2 (ImmutableOrigin): The origin of rhs.

Args:

lhs (List[StringSlice[O1]]): The left-hand side list.
rhs (List[StringSlice[O2]]): The right-hand side list.
msg (String): The message to be printed if the assertion fails.
location (Optional[_SourceLocation]): The location of the error (defaults to __call_location).

Raises:

An Error with the provided message if assert fails and None otherwise.

assert_equal[D: DType](lhs: List[SIMD[D, 1]], rhs: List[SIMD[D, 1]], msg: String = __init__[__mlir_type.!kgen.string](""), *, location: Optional[_SourceLocation] = Optional(None))

Asserts that two lists are equal.

Parameters:

D (DType): A DType.

Args:

lhs (List[SIMD[D, 1]]): The left-hand side list.
rhs (List[SIMD[D, 1]]): The right-hand side list.
msg (String): The message to be printed if the assertion fails.
location (Optional[_SourceLocation]): The location of the error (defaults to __call_location).

Raises:

An Error with the provided message if assert fails and None otherwise.

assert_equal(lhs: PythonObject, rhs: PythonObject, msg: String = __init__[__mlir_type.!kgen.string](""), *, location: Optional[_SourceLocation] = Optional(None))

Asserts that the input values are equal. If it is not then an Error is raised.

Args:

lhs (PythonObject): The lhs of the equality.
rhs (PythonObject): The rhs of the equality.
msg (String): The message to be printed if the assertion fails.
location (Optional[_SourceLocation]): The location of the error (default to the __call_location).

Raises:

An Error with the provided message if assert fails.