Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed May 26, 2024
1 parent edf9bd5 commit 8cc7c5f
Show file tree
Hide file tree
Showing 36 changed files with 62 additions and 62 deletions.
2 changes: 1 addition & 1 deletion base/ops/cadd/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

Examples
--------
> var z = new {{alias:@stdlib/complex/float64}}( 5.0, 3.0 )
> var z = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, 3.0 )
<Complex128>
> var out = {{alias}}( z, z )
<Complex128>
Expand Down
2 changes: 1 addition & 1 deletion base/ops/caddf/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

Examples
--------
> var z = new {{alias:@stdlib/complex/float32}}( 5.0, 3.0 )
> var z = new {{alias:@stdlib/complex/float32/ctor}}( 5.0, 3.0 )
<Complex64>
> var out = {{alias}}( z, z )
<Complex64>
Expand Down
4 changes: 2 additions & 2 deletions base/ops/cdiv/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

Examples
--------
> var z1 = new {{alias:@stdlib/complex/float64}}( -13.0, -1.0 )
> var z1 = new {{alias:@stdlib/complex/float64/ctor}}( -13.0, -1.0 )
<Complex128>
> var z2 = new {{alias:@stdlib/complex/float64}}( -2.0, 1.0 )
> var z2 = new {{alias:@stdlib/complex/float64/ctor}}( -2.0, 1.0 )
<Complex128>
> var y = {{alias}}( z1, z2 )
<Complex128>
Expand Down
4 changes: 2 additions & 2 deletions base/ops/cmul/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

Examples
--------
> var z1 = new {{alias:@stdlib/complex/float64}}( 5.0, 3.0 )
> var z1 = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, 3.0 )
<Complex128>
> var z2 = new {{alias:@stdlib/complex/float64}}( -2.0, 1.0 )
> var z2 = new {{alias:@stdlib/complex/float64/ctor}}( -2.0, 1.0 )
<Complex128>
> var out = {{alias}}( z1, z2 )
<Complex128>
Expand Down
4 changes: 2 additions & 2 deletions base/ops/cmulf/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

Examples
--------
> var z1 = new {{alias:@stdlib/complex/float32}}( 5.0, 3.0 )
> var z1 = new {{alias:@stdlib/complex/float32/ctor}}( 5.0, 3.0 )
<Complex64>
> var z2 = new {{alias:@stdlib/complex/float32}}( -2.0, 1.0 )
> var z2 = new {{alias:@stdlib/complex/float32/ctor}}( -2.0, 1.0 )
<Complex64>
> var out = {{alias}}( z1, z2 )
<Complex64>
Expand Down
2 changes: 1 addition & 1 deletion base/ops/cneg/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

Examples
--------
> var z = new {{alias:@stdlib/complex/float64}}( -4.2, 5.5 )
> var z = new {{alias:@stdlib/complex/float64/ctor}}( -4.2, 5.5 )
<Complex128>
> var v = {{alias}}( z )
<Complex128>
Expand Down
2 changes: 1 addition & 1 deletion base/ops/cnegf/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

Examples
--------
> var z = new {{alias:@stdlib/complex/float32}}( -4.0, 5.0 )
> var z = new {{alias:@stdlib/complex/float32/ctor}}( -4.0, 5.0 )
<Complex64>
> var v = {{alias}}( z )
<Complex64>
Expand Down
4 changes: 2 additions & 2 deletions base/ops/csub/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

Examples
--------
> var z1 = new {{alias:@stdlib/complex/float64}}( 5.0, 3.0 )
> var z1 = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, 3.0 )
<Complex128>
> var z2 = new {{alias:@stdlib/complex/float64}}( -2.0, 1.0 )
> var z2 = new {{alias:@stdlib/complex/float64/ctor}}( -2.0, 1.0 )
<Complex128>
> var out = {{alias}}( z1, z2 )
<Complex128>
Expand Down
4 changes: 2 additions & 2 deletions base/ops/csubf/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

Examples
--------
> var z1 = new {{alias:@stdlib/complex/float32}}( 5.0, 3.0 )
> var z1 = new {{alias:@stdlib/complex/float32/ctor}}( 5.0, 3.0 )
<Complex64>
> var z2 = new {{alias:@stdlib/complex/float32}}( -2.0, 1.0 )
> var z2 = new {{alias:@stdlib/complex/float32/ctor}}( -2.0, 1.0 )
<Complex64>
> var out = {{alias}}( z1, z2 )
<Complex64>
Expand Down
8 changes: 4 additions & 4 deletions base/special/cabs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ limitations under the License.

