Skip to content

docs: update math/base/special TypeScript declarations #9017

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.

Sign up for GitHub

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
Planeshifter merged 1 commit into from
Dec 13, 2025
Merged

docs: update math/base/special TypeScript declarations #9017

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 4 additions & 36 deletions lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2559,17 +2559,9 @@ interface Namespace {
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var v = ns.cceil( new Complex128( -1.5, 2.5 ) );
* // returns <Complex128>
*
* var re = real( v );
* // returns -1.0
*
* var im = imag( v );
* // returns 3.0
* // returns <Complex128>[ -1.0, 3.0 ]
*/
cceil: typeof cceil;

Expand Down Expand Up @@ -2899,17 +2891,9 @@ interface Namespace {
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var real = require( '@stdlib/complex/float32/real' );
* var imag = require( '@stdlib/complex/float32/imag' );
*
* var v = ns.cflipsignf( new Complex64( -4.0, 5.0 ), -55.0 );
* // returns <Complex64>
*
* var re = real( v );
* // returns 4.0
*
* var im = imag( v );
* // returns -5.0
* // returns <Complex64>[ 4.0, -5.0 ]
*/
cflipsignf: typeof cflipsignf;

Expand Down Expand Up @@ -3709,17 +3693,9 @@ interface Namespace {
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var v = ns.croundn( new Complex128( 5.555, -3.333 ), -2 );
* // returns <Complex128>
*
* var re = real( v );
* // returns 5.56
*
* var im = imag( v );
* // returns -3.33
* // returns <Complex128>[ 5.56, -3.33 ]
*/
croundn: typeof croundn;

Expand Down Expand Up @@ -3867,17 +3843,9 @@ interface Namespace {
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var v = ns.csignum( new Complex128( -4.2, 5.5 ) );
* // returns <Complex128>
*
* var re = real( v );
* // returns -0.6069136033622302
*
* var im = imag( v );
* // returns 0.79476781392673
* // returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
*/
csignum: typeof csignum;

Expand Down