Skip to content

feat: update namespace TypeScript declarations #2490

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 1 commit into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 0 additions & 15 deletions lib/node_modules/@stdlib/array/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -596,21 +596,6 @@ interface Namespace {
/**
* Returns a filled typed array view of an `ArrayBuffer` according to a provided callback function.
*
* The function recognizes the following data types:
*
* - `float64`: double-precision floating-point numbers (IEEE 754)
* - `float32`: single-precision floating-point numbers (IEEE 754)
* - `complex128`: double-precision complex floating-point numbers
* - `complex64`: single-precision complex floating-point numbers
* - `int32`: 32-bit two's complement signed integers
* - `uint32`: 32-bit unsigned integers
* - `int16`: 16-bit two's complement signed integers
* - `uint16`: 16-bit unsigned integers
* - `int8`: 8-bit two's complement signed integers
* - `uint8`: 8-bit unsigned integers
* - `uint8c`: 8-bit unsigned integers clamped to `0-255`
* - `generic`: generic JavaScript values
*
* ## Notes
*
* - Creating a generic array from an `ArrayBuffer` is **not** supported.
Expand Down
35 changes: 35 additions & 0 deletions lib/node_modules/@stdlib/strided/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,15 @@ import nullaryAddonDispatch = require( '@stdlib/strided/base/nullary-addon-dispa
import offsetView = require( '@stdlib/strided/base/offset-view' );
import quaternary = require( '@stdlib/strided/base/quaternary' );
import quinary = require( '@stdlib/strided/base/quinary' );
import reinterpretBoolean = require( '@stdlib/strided/base/reinterpret-boolean' );
import reinterpretComplex = require( '@stdlib/strided/base/reinterpret-complex' );
import reinterpretComplex64 = require( '@stdlib/strided/base/reinterpret-complex64' );
import reinterpretComplex128 = require( '@stdlib/strided/base/reinterpret-complex128' );
import smap = require( '@stdlib/strided/base/smap' );
import smap2 = require( '@stdlib/strided/base/smap2' );
import smskmap = require( '@stdlib/strided/base/smskmap' );
import smskmap2 = require( '@stdlib/strided/base/smskmap2' );
import stride2offset = require( '@stdlib/strided/base/stride2offset' );
import ternary = require( '@stdlib/strided/base/ternary' );
import unary = require( '@stdlib/strided/base/unary' );
import unaryAddonDispatch = require( '@stdlib/strided/base/unary-addon-dispatch' );
Expand Down Expand Up @@ -1048,6 +1050,26 @@ interface Namespace {
*/
quinary: typeof quinary;

/**
* Reinterprets a `BooleanArray` as a `Uint8Array`.
*
* @param x - input array
* @param offset - starting index
* @returns `Uint8Array` view
*
* @example
* var BooleanArray = require( '@stdlib/array/bool' );
*
* var x = new BooleanArray( 10 );
*
* var out = ns.reinterpretBoolean( x, 0 );
* // returns <Uint8Array>
*
* var bool = ( out.buffer === x.buffer );
* // returns true
*/
reinterpretBoolean: typeof reinterpretBoolean;

/**
* Reinterprets a `Complex128Array` as a `Float64Array`.
*
Expand Down Expand Up @@ -1269,6 +1291,19 @@ interface Namespace {
*/
smskmap2: typeof smskmap2;

/**
* Returns the index offset which specifies the location of the first indexed value in a strided array.
*
* @param N - number of indexed elements
* @param stride - index increment
* @returns offset
*
* @example
* var offset = ns.stride2offset( 10, -10 );
* // returns 90
*/
stride2offset: typeof stride2offset;

/**
* Applies a ternary callback to strided input array elements and assigns results to elements in a strided output array.
*
Expand Down
Loading