# cabs

> Compute the [absolute value][absolute-value] of a double-precision [complex][@stdlib/complex/float64] floating-point number.
> Compute the [absolute value][absolute-value] of a double-precision [complex][@stdlib/complex/float64/ctor] floating-point number.
<section class="intro">

The [absolute value][absolute-value] of a [complex][@stdlib/complex/float64] number is defined as
The [absolute value][absolute-value] of a [complex][@stdlib/complex/float64/ctor] number is defined as

<!-- <equation class="equation" label="eq:absolute_value_complex" align="center" raw="|a + bi| = \sqrt{a^2 + b^2}" alt="Absolute value"> -->

Expand Down Expand Up @@ -55,7 +55,7 @@ var cabs = require( '@stdlib/math/base/special/cabs' );

#### cabs( z )

Computes an [absolute value][absolute-value] of a double-precision [complex][@stdlib/complex/float64] floating-point number.
Computes an [absolute value][absolute-value] of a double-precision [complex][@stdlib/complex/float64/ctor] floating-point number.

```javascript
var Complex128 = require( '@stdlib/complex/float64/ctor' );
Expand Down Expand Up @@ -215,7 +215,7 @@ int main( void ) {

[absolute-value]: https://en.wikipedia.org/wiki/Absolute_value

[@stdlib/complex/float64]: https://github.com/stdlib-js/complex-float64
[@stdlib/complex/float64/ctor]: https://github.com/stdlib-js/complex-float64-ctor

<!-- <related-links> -->

Expand Down
2 changes: 1 addition & 1 deletion base/special/cabs/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

Examples
--------
> var y = {{alias}}( new {{alias:@stdlib/complex/float64}}( 5.0, 3.0 ) )
> var y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.0, 3.0 ) )
~5.831

See Also
Expand Down
10 changes: 5 additions & 5 deletions base/special/cabs2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ limitations under the License.

# cabs2

> Compute the squared [absolute value][absolute-value] of a double-precision [complex][@stdlib/complex/float64] floating-point number.
> Compute the squared [absolute value][absolute-value] of a double-precision [complex][@stdlib/complex/float64/ctor] floating-point number.
<section class="intro">

The [absolute value][absolute-value] of a [complex][@stdlib/complex/float64] number is defined as
The [absolute value][absolute-value] of a [complex][@stdlib/complex/float64/ctor] number is defined as

<!-- <equation class="equation" label="eq:absolute_value_complex" align="center" raw="|a + bi| = \sqrt{a^2 + b^2}" alt="Absolute value"> -->

Expand Down Expand Up @@ -55,7 +55,7 @@ var cabs2 = require( '@stdlib/math/base/special/cabs2' );

#### cabs2( z )

Computes the squared [absolute value][absolute-value] of a double-precision [complex][@stdlib/complex/float64] floating-point number.
Computes the squared [absolute value][absolute-value] of a double-precision [complex][@stdlib/complex/float64/ctor] floating-point number.

```javascript
var Complex128 = require( '@stdlib/complex/float64/ctor' );
Expand All @@ -73,7 +73,7 @@ var y = cabs2( new Complex128( 5.0, 3.0 ) );
## Notes

- Be careful to avoid overflow and underflow.
- Depending on the environment, this function _may_ have better performance than computing the [absolute value][absolute-value] of a [complex][@stdlib/complex/float64] number and then squaring. Hence, where appropriate, consider using `cabs2()` over [`cabs()`][@stdlib/math/base/special/cabs].
- Depending on the environment, this function _may_ have better performance than computing the [absolute value][absolute-value] of a [complex][@stdlib/complex/float64/ctor] number and then squaring. Hence, where appropriate, consider using `cabs2()` over [`cabs()`][@stdlib/math/base/special/cabs].

</section>

Expand Down Expand Up @@ -232,7 +232,7 @@ int main( void ) {

[@stdlib/math/base/special/cabs]: https://github.com/stdlib-js/math/tree/main/base/special/cabs

[@stdlib/complex/float64]: https://github.com/stdlib-js/complex-float64
[@stdlib/complex/float64/ctor]: https://github.com/stdlib-js/complex-float64-ctor

<!-- <related-links> -->

Expand Down
2 changes: 1 addition & 1 deletion base/special/cabs2/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

Examples
--------
> var y = {{alias}}( new {{alias:@stdlib/complex/float64}}( 5.0, 3.0 ) )
> var y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.0, 3.0 ) )
34.0

See Also
Expand Down
10 changes: 5 additions & 5 deletions base/special/cabs2f/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ limitations under the License.

