Skip to main content

/

Docs

Nightly

v24.6

Log in

Mojo function

assert_equal

assert_equal[T: Testable](lhs: T, rhs: T, msg: String = String(""), *, location: Optional[_SourceLocation] = Optional(None))

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

Parameters:

  • ​T (Testable): A Testable type.

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 (default to the __call_location).

Raises:

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

assert_equal(lhs: String, rhs: String, msg: String = 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 (default to the __call_location).

Raises:

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

assert_equal[type: DType, size: Int](lhs: SIMD[type, size], rhs: SIMD[type, size], msg: String = String(""), *, location: Optional[_SourceLocation] = Optional(None))

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

Parameters:

  • ​type (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[type, size]): The lhs of the equality.
  • ​rhs (SIMD[type, 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 (default to the __call_location).

Raises:

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

assert_equal[T: TestableCollectionElement](lhs: List[T], rhs: List[T], msg: String = String(""), *, location: Optional[_SourceLocation] = Optional(None))

Asserts that two lists are equal.

Parameters:

  • ​T (TestableCollectionElement): A TestableCollectionElement type.

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 (default to the __call_location).

Raises:

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