feat: add native addon to roundn and croundn #1009

steff456 · 2023-05-16T22:07:48Z

Part of https://github.com/stdlib-js/todo/issues/1454

Description

What is the purpose of this pull request?

This pull request:

For roundn API:

Adds C implementation
Adds native addon with benchmark, tests, examples and readme update

For croundn API:

Removes out keyword
Adds support for Complex128 dtype
Adds C implementation
Adds native addon with benchmark, tests, examples and readme update

Related Issues

Does this pull request have any related issues?

This pull request:

Part of https://github.com/stdlib-js/todo/issues/1454

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

…oundn API BREAKING CHANGE: out keyword is no longer supported and now the API uses Complex128 dtype as input and output

lib/node_modules/@stdlib/math/base/special/croundn/README.md

lib/node_modules/@stdlib/math/base/special/croundn/examples/index.js

lib/node_modules/@stdlib/math/base/special/croundn/manifest.json

lib/node_modules/@stdlib/math/base/special/croundn/test/test.js

lib/node_modules/@stdlib/math/base/special/croundn/test/test.native.js

lib/node_modules/@stdlib/math/base/special/roundn/include/stdlib/math/base/special/roundn.h

lib/node_modules/@stdlib/math/base/special/roundn/manifest.json

lib/node_modules/@stdlib/math/base/special/roundn/src/roundn.c

lib/node_modules/@stdlib/math/base/special/roundn/test/test.native.js

lib/node_modules/@stdlib/math/base/special/roundn/src/roundn.c

lib/node_modules/@stdlib/math/base/special/roundn/test/test.native.js

kgryte

Thanks, @steff456. Mainly just need to update descriptions and address some small comments.

lib/node_modules/@stdlib/math/base/special/croundn/lib/native.js

lib/node_modules/@stdlib/math/base/special/croundn/src/main.c

stdlib-bot · 2023-08-25T19:35:52Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/cceil	$\color{green}165/165$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}165/165$ $\color{green}+100.00\%$
math/base/special/ceil	$\color{green}157/157$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}157/157$ $\color{green}+100.00\%$
math/base/special/croundn	$\color{red}251/255$ $\color{green}+98.43\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}251/255$ $\color{green}+98.43\%$
math/base/special/roundn	$\color{red}276/279$ $\color{green}+98.92\%$	$\color{green}22/22$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}276/279$ $\color{green}+98.92\%$

The above coverage report was generated for the changes in this PR.

stdlib-bot · 2023-08-25T19:36:24Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/cceil	$\color{green}165/165$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}165/165$ $\color{green}+100.00\%$
math/base/special/ceil	$\color{green}157/157$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}157/157$ $\color{green}+100.00\%$
math/base/special/croundn	$\color{red}250/254$ $\color{green}+98.43\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}250/254$ $\color{green}+98.43\%$
math/base/special/roundn	$\color{red}276/279$ $\color{green}+98.92\%$	$\color{green}22/22$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}276/279$ $\color{green}+98.92\%$

The above coverage report was generated for the changes in this PR.

lib/node_modules/@stdlib/math/base/special/roundn/src/roundn.c

stdlib-bot · 2023-08-25T19:40:28Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/cceil	$\color{green}165/165$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}165/165$ $\color{green}+100.00\%$
math/base/special/ceil	$\color{green}157/157$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}157/157$ $\color{green}+100.00\%$
math/base/special/croundn	$\color{red}250/254$ $\color{green}+98.43\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}250/254$ $\color{green}+98.43\%$
math/base/special/roundn	$\color{red}276/279$ $\color{green}+98.92\%$	$\color{green}22/22$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}276/279$ $\color{green}+98.92\%$

The above coverage report was generated for the changes in this PR.

