Skip to content

ut: ztest: Port of remaining tests from test/cmocka/src/math/arithmetic - #10764

Merged
kv2019i merged 3 commits into
thesofproject:mainfrom
tmleman:topic/upstream/pr/unit_test/ztest/math/advanced_functions
May 13, 2026
Merged

ut: ztest: Port of remaining tests from test/cmocka/src/math/arithmetic#10764
kv2019i merged 3 commits into
thesofproject:mainfrom
tmleman:topic/upstream/pr/unit_test/ztest/math/advanced_functions

Conversation

@tmleman

@tmlemantmleman commented May 11, 2026

Copy link
Copy Markdown
Contributor

This PR contains the port of the last tests from category Advanced Math Functions. Porting is being done as part of #10110.

CopilotAI review requested due to automatic review settings May 11, 2026 13:28
@tmlemantmleman mentioned this pull request May 11, 2026
Open
2 tasks
CopilotAI reviewed May 11, 2026
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR continues the SOF unit test migration from CMocka to Zephyr’s ztest framework (issue #10110) by adding the remaining “Advanced Math Functions” tests (base-10 log, natural log, and square root) to the test/ztest/unit/math/advanced/functions suite.

Changes:

  • Add new ztest cases for log10_int32(), ln_int32(), and sofm_sqrt_int16().
  • Wire the new tests (and required SOF math sources) into the unit test CMake build.
  • Update the test metadata tags to reflect the newly covered functions.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file
FileDescription
test/ztest/unit/math/advanced/functions/testcase.yamlUpdates test tags to include newly added advanced-math coverage.
test/ztest/unit/math/advanced/functions/CMakeLists.txtAdds new test sources and links in required SOF math implementations.
test/ztest/unit/math/advanced/functions/test_square_root_ztest.cNew ztest for fixed-point square root against reference table.
test/ztest/unit/math/advanced/functions/test_base10_logarithm_ztest.cNew ztest for fixed-point base-10 log against reference table.
test/ztest/unit/math/advanced/functions/test_base_e_logarithm_ztest.cNew ztest for fixed-point natural log against reference table.

Comment threadtest/ztest/unit/math/advanced/functions/test_base10_logarithm_ztest.c Outdated
Comment threadtest/ztest/unit/math/advanced/functions/test_base10_logarithm_ztest.c
Comment threadtest/ztest/unit/math/advanced/functions/test_base_e_logarithm_ztest.c Outdated
Comment threadtest/ztest/unit/math/advanced/functions/test_square_root_ztest.c
Comment threadtest/ztest/unit/math/advanced/functions/test_square_root_ztest.c Outdated
Comment threadtest/ztest/unit/math/advanced/functions/test_square_root_ztest.c
Comment on lines +141 to +143
for (i = 0; i < ARRAY_SIZE(sqrt_ref_table); i++) {
y = (double)Q_CONVERT_QTOF(sofm_sqrt_int16(u[i]), 12);
diff = fabs(sqrt_ref_table[i] - y);

@lyakhlyakhMay 12, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wondering if we could just call sqrt(3) from libm instead of using a reference table?

@tmlemantmlemanMay 13, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current approach validates against MATLAB-generated reference table which is the established SOF pattern. This PR is just porting old test to new framework. Improvents can be done as follow-up.

@lgirdwoodlgirdwoodMay 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ack, so our maths library is optimized for speed/size and accuracy need for audio sample size rather than accuracy needed for double, so results could vary depending on the input. Lets not use generic maths library.

lgirdwood
lgirdwood approved these changes May 12, 2026
View reviewed changes

@lgirdwoodlgirdwood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but pls do resolve any copilot opens.

softwarecki
softwarecki reviewed May 12, 2026
View reviewed changes
Comment threadtest/ztest/unit/math/advanced/functions/test_square_root_ztest.c Outdated
Comment threadtest/ztest/unit/math/advanced/functions/test_square_root_ztest.c Outdated
@tmleman
tmlemanforce-pushed the topic/upstream/pr/unit_test/ztest/math/advanced_functions branch from 871e7cc to 997279bCompareMay 13, 2026 09:34
tmleman added 3 commits May 13, 2026 12:57
@tmleman
test: ztest: add square root unit test converted from CMock
9fad563
Convert the square root math unit test from CMock/CMocka to Ztest.
Port test_math_arithmetic_sqrt_fixed from
sof/test/cmocka/src/math/arithmetic/square_root.c
originally authored by Shriram Shastry <malladi.sastry@linux.intel.com>.
Preserve the original reference data and tolerance, add the new Ztest
source to the math advanced functions suite, and build
src/math/sqrt_int16.c.
Validated with west twister on native_sim using host/llvm.
Signed-off-by: Tomasz Leman <tomasz.m.leman@intel.com>
@tmleman
test: ztest: add base-10 logarithm unit test converted from CMock
d9848f9
Convert the base-10 logarithm math unit test from CMock/CMocka to Ztest.
Port test_math_arithmetic_base10log_fixed from
sof/test/cmocka/src/math/arithmetic/base_10_logarithm.c
originally authored by Shriram Shastry <malladi.sastry@linux.intel.com>.
Preserve the original reference data and tolerance, add the new Ztest
source to the math advanced functions suite, and build
src/math/log_10.c.
Validated with west twister on native_sim using host/llvm.
Signed-off-by: Tomasz Leman <tomasz.m.leman@intel.com>
@tmleman
test: ztest: add base-e logarithm unit test converted from CMock
997279b
Convert the natural (base-e) logarithm math unit test from CMock/CMocka
to Ztest.
Port test_math_arithmetic_base_e_log_fixed from
sof/test/cmocka/src/math/arithmetic/base_e_logarithm.c
originally authored by Shriram Shastry <malladi.sastry@linux.intel.com>.
Preserve the original reference data and tolerance, add the new Ztest
source to the math advanced functions suite, and build
src/math/log_e.c.
Validated with west twister on native_sim using host/llvm.
Signed-off-by: Tomasz Leman <tomasz.m.leman@intel.com>
lgirdwood
lgirdwood approved these changes May 13, 2026
View reviewed changes
Comment threadtest/ztest/unit/math/advanced/functions/test_square_root_ztest.c
Comment on lines +141 to +143
for (i = 0; i < ARRAY_SIZE(sqrt_ref_table); i++) {
y = (double)Q_CONVERT_QTOF(sofm_sqrt_int16(u[i]), 12);
diff = fabs(sqrt_ref_table[i] - y);

@lgirdwoodlgirdwoodMay 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ack, so our maths library is optimized for speed/size and accuracy need for audio sample size rather than accuracy needed for double, so results could vary depending on the input. Lets not use generic maths library.

@lgirdwood

lgirdwood commented May 13, 2026

Copy link
Copy Markdown
Member

@tmleman can you check CI. Thanks !

@tmleman

tmleman commented May 13, 2026

Copy link
Copy Markdown
ContributorAuthor

@tmleman can you check CI. Thanks !

Strange failure in tests with dmic. Definitely not caused by adding unit tests. I will trigger rerun.

@kv2019i
kv2019i merged commit 2896e23 into thesofproject:mainMay 13, 2026
43 of 44 checks passed
lgirdwood pushed a commit that referenced this pull request Jul 2, 2026
@tmleman@lgirdwood
cmocka: Remove square root tests
280fbeb
This patch removes the square root test that has been successfully
converted from cmocka to ztest.
The ztest equivalent is in test/ztest/unit/math/advanced/functions/
test_square_root_ztest.c and was merged in PR #10764.
Ztest coverage for sqrt_int16.c:
- lines: 100% (27/27)
- funcs: 100% (1/1)
Code coverage testing did not reveal any regression.
Signed-off-by: Tomasz Leman <tomasz.m.leman@intel.com>
lgirdwood pushed a commit that referenced this pull request Jul 2, 2026
@tmleman@lgirdwood
cmocka: Remove base-10 logarithm tests
cd6d2a1
This patch removes the base-10 logarithm test that has been successfully
converted from cmocka to ztest.
The ztest equivalent is in test/ztest/unit/math/advanced/functions/
test_base10_logarithm_ztest.c and was merged in PR #10764.
Ztest coverage for log_10.c:
- lines: 100% (2/2)
- funcs: 100% (1/1)
Code coverage testing did not reveal any regression.
Signed-off-by: Tomasz Leman <tomasz.m.leman@intel.com>
lgirdwood pushed a commit that referenced this pull request Jul 2, 2026
@tmleman@lgirdwood
cmocka: Remove base-e logarithm tests
e936c83
This patch removes the base-e logarithm test that has been successfully
converted from cmocka to ztest.
The ztest equivalent is in test/ztest/unit/math/advanced/functions/
test_base_e_logarithm_ztest.c and was merged in PR #10764.
Ztest coverage for log_e.c:
- lines: 100% (2/2)
- funcs: 100% (1/1)
Code coverage testing did not reveal any regression.
Signed-off-by: Tomasz Leman <tomasz.m.leman@intel.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lyakhlyakhlyakh left review comments
@softwareckisoftwareckisoftwarecki approved these changes
Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@lgirdwoodlgirdwoodlgirdwood approved these changes
@serhiy-katsyuba-intelserhiy-katsyuba-intelserhiy-katsyuba-intel approved these changes
@plbossartplbossartAwaiting requested review from plbossartplbossart is a code owner
@mmaka1mmaka1Awaiting requested review from mmaka1mmaka1 is a code owner
@lbetlejlbetlejAwaiting requested review from lbetlejlbetlej is a code owner
@dbalutadbalutaAwaiting requested review from dbalutadbaluta is a code owner
@kv2019ikv2019iAwaiting requested review from kv2019ikv2019i is a code owner
@abonislawskiabonislawskiAwaiting requested review from abonislawski
@wjablon1wjablon1Awaiting requested review from wjablon1
@singalsusingalsuAwaiting requested review from singalsu

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@tmleman@lgirdwood@lyakh@softwarecki@serhiy-katsyuba-intel@kv2019i