feat: add `napi/argv-complex128` #1445

PoookieCoder · 2024-03-02T08:48:50Z

Resolves #816 .

Description

What is the purpose of this pull request?

This pull request adds C APIs for converting a JavaScript Complex128 object instance to a native C data type stdlib_complex128_t.

Related Issues

Does this pull request have any related issues?

This pull request:

resolves [RFC]: Add @stdlib/napi/argv-complex128 #816

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.

After the review of this PR, the #817 issue can be resolved easily. I will open a PR for the same.

Checklist

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

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

kgryte · 2024-03-02T12:15:16Z

lib/node_modules/@stdlib/napi/argv-complex128/src/main.c

+	stdlib_assert_napi_value_is_type( env, value, napi_object, message, err );
+	if ( *err != NULL ) {
+		return napi_ok;
+	}
+	STDLIB_ASSERT_NAPI_STATUS_OK_RET_VALUE( env, napi_get_property( env, value, re, &real ), "", napi_ok )
+	STDLIB_ASSERT_NAPI_STATUS_OK_RET_VALUE( env, napi_get_property( env, value, im, &imaginary ), "", napi_ok )
+	*out = stdlib_complex128( real, imaginary );


This can be improved. E.g., see

stdlib/lib/node_modules/@stdlib/math/base/napi/binary/src/main.c

Line 168 in 615bcf1

napi_value stdlib_math_base_napi_zz_z( napi_env env, napi_callback_info info, stdlib_complex128_t (*fcn)( stdlib_complex128_t, stdlib_complex128_t ) ) {

for reference.

You state that the input value must be a Complex128 instance. We should relax that requirement. We should allow any object coming from JS with a real and imaginary component (may be either an "own" or "inherited" property).

You don't validate that the real and imaginary components are numeric.

You need to unwrap the real and imaginary components before passing to stdlib_complex128. E.g.,

stdlib/lib/node_modules/@stdlib/math/base/napi/binary/src/main.c

Line 268 in 615bcf1

status = napi_get_value_double( env, xre, &re0 );

.

PR-URL: stdlib-js#1443 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

PR-URL: stdlib-js#1446 Closes: stdlib-js#775 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

PR-URL: stdlib-js#1430 Closes: stdlib-js#1332 --------- Signed-off-by: Rejoan Sardar <[email protected]> Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

PR-URL: stdlib-js#1442 Closes: stdlib-js#1432 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

PR-URL: stdlib-js#1372 Closes: stdlib-js#1324 Signed-off-by: Utkarsh <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]> Reviewed-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#1462 Signed-off-by: stdlib-bot <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1461 Signed-off-by: stdlib-bot <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1654 Signed-off-by: stdlib-bot <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1456 Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1457 Closes: stdlib-js#1449 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

PR-URL: stdlib-js#1657 Resolves: stdlib-js#1653 --------- Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1454 Closes: stdlib-js#1453 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

PR-URL: stdlib-js#1667 Closes: stdlib-js#1666 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

…entions Closes: stdlib-js#1434 Ref: stdlib-js#1152 PR-URL: stdlib-js#1455 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Snehil Shah <[email protected]> Signed-off-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#1677 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]>

PR-URL: stdlib-js#1676 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]>

PR-URL: stdlib-js#1348 Closes: stdlib-js#1337 --------- Signed-off-by: Aditya Sapra <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: Athan Reines <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

…egative test values PR-URL: stdlib-js#1458 Signed-off-by: Snehil Shah <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

Closes: stdlib-js#1668 PR-URL: stdlib-js#1670 Co-authored-by: Athan Reines <[email protected]> Co-authored-by: Pranav Goswami <[email protected]> Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Pranav Goswami <[email protected]> Signed-off-by: Pranav Goswami <[email protected]> Signed-off-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#1709 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]>

PR-URL: stdlib-js#1685 Closes: stdlib-js#754 --------- Signed-off-by: Lovelin <[email protected]> Reviewed-by: Pranav Goswami <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1447 Closes: stdlib-js#852 --------- Signed-off-by: Anudeep Sanapala <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: stdlib-bot <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1463 Closes: stdlib-js#1327 --------- Signed-off-by: Athan Reines <[email protected]> Signed-off-by: Aditya Sapra <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: Athan Reines <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

style: add empty line

PR-URL: stdlib-js#1725 Signed-off-by: stdlib-bot <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1726 Reviewed-by: Athan Reines <[email protected]>

Closes: stdlib-js#1718 PR-URL: stdlib-js#1730 Reviewed-by: Athan Reines <[email protected]>

Closes: stdlib-js#772 PR-URL: stdlib-js#1452 Co-authored-by: Athan Reines <[email protected]> Co-authored-by: Pranav Goswami <[email protected]> Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Pranav Goswami <[email protected]> Signed-off-by: GUNJ JOSHI <[email protected]> Signed-off-by: Pranav Goswami <[email protected]>

Ref: stdlib-js#1452

PR-URL: stdlib-js#1349 Closes: stdlib-js#1321 --------- Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Pranav Goswami <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1728 Closes: stdlib-js#1645 Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1719 Closes: stdlib-js#1714 --------- Signed-off-by: Snehil Shah <[email protected]> Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1731 Closes: stdlib-js#1721 --------- Signed-off-by: Snehil Shah <[email protected]> Co-authored-by: Pranavchiku <[email protected]> Reviewed-by: Pranavchiku <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#1737 Signed-off-by: stdlib-bot <[email protected]> Co-authored-by: Planeshifter <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

…ex128

Utkarsh Gupta added 2 commits March 2, 2024 14:17

init

1faaaa6

added stdlib/napi/argv-complex128

1d45338

Pranavchiku mentioned this pull request Mar 2, 2024

[RFC]: Add C implementation for @stdlib/math/base/special/ellipe #1444

Closed

3 tasks

PoookieCoder changed the title ~~feat/@stdlib/napi/argv complex128~~ feat: add @stdlib/napi/argv-complex128 Mar 2, 2024

kgryte added Needs Review A pull request which needs code review. Native Addons Issue involves or relates to Node.js native add-ons. C Issue involves or relates to C. labels Mar 2, 2024

kgryte changed the title ~~feat: add @stdlib/napi/argv-complex128~~ feat: add napi/argv-complex128 Mar 2, 2024

kgryte added Feature Issue or pull request for adding a new feature. Utilities Issue or pull request concerning general utilities. labels Mar 2, 2024

kgryte reviewed Mar 2, 2024

View reviewed changes

kgryte added the Needs Changes Pull request which needs changes before being merged. label Mar 2, 2024

aman-095 and others added 18 commits March 7, 2024 07:30

feat: add C implementation for math/base/special/min

70e0cb7

PR-URL: stdlib-js#1443 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

feat: add C implementation for math/base/special/acovercos

83c859c

PR-URL: stdlib-js#1446 Closes: stdlib-js#775 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

feat: add complex/parse-float32

a5f357d

PR-URL: stdlib-js#1430 Closes: stdlib-js#1332 --------- Signed-off-by: Rejoan Sardar <[email protected]> Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

feat: add C implementation for math/base/special/logaddexp

da16b86

PR-URL: stdlib-js#1442 Closes: stdlib-js#1432 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

chore: update package meta data

1e5ba13

PR-URL: stdlib-js#1462 Signed-off-by: stdlib-bot <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

feat: update error databases

f1f463b

PR-URL: stdlib-js#1461 Signed-off-by: stdlib-bot <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

docs: update list of contributors

aa7d38a

PR-URL: stdlib-js#1654 Signed-off-by: stdlib-bot <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

docs: update REPL namespace documentation

19f8b0b

PR-URL: stdlib-js#1456 Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]>

feat: add C implementation for math/base/special/minabs

c0e5361

PR-URL: stdlib-js#1457 Closes: stdlib-js#1449 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

docs: improve time/base README Examples

739ae39

PR-URL: stdlib-js#1657 Resolves: stdlib-js#1653 --------- Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

feat: add C implementation for math/base/special/log

ef37a9f

PR-URL: stdlib-js#1454 Closes: stdlib-js#1453 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

feat: Add C implementation for math/base/assert/is-even

2192c36

PR-URL: stdlib-js#1667 Closes: stdlib-js#1666 --------- Signed-off-by: Pranav <[email protected]> Co-authored-by: Pranav <[email protected]> Reviewed-by: Pranav <[email protected]>

docs: update REPL namespace documentation

87b4900

PR-URL: stdlib-js#1677 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]>

docs: update namespace TypeScript declarations

5541bd3

PR-URL: stdlib-js#1676 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]>

bench: update assert/is-boolean benchmarks to measure affirmative/n…

45aa4cf

…egative test values PR-URL: stdlib-js#1458 Signed-off-by: Snehil Shah <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

Shashankss1205 and others added 27 commits March 7, 2024 07:30

docs: update namespace table of contents

3a9250d

PR-URL: stdlib-js#1709 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]>

feat: add C implementation for math/base/special/coth

132f01f

PR-URL: stdlib-js#1685 Closes: stdlib-js#754 --------- Signed-off-by: Lovelin <[email protected]> Reviewed-by: Pranav Goswami <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

chore: resolve lint errors

5442566

build: add script to update gypfile fields

6b161cd

style: add empty line

fix: add missing gypfile field entries

790038d

style: use two spaces for indentation

e85db40

build: update gypfile field in workflow

b6d56eb

docs: update list of contributors

1bc25a7

PR-URL: stdlib-js#1725 Signed-off-by: stdlib-bot <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

docs: remove blank line

e8d2126

PR-URL: stdlib-js#1726 Reviewed-by: Athan Reines <[email protected]>

fix: rename configuration file

e72aa33

Closes: stdlib-js#1718 PR-URL: stdlib-js#1730 Reviewed-by: Athan Reines <[email protected]>

fix: use correct function name

bb3e47f

fix: update polynomial functions and fix function call

be018c2

Ref: stdlib-js#1452

style: fix spacing

d8b8b92

docs: improve README examples for stats/base/dists/t namespace

c4066d8

PR-URL: stdlib-js#1728 Closes: stdlib-js#1645 Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

docs: update REPL namespace documentation

a034381

PR-URL: stdlib-js#1737 Signed-off-by: stdlib-bot <[email protected]> Co-authored-by: Planeshifter <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>

build: run C examples in workflow

c4d57d4

build: compile native add-ons in affected tests workflow

04f4f1d

chore: fix gypfile typo in description

d8c118f

Improved implementation

cd45a26

Merge branch 'stdlib-js:develop' into feature/@stdlib/napi/argv-compl…

d3e5688

…ex128

PoookieCoder closed this Mar 7, 2024

PoookieCoder deleted the feature/@stdlib/napi/argv-complex128 branch March 7, 2024 02:06

Planeshifter removed the Needs Review A pull request which needs code review. label Mar 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `napi/argv-complex128` #1445

feat: add `napi/argv-complex128` #1445

PoookieCoder commented Mar 2, 2024 •

edited

Loading

kgryte Mar 2, 2024 •

edited

Loading

feat: add napi/argv-complex128 #1445

feat: add napi/argv-complex128 #1445

Conversation

PoookieCoder commented Mar 2, 2024 • edited Loading

Description

Related Issues

Questions

Other

Checklist

kgryte Mar 2, 2024 • edited Loading

Choose a reason for hiding this comment

feat: add `napi/argv-complex128` #1445

feat: add `napi/argv-complex128` #1445

PoookieCoder commented Mar 2, 2024 •

edited

Loading

kgryte Mar 2, 2024 •

edited

Loading