# cabs2f

> Compute the squared [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32] floating-point number.
> Compute the squared [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32/ctor] floating-point number.
<section class="intro">

The [absolute value][absolute-value] of a [complex][@stdlib/complex/float32] number is defined as
The [absolute value][absolute-value] of a [complex][@stdlib/complex/float32/ctor] number is defined as

<!-- <equation class="equation" label="eq:absolute_value_complex" align="center" raw="|a + bi| = \sqrt{a^2 + b^2}" alt="Absolute value"> -->

Expand Down Expand Up @@ -55,7 +55,7 @@ var cabs2f = require( '@stdlib/math/base/special/cabs2f' );

#### cabs2f( z )

Computes the squared [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32] floating-point number.
Computes the squared [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32/ctor] floating-point number.

```javascript
var Complex64 = require( '@stdlib/complex/float32/ctor' );
Expand All @@ -73,7 +73,7 @@ var y = cabs2f( new Complex64( 5.0, 3.0 ) );
## Notes

- Be careful to avoid overflow and underflow.
- Depending on the environment, this function _may_ have better performance than computing the [absolute value][absolute-value] of a [complex][@stdlib/complex/float32] number and then squaring. Hence, where appropriate, consider using `cabs2f()` over [`cabsf()`][@stdlib/math/base/special/cabsf].
- Depending on the environment, this function _may_ have better performance than computing the [absolute value][absolute-value] of a [complex][@stdlib/complex/float32/ctor] number and then squaring. Hence, where appropriate, consider using `cabs2f()` over [`cabsf()`][@stdlib/math/base/special/cabsf].

</section>

Expand Down Expand Up @@ -222,7 +222,7 @@ int main( void ) {

[@stdlib/math/base/special/cabsf]: https://github.com/stdlib-js/math/tree/main/base/special/cabsf

[@stdlib/complex/float32]: https://github.com/stdlib-js/complex-float32
[@stdlib/complex/float32/ctor]: https://github.com/stdlib-js/complex-float32-ctor

<!-- <related-links> -->

Expand Down
2 changes: 1 addition & 1 deletion base/special/cabs2f/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

Examples
--------
> var y = {{alias}}( new {{alias:@stdlib/complex/float32}}( 5.0, 3.0 ) )
> var y = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( 5.0, 3.0 ) )
34.0

See Also
Expand Down
8 changes: 4 additions & 4 deletions base/special/cabsf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ limitations under the License.

# cabsf

> Compute the [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32] floating-point number.
> Compute the [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32/ctor] floating-point number.
<section class="intro">

The [absolute value][absolute-value] of a [complex][@stdlib/complex/float32] number is defined as
The [absolute value][absolute-value] of a [complex][@stdlib/complex/float32/ctor] number is defined as

<!-- <equation class="equation" label="eq:absolute_value_complex" align="center" raw="|a + bi| = \sqrt{a^2 + b^2}" alt="Absolute value"> -->

Expand Down Expand Up @@ -55,7 +55,7 @@ var cabsf = require( '@stdlib/math/base/special/cabsf' );

#### cabsf( z )

Computes an [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32] floating-point number.
Computes an [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32/ctor] floating-point number.

```javascript
var Complex64 = require( '@stdlib/complex/float32/ctor' );
Expand Down Expand Up @@ -209,7 +209,7 @@ int main( void ) {

[absolute-value]: https://en.wikipedia.org/wiki/Absolute_value

[@stdlib/complex/float32]: https://github.com/stdlib-js/complex-float32
[@stdlib/complex/float32/ctor]: https://github.com/stdlib-js/complex-float32-ctor

<!-- <related-links> -->

Expand Down
2 changes: 1 addition & 1 deletion base/special/cabsf/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

Examples
--------
> var y = {{alias}}( new {{alias:@stdlib/complex/float32}}( 5.0, 3.0 ) )
> var y = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( 5.0, 3.0 ) )
~5.831

See Also
Expand Down
2 changes: 1 addition & 1 deletion base/special/cceil/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

Examples
--------
> var v = {{alias}}( new {{alias:@stdlib/complex/float64}}( -1.5, 2.5 ) )
> var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( -1.5, 2.5 ) )
<Complex128>
> var re = {{alias:@stdlib/complex/real}}( v )
-1.0
Expand Down
2 changes: 1 addition & 1 deletion base/special/cceilf/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

Examples
--------
> var v = {{alias}}( new {{alias:@stdlib/complex/float32}}( -1.5, 2.5 ) )
> var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( -1.5, 2.5 ) )
<Complex64>
> var re = {{alias:@stdlib/complex/real}}( v )
-1.0
Expand Down
2 changes: 1 addition & 1 deletion base/special/cceiln/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

Examples
--------
> var out = {{alias}}( new {{alias:@stdlib/complex/float64}}( 5.555, -3.333 ), -2 )
> var out = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.555, -3.333 ), -2 )
<Complex128>
> var re = {{alias:@stdlib/complex/real}}( out )
5.56
Expand Down
4 changes: 2 additions & 2 deletions base/special/ccis/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@

Examples
--------
> var y = {{alias}}( new {{alias:@stdlib/complex/float64}}( 0.0, 0.0 ) )
> var y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 0.0, 0.0 ) )
<Complex128>
> var re = {{alias:@stdlib/complex/real}}( y )
1.0
> var im = {{alias:@stdlib/complex/imag}}( y )
0.0
> y = {{alias}}( new {{alias:@stdlib/complex/float64}}( 1.0, 0.0 ) )
> y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 0.0 ) )
<Complex128>
> re = {{alias:@stdlib/complex/real}}( y )
~0.540
Expand Down
4 changes: 2 additions & 2 deletions base/special/cexp/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@

Examples
--------
> var y = {{alias}}( new {{alias:@stdlib/complex/float64}}( 0.0, 0.0 ) )
> var y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 0.0, 0.0 ) )
<Complex128>
> var re = {{alias:@stdlib/complex/real}}( y )
1.0
> var im = {{alias:@stdlib/complex/imag}}( y )
0.0
> y = {{alias}}( new {{alias:@stdlib/complex/float64}}( 0.0, 1.0 ) )
> y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 0.0, 1.0 ) )
<Complex128>
> re = {{alias:@stdlib/complex/real}}( y )
~0.540
Expand Down
2 changes: 1 addition & 1 deletion base/special/cflipsign/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

Examples
--------
> var v = {{alias}}( new {{alias:@stdlib/complex/float64}}( -4.2, 5.5 ), -9.0 )
> var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( -4.2, 5.5 ), -9.0 )
<Complex128>
> var re = {{alias:@stdlib/complex/real}}( v )
4.2
Expand Down
2 changes: 1 addition & 1 deletion base/special/cflipsignf/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

Examples
--------
> var v = {{alias}}( new {{alias:@stdlib/complex/float32}}( -4.0, 5.0 ), -9.0 )
> var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( -4.0, 5.0 ), -9.0 )
<Complex64>
> var re = {{alias:@stdlib/complex/real}}( v )
4.0
Expand Down
2 changes: 1 addition & 1 deletion base/special/cfloor/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

Examples
--------
> var v = {{alias}}( new {{alias:@stdlib/complex/float64}}( 5.5, 3.3 ) )
> var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.5, 3.3 ) )
<Complex128>
> var re = {{alias:@stdlib/complex/real}}( v )
5.0
Expand Down
2 changes: 1 addition & 1 deletion base/special/cfloorn/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

Examples
--------
> var v = {{alias}}( new {{alias:@stdlib/complex/float64}}( 5.555, -3.333 ), -2 )
> var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.555, -3.333 ), -2 )
<Complex128>
> var re = {{alias:@stdlib/complex/real}}( v )
5.55
Expand Down
6 changes: 3 additions & 3 deletions base/special/cidentity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# cidentity

> Evaluate the [identity function][identity-function] of a double-precision [complex][@stdlib/complex/float64] floating-point number.
> Evaluate the [identity function][identity-function] of a double-precision [complex][@stdlib/complex/float64/ctor] floating-point number.
<section class="intro">

Expand Down Expand Up @@ -55,7 +55,7 @@ var cidentity = require( '@stdlib/math/base/special/cidentity' );

#### cidentity( z )

Evaluates the [identity function][identity-function] for a double-precision [complex][@stdlib/complex/float64] floating-point number.
Evaluates the [identity function][identity-function] for a double-precision [complex][@stdlib/complex/float64/ctor] floating-point number.

```javascript
var Complex128 = require( '@stdlib/complex/float64/ctor' );
Expand Down Expand Up @@ -232,7 +232,7 @@ int main() {

[identity-function]: https://en.wikipedia.org/wiki/Identity_function

[@stdlib/complex/float64]: https://github.com/stdlib-js/complex-float64
[@stdlib/complex/float64/ctor]: https://github.com/stdlib-js/complex-float64-ctor

<!-- <related-links> -->

Expand Down
Loading

0 comments on commit 8cc7c5f

Please sign in to comment.