stdlib-bot · 2023-08-25T19:41:01Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/cceil	$\color{green}165/165$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}165/165$ $\color{green}+100.00\%$
math/base/special/ceil	$\color{green}157/157$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}157/157$ $\color{green}+100.00\%$
math/base/special/croundn	$\color{red}250/254$ $\color{green}+98.43\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}250/254$ $\color{green}+98.43\%$
math/base/special/roundn	$\color{red}276/279$ $\color{green}+98.92\%$	$\color{green}22/22$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}276/279$ $\color{green}+98.92\%$

The above coverage report was generated for the changes in this PR.

stdlib-bot · 2023-08-25T19:42:50Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/cceil	$\color{green}165/165$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}165/165$ $\color{green}+100.00\%$
math/base/special/ceil	$\color{green}157/157$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}157/157$ $\color{green}+100.00\%$
math/base/special/croundn	$\color{red}250/254$ $\color{green}+98.43\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}250/254$ $\color{green}+98.43\%$
math/base/special/roundn	$\color{red}276/279$ $\color{green}+98.92\%$	$\color{green}22/22$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}276/279$ $\color{green}+98.92\%$

The above coverage report was generated for the changes in this PR.

…ndn-addon

lib/node_modules/@stdlib/math/base/special/roundn/src/roundn.c

kgryte

LGTM. Thanks, @steff456!

stdlib-bot · 2023-08-25T19:48:20Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/cceil	$\color{green}165/165$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}165/165$ $\color{green}+100.00\%$
math/base/special/ceil	$\color{green}157/157$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}157/157$ $\color{green}+100.00\%$
math/base/special/croundn	$\color{red}250/254$ $\color{green}+98.43\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}250/254$ $\color{green}+98.43\%$
math/base/special/roundn	$\color{red}276/279$ $\color{green}+98.92\%$	$\color{green}22/22$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}276/279$ $\color{green}+98.92\%$

The above coverage report was generated for the changes in this PR.

stdlib-bot · 2023-08-25T19:49:06Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/cceil	$\color{green}165/165$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}165/165$ $\color{green}+100.00\%$
math/base/special/ceil	$\color{green}157/157$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}157/157$ $\color{green}+100.00\%$
math/base/special/croundn	$\color{red}250/254$ $\color{green}+98.43\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}250/254$ $\color{green}+98.43\%$
math/base/special/roundn	$\color{red}276/279$ $\color{green}+98.92\%$	$\color{green}22/22$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}276/279$ $\color{green}+98.92\%$

The above coverage report was generated for the changes in this PR.

lib/node_modules/@stdlib/math/base/special/croundn/docs/types/index.d.ts

lib/node_modules/@stdlib/math/base/special/roundn/src/roundn.c

stdlib-bot · 2023-08-25T20:04:02Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/cceil	$\color{green}165/165$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}165/165$ $\color{green}+100.00\%$
math/base/special/ceil	$\color{green}157/157$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}157/157$ $\color{green}+100.00\%$
math/base/special/croundn	$\color{red}250/254$ $\color{green}+98.43\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}250/254$ $\color{green}+98.43\%$
math/base/special/roundn	$\color{red}276/279$ $\color{green}+98.92\%$	$\color{green}22/22$ $\color{green}+100.00\%$	$\color{red}1/2$ $\color{green}+50.00\%$	$\color{red}276/279$ $\color{green}+98.92\%$

The above coverage report was generated for the changes in this PR.

Ref: #1009

steff456 added 3 commits May 16, 2023 15:53

remove: remove out keyword and add support for Complex128 dtype in cr…

043481f

…oundn API BREAKING CHANGE: out keyword is no longer supported and now the API uses Complex128 dtype as input and output

feat: add native addon and C implementation to roundn API

2c5c0d3

feat: add native addon and C implementation to croundn API

33c24d1

steff456 requested review from Planeshifter and kgryte May 16, 2023 22:07

steff456 self-assigned this May 16, 2023

steff456 added 2 commits July 11, 2023 16:35

fix: add self review changes

8c7e7ef

fix: fix manifest.json identation

6e975c0

kgryte added Math Issue or pull request specific to math functionality. Native Addons Issue involves or relates to Node.js native add-ons. labels Jul 21, 2023