matlab.unittest.TestCase.assertEqual — Assert equality and abort the current test on failure.
assertEqual(testCase, actual, expected) qualifies equality. RunMat records a failed assertion in the active test and stops that test.
Syntax
assertEqual(testCase, actual, expected, diagnostic...)Inputs
testCase- Type
Any- Required
- Yes
- Default
- —
- Description
- A TestCase object or subclass.
actual- Type
Any- Required
- Yes
- Default
- —
- Description
- Value being qualified.
expected- Type
Any- Required
- Yes
- Default
- —
- Description
- Expected value for equality qualification.
diagnostic- Type
Any- Required
- Variadic
- Default
- —
- Description
- Optional diagnostics; the first scalar text or Diagnostic message replaces the default failure text.
Returns
result- Type
Any- Description
- Empty double matrix on success; failures stop or filter the current test.
Errors
RunMat:Testing:InvalidTestCase- When
- The receiver is not a TestCase object or subclass.
- Message
first argument must be a matlab.unittest.TestCase
RunMat:Test:AssertionFailed- When
- An assertion fails; the active test is aborted after diagnostic recording, or an error is returned outside a test.
- Message
assertion failed
Equality and test lifecycle
RunMat checks the receiver as a TestCase or subclass, then compares actual and expected. A passing call returns an empty double matrix. A failing assertion records a diagnostic in an active test and aborts that test; a failing assumption records a diagnostic and filters that test.
This comparison is not yet the complete MATLAB equality contract. Scalar numeric comparisons currently convert to double, which can erase distinctions between wide integers. Additional MATLAB name-value tolerance options and complete custom-object comparison behavior are not implemented here.
Diagnostics
Optional diagnostic values are accepted after the required inputs. On failure, RunMat currently uses the first scalar string, character row, or Diagnostic object's Message as the failure message. Other diagnostic forms and full MATLAB diagnostic evaluation are not yet supported.
Examples
Continue after an equality assertion passes
testCase = matlab.unittest.TestCase();
result = assertEqual(testCase, 7, 7);Abort on unequal values
testCase = matlab.unittest.TestCase();
assertEqual(testCase, 7, 8);Using matlab.unittest.TestCase.assertEqual with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how matlab.unittest.TestCase.assertEqual changes the result.
Run a small matlab.unittest.TestCase.assertEqual example, explain the result, then change one input and compare the output.
Related Testing functions
Qualifications
matlab.unittest.TestCase.assertThat · matlab.unittest.TestCase.assertTrue · matlab.unittest.TestCase.assumeEqual · matlab.unittest.TestCase.assumeTrue · matlab.unittest.TestCase.fatalAssertTrue · matlab.unittest.TestCase.verifyEmpty · matlab.unittest.TestCase.verifyEqual · matlab.unittest.TestCase.verifyFalse · matlab.unittest.TestCase.verifyGreaterThan · matlab.unittest.TestCase.verifyLessThan · matlab.unittest.TestCase.verifyNotEmpty · matlab.unittest.TestCase.verifyNotEqual · matlab.unittest.TestCase.verifyThat · matlab.unittest.TestCase.verifyTrue
Testing
functiontests · matlab.unittest.TestCase · matlab.unittest.TestRunner.addPlugin · matlab.unittest.TestRunner.run · matlab.unittest.TestRunner.withTextOutput · testsuite
Constraints
matlab.unittest.constraints.IsEqualTo · matlab.unittest.constraints.IsFalse · matlab.unittest.constraints.IsTrue
Source you can read
Every RunMat function's source is public. Read exactly how matlab.unittest.TestCase.assertEqual is executed, line by line, in Rust.
- View the source for matlab.unittest.TestCase.assertEqual in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.