-
-
Notifications
You must be signed in to change notification settings - Fork 837
feat: refactor and add native addon for complex/float64/conj
#7301
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
8965325
feat: refactor and native addons for complex/float64/conj
ShabiShett07 9c9007e
chore: clean-up
ShabiShett07 f604fa5
chore: update copyright years
stdlib-bot bd77ec2
Merge remote-tracking branch 'upstream/develop' into feature/conj
stdlib-bot 19d177e
bench: update message
kgryte 74ecbc8
docs: update example
kgryte 71349bc
fix: update function name
kgryte dd0c8d2
chore: add gyp files
ShabiShett07 dbc89d3
chore: update copyright years
stdlib-bot eb0d1ae
chore: update package.json
ShabiShett07 b83b1aa
chore: remove field
kgryte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
lib/node_modules/@stdlib/complex/float64/conj/benchmark/benchmark.native.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2025 The Stdlib Authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
'use strict'; | ||
|
||
// MODULES // | ||
|
||
var resolve = require( 'path' ).resolve; | ||
var bench = require( '@stdlib/bench' ); | ||
var uniform = require( '@stdlib/random/base/uniform' ); | ||
var isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||
var Complex128 = require( '@stdlib/complex/float64/ctor' ); | ||
var real = require( '@stdlib/complex/float64/real' ); | ||
var imag = require( '@stdlib/complex/float64/imag' ); | ||
var tryRequire = require( '@stdlib/utils/try-require' ); | ||
var pkg = require( './../package.json' ).name; | ||
|
||
|
||
// VARIABLES // | ||
|
||
var conj = tryRequire( resolve( __dirname, './../lib/native.js' ) ); | ||
var opts = { | ||
'skip': ( conj instanceof Error ) | ||
}; | ||
|
||
|
||
// MAIN // | ||
|
||
bench( pkg+'::native', opts, function benchmark( b ) { | ||
var values; | ||
var out; | ||
var z; | ||
var i; | ||
|
||
values = [ | ||
new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ), | ||
new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ) | ||
]; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
z = values[ i%values.length ]; | ||
out = conj( z ); | ||
if ( typeof out !== 'object' ) { | ||
b.fail( 'should return an object' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( isnan( real( out ) ) || isnan( imag( out ) ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
}); |
170 changes: 170 additions & 0 deletions
170
lib/node_modules/@stdlib/complex/float64/conj/binding.gyp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,170 @@ | ||
# @license Apache-2.0 | ||
# | ||
# Copyright (c) 2025 The Stdlib Authors. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# A `.gyp` file for building a Node.js native add-on. | ||
# | ||
# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md | ||
# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md | ||
{ | ||
# List of files to include in this file: | ||
'includes': [ | ||
'./include.gypi', | ||
], | ||
|
||
# Define variables to be used throughout the configuration for all targets: | ||
'variables': { | ||
# Target name should match the add-on export name: | ||
'addon_target_name%': 'addon', | ||
|
||
# Set variables based on the host OS: | ||
'conditions': [ | ||
[ | ||
'OS=="win"', | ||
{ | ||
# Define the object file suffix: | ||
'obj': 'obj', | ||
}, | ||
{ | ||
# Define the object file suffix: | ||
'obj': 'o', | ||
} | ||
], # end condition (OS=="win") | ||
], # end conditions | ||
}, # end variables | ||
|
||
# Define compile targets: | ||
'targets': [ | ||
|
||
# Target to generate an add-on: | ||
{ | ||
# The target name should match the add-on export name: | ||
'target_name': '<(addon_target_name)', | ||
|
||
# Define dependencies: | ||
'dependencies': [], | ||
|
||
# Define directories which contain relevant include headers: | ||
'include_dirs': [ | ||
# Local include directory: | ||
'<@(include_dirs)', | ||
], | ||
|
||
# List of source files: | ||
'sources': [ | ||
'<@(src_files)', | ||
], | ||
|
||
# Settings which should be applied when a target's object files are used as linker input: | ||
'link_settings': { | ||
# Define libraries: | ||
'libraries': [ | ||
'<@(libraries)', | ||
], | ||
|
||
# Define library directories: | ||
'library_dirs': [ | ||
'<@(library_dirs)', | ||
], | ||
}, | ||
|
||
# C/C++ compiler flags: | ||
'cflags': [ | ||
# Enable commonly used warning options: | ||
'-Wall', | ||
|
||
# Aggressive optimization: | ||
'-O3', | ||
], | ||
|
||
# C specific compiler flags: | ||
'cflags_c': [ | ||
# Specify the C standard to which a program is expected to conform: | ||
'-std=c99', | ||
], | ||
|
||
# C++ specific compiler flags: | ||
'cflags_cpp': [ | ||
# Specify the C++ standard to which a program is expected to conform: | ||
'-std=c++11', | ||
], | ||
|
||
# Linker flags: | ||
'ldflags': [], | ||
|
||
# Apply conditions based on the host OS: | ||
'conditions': [ | ||
[ | ||
'OS=="mac"', | ||
{ | ||
# Linker flags: | ||
'ldflags': [ | ||
'-undefined dynamic_lookup', | ||
'-Wl,-no-pie', | ||
'-Wl,-search_paths_first', | ||
], | ||
}, | ||
], # end condition (OS=="mac") | ||
[ | ||
'OS!="win"', | ||
{ | ||
# C/C++ flags: | ||
'cflags': [ | ||
# Generate platform-independent code: | ||
'-fPIC', | ||
], | ||
}, | ||
], # end condition (OS!="win") | ||
], # end conditions | ||
}, # end target <(addon_target_name) | ||
|
||
# Target to copy a generated add-on to a standard location: | ||
{ | ||
'target_name': 'copy_addon', | ||
|
||
# Declare that the output of this target is not linked: | ||
'type': 'none', | ||
|
||
# Define dependencies: | ||
'dependencies': [ | ||
# Require that the add-on be generated before building this target: | ||
'<(addon_target_name)', | ||
], | ||
|
||
# Define a list of actions: | ||
'actions': [ | ||
{ | ||
'action_name': 'copy_addon', | ||
'message': 'Copying addon...', | ||
|
||
# Explicitly list the inputs in the command-line invocation below: | ||
'inputs': [], | ||
|
||
# Declare the expected outputs: | ||
'outputs': [ | ||
'<(addon_output_dir)/<(addon_target_name).node', | ||
], | ||
|
||
# Define the command-line invocation: | ||
'action': [ | ||
'cp', | ||
'<(PRODUCT_DIR)/<(addon_target_name).node', | ||
'<(addon_output_dir)/<(addon_target_name).node', | ||
], | ||
}, | ||
], # end actions | ||
}, # end target copy_addon | ||
], # end targets | ||
} |
53 changes: 53 additions & 0 deletions
53
lib/node_modules/@stdlib/complex/float64/conj/include.gypi
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# @license Apache-2.0 | ||
# | ||
# Copyright (c) 2025 The Stdlib Authors. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# A GYP include file for building a Node.js native add-on. | ||
# | ||
# Main documentation: | ||
# | ||
# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md | ||
# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md | ||
{ | ||
# Define variables to be used throughout the configuration for all targets: | ||
'variables': { | ||
# Source directory: | ||
'src_dir': './src', | ||
|
||
# Include directories: | ||
'include_dirs': [ | ||
'<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).include; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")', | ||
], | ||
|
||
# Add-on destination directory: | ||
'addon_output_dir': './src', | ||
|
||
# Source files: | ||
'src_files': [ | ||
'<(src_dir)/addon.c', | ||
'<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).src; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")', | ||
], | ||
|
||
# Library dependencies: | ||
'libraries': [ | ||
'<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).libraries; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")', | ||
], | ||
|
||
# Library directories: | ||
'library_dirs': [ | ||
'<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).libpath; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")', | ||
], | ||
}, # end variables | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think this makes sense now. There is some history here in why
z.constructor
was used. Namely, when this package wascomplex/conj
, we wanted to preserve input instance type. However, now that this package is incomplex/float64
, I think we are fine always returning aComplex128
instance.