-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add math/base/special/cexpf
#10223
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
Open
nirmaljb
wants to merge
3
commits into
stdlib-js:develop
Choose a base branch
from
nirmaljb:feat/cexpf
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
229 changes: 229 additions & 0 deletions
229
lib/node_modules/@stdlib/math/base/special/cexpf/README.md
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,229 @@ | ||||||||||
| <!-- | ||||||||||
|
|
||||||||||
| @license Apache-2.0 | ||||||||||
|
|
||||||||||
| Copyright (c) 2026 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. | ||||||||||
|
|
||||||||||
| --> | ||||||||||
|
|
||||||||||
| # expf | ||||||||||
|
|
||||||||||
| > Evaluate the [exponential][exponential-function] function for a single-precision complex floating-point number. | ||||||||||
|
|
||||||||||
| <section class="intro"> | ||||||||||
|
|
||||||||||
| The [exponential][exponential-function] function of a complex number is defined as | ||||||||||
|
|
||||||||||
| <!-- <equation class="equation" label="eq:cexp_function" align="center" raw="\operatorname{exp}(z) = e^{x + i y} = (\exp{x}) (\cos(y) + i \sin(y))" alt="Complex exponential function"> --> | ||||||||||
|
|
||||||||||
| ```math | ||||||||||
| \mathop{\mathrm{exp}}(z) = e^{x + i y} = (\exp{x}) (\cos(y) + i \sin(y)) | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| <!-- <div class="equation" align="center" data-raw-text="\operatorname{exp}(z) = e^{x + i y} = (\exp{x}) (\cos(y) + i \sin(y))" data-equation="eq:cexp_function"> | ||||||||||
| <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@d4edb68b52a6c646be5683023c5a24890300727f/lib/node_modules/@stdlib/math/base/special/cexp/docs/img/equation_cexp_function.svg" alt="Complex exponential function"> | ||||||||||
| <br> | ||||||||||
| </div> --> | ||||||||||
|
|
||||||||||
|
Comment on lines
+35
to
+39
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Will be auto-generated.
Suggested change
|
||||||||||
| <!-- </equation> --> | ||||||||||
|
|
||||||||||
| </section> | ||||||||||
|
|
||||||||||
| <!-- /.intro --> | ||||||||||
|
|
||||||||||
| <section class="usage"> | ||||||||||
|
|
||||||||||
| ## Usage | ||||||||||
|
|
||||||||||
| ```javascript | ||||||||||
| var cexpf = require( '@stdlib/math/base/special/cexpf' ); | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| #### cexpf( z ) | ||||||||||
|
|
||||||||||
| Evaluates the [exponential][exponential-function] function for a single-precision complex floating-point number. | ||||||||||
|
|
||||||||||
| ```javascript | ||||||||||
| var Complex64 = require( '@stdlib/complex/float32/ctor' ); | ||||||||||
|
|
||||||||||
| var v = cexpf( new Complex64( 0.0, 0.0 ) ); | ||||||||||
| // returns <Complex64>[ 1.0, 0.0 ] | ||||||||||
|
|
||||||||||
| v = cexpf( new Complex64( 0.0, 1.0 ) ); | ||||||||||
| // returns <Complex64>[ ~0.540, ~0.841 ] | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| </section> | ||||||||||
|
|
||||||||||
| <!-- /.usage --> | ||||||||||
|
|
||||||||||
| <section class="examples"> | ||||||||||
|
|
||||||||||
| ## Examples | ||||||||||
|
|
||||||||||
| <!-- eslint no-undef: "error" --> | ||||||||||
|
|
||||||||||
| ```javascript | ||||||||||
| var Complex64 = require( '@stdlib/complex/float32/ctor' ); | ||||||||||
| var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); | ||||||||||
| var cexpf = require( '@stdlib/math/base/special/cexpf' ); | ||||||||||
|
|
||||||||||
| function randomComplex() { | ||||||||||
| var re = discreteUniform( -50, 50 ); | ||||||||||
| var im = discreteUniform( -50, 50 ); | ||||||||||
| return new Complex64( re, im ); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| var z1; | ||||||||||
| var z2; | ||||||||||
| var i; | ||||||||||
| for ( i = 0; i < 100; i++ ) { | ||||||||||
| z1 = randomComplex(); | ||||||||||
| z2 = cexpf( z1 ); | ||||||||||
| console.log( 'cexpf(%s) = %s', z1.toString(), z2.toString() ); | ||||||||||
| } | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| </section> | ||||||||||
|
|
||||||||||
| <!-- /.examples --> | ||||||||||
|
|
||||||||||
| <!-- C interface documentation. --> | ||||||||||
|
|
||||||||||
| * * * | ||||||||||
|
|
||||||||||
| <section class="c"> | ||||||||||
|
|
||||||||||
| ## C APIs | ||||||||||
|
|
||||||||||
| <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||||||||||
|
|
||||||||||
| <section class="intro"> | ||||||||||
|
|
||||||||||
| </section> | ||||||||||
|
|
||||||||||
| <!-- /.intro --> | ||||||||||
|
|
||||||||||
| <!-- C usage documentation. --> | ||||||||||
|
|
||||||||||
| <section class="usage"> | ||||||||||
|
|
||||||||||
| ### Usage | ||||||||||
|
|
||||||||||
| ```c | ||||||||||
| #include "stdlib/math/base/special/cexpf.h" | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| #### stdlib_base_cexpf( z ) | ||||||||||
|
|
||||||||||
| Evaluates the [exponential][exponential-function] function for a single-precision complex floating-point number. | ||||||||||
|
|
||||||||||
| ```c | ||||||||||
| #include "stdlib/complex/float32/ctor.h" | ||||||||||
| #include "stdlib/complex/float32/real.h" | ||||||||||
| #include "stdlib/complex/float32/imag.h" | ||||||||||
|
|
||||||||||
| stdlib_complex64_t z = stdlib_complex64( 0.0f, 0.0f ); | ||||||||||
| stdlib_complex64_t out = stdlib_base_cexpf( z ); | ||||||||||
|
|
||||||||||
| float re = stdlib_complex64_real( out ); | ||||||||||
| // returns 1.0f | ||||||||||
|
|
||||||||||
| float im = stdlib_complex64_imag( out ); | ||||||||||
| // returns 0.0f | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| The function accepts the following arguments: | ||||||||||
|
|
||||||||||
| - **z**: `[in] stdlib_complex64_t` input value. | ||||||||||
|
|
||||||||||
| ```c | ||||||||||
| stdlib_complex64_t stdlib_base_cexpf( const stdlib_complex64_t z ); | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| </section> | ||||||||||
|
|
||||||||||
| <!-- /.usage --> | ||||||||||
|
|
||||||||||
| <!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||||||||||
|
|
||||||||||
| <section class="notes"> | ||||||||||
|
|
||||||||||
| </section> | ||||||||||
|
|
||||||||||
| <!-- /.notes --> | ||||||||||
|
|
||||||||||
| <!-- C API usage examples. --> | ||||||||||
|
|
||||||||||
| <section class="examples"> | ||||||||||
|
|
||||||||||
| ### Examples | ||||||||||
|
|
||||||||||
| ```c | ||||||||||
| #include "stdlib/math/base/special/cexpf.h" | ||||||||||
| #include "stdlib/complex/float32/ctor.h" | ||||||||||
| #include "stdlib/complex/float32/reim.h" | ||||||||||
| #include <stdio.h> | ||||||||||
|
|
||||||||||
| int main( void ) { | ||||||||||
| const stdlib_complex64_t x[] = { | ||||||||||
| stdlib_complex64( 3.14f, 1.5f ), | ||||||||||
| stdlib_complex64( -3.14f, -1.5f ), | ||||||||||
| stdlib_complex64( 0.0f, 0.0f ), | ||||||||||
| stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f ) | ||||||||||
| }; | ||||||||||
|
|
||||||||||
| stdlib_complex64_t v; | ||||||||||
| stdlib_complex64_t y; | ||||||||||
| float re1; | ||||||||||
| float im1; | ||||||||||
| float re2; | ||||||||||
| float im2; | ||||||||||
| int i; | ||||||||||
| for ( i = 0; i < 4; i++ ) { | ||||||||||
| v = x[ i ]; | ||||||||||
| y = stdlib_base_cexpf( v ); | ||||||||||
| stdlib_complex64_reim( v, &re1, &im1 ); | ||||||||||
| stdlib_complex64_reim( y, &re2, &im2 ); | ||||||||||
| printf( "cexpf(%f + %fi) = %f + %fi\n", re1, im1, re2, im2 ); | ||||||||||
| } | ||||||||||
| } | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| </section> | ||||||||||
|
|
||||||||||
| <!-- /.examples --> | ||||||||||
|
|
||||||||||
| </section> | ||||||||||
|
|
||||||||||
| <!-- /.c --> | ||||||||||
|
|
||||||||||
| <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||||||||||
|
|
||||||||||
| <section class="related"> | ||||||||||
|
|
||||||||||
| </section> | ||||||||||
|
|
||||||||||
| <!-- /.related --> | ||||||||||
|
|
||||||||||
| <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||||||||||
|
|
||||||||||
| <section class="links"> | ||||||||||
|
|
||||||||||
| [exponential-function]: https://en.wikipedia.org/wiki/Exponential_function | ||||||||||
|
|
||||||||||
| </section> | ||||||||||
|
|
||||||||||
| <!-- /.links --> | ||||||||||
59 changes: 59 additions & 0 deletions
59
lib/node_modules/@stdlib/math/base/special/cexpf/benchmark/benchmark.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,59 @@ | ||||||
| /** | ||||||
| * @license Apache-2.0 | ||||||
| * | ||||||
| * Copyright (c) 2026 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 bench = require( '@stdlib/bench' ); | ||||||
| var uniform = require( '@stdlib/random/base/uniform' ); | ||||||
| var format = require( '@stdlib/string/format' ); | ||||||
| var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); | ||||||
| var Complex64 = require( '@stdlib/complex/float32/ctor' ); | ||||||
| var realf = require( '@stdlib/complex/float32/real' ); | ||||||
| var imagf = require( '@stdlib/complex/float32/imag' ); | ||||||
| var pkg = require( './../package.json' ).name; | ||||||
| var cexpf = require( './../lib' ); | ||||||
|
|
||||||
|
|
||||||
| // MAIN // | ||||||
|
|
||||||
| bench( format( '%s', pkg ), function benchmark( b ) { | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| var values; | ||||||
| var y; | ||||||
| var i; | ||||||
|
|
||||||
| values = [ | ||||||
| new Complex64( uniform( -50.0, 50.0 ), uniform( -50.0, 50.0 ) ), | ||||||
| new Complex64( uniform( -50.0, 50.0 ), uniform( -50.0, 50.0 ) ) | ||||||
| ]; | ||||||
|
|
||||||
| b.tic(); | ||||||
| for ( i = 0; i < b.iterations; i++ ) { | ||||||
| y = cexpf( values[ i%values.length ] ); | ||||||
| if ( typeof y !== 'object' ) { | ||||||
| b.fail( 'should return a complex number' ); | ||||||
| } | ||||||
| } | ||||||
| b.toc(); | ||||||
| if ( isnanf( realf( y ) ) || isnanf( imagf( y ) ) ) { | ||||||
| b.fail( 'should not return NaN' ); | ||||||
| } | ||||||
| b.pass( 'benchmark finished' ); | ||||||
| b.end(); | ||||||
| }); | ||||||
68 changes: 68 additions & 0 deletions
68
lib/node_modules/@stdlib/math/base/special/cexpf/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,68 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); | ||
| var Complex64 = require( '@stdlib/complex/float32/ctor' ); | ||
| var realf = require( '@stdlib/complex/float32/real' ); | ||
| var imagf = require( '@stdlib/complex/float32/imag' ); | ||
| var format = require( '@stdlib/string/format' ); | ||
| var tryRequire = require( '@stdlib/utils/try-require' ); | ||
| var pkg = require( './../package.json' ).name; | ||
|
|
||
|
|
||
| // VARIABLES // | ||
|
|
||
| var cexpf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); | ||
| var opts = { | ||
| 'skip': ( cexpf instanceof Error ) | ||
| }; | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| bench( format( '%s::native', pkg ), opts, function benchmark( b ) { | ||
| var values; | ||
| var y; | ||
| var i; | ||
|
|
||
| values = [ | ||
| new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ), | ||
| new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ) | ||
| ]; | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| y = cexpf( values[ i%values.length ] ); | ||
| if ( typeof y !== 'object' ) { | ||
| b.fail( 'should return a complex number' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( isnanf( realf( y ) ) || isnanf( imagf( y ) ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| }); |
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.