Skip to content
Merged
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
48 changes: 48 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,9 @@ import pop = require( '@stdlib/ndarray/base/pop' );
import prependSingletonDimensions = require( '@stdlib/ndarray/base/prepend-singleton-dimensions' );
import promoteDataTypes = require( '@stdlib/ndarray/base/promote-dtypes' );
import quaternaryLoopOrder = require( '@stdlib/ndarray/base/quaternary-loop-interchange-order' );
import quaternaryBlockSize = require( '@stdlib/ndarray/base/quaternary-tiling-block-size' );
import quinaryLoopOrder = require( '@stdlib/ndarray/base/quinary-loop-interchange-order' );
import quinaryBlockSize = require( '@stdlib/ndarray/base/quinary-tiling-block-size' );
import removeSingletonDimensions = require( '@stdlib/ndarray/base/remove-singleton-dimensions' );
import reverse = require( '@stdlib/ndarray/base/reverse' );
import reverseDimension = require( '@stdlib/ndarray/base/reverse-dimension' );
Expand Down Expand Up @@ -154,6 +156,7 @@ import ternary = require( '@stdlib/ndarray/base/ternary' );
import ternaryLoopOrder = require( '@stdlib/ndarray/base/ternary-loop-interchange-order' );
import ternaryOutputDataType = require( '@stdlib/ndarray/base/ternary-output-dtype' );
import ternaryBlockSize = require( '@stdlib/ndarray/base/ternary-tiling-block-size' );
import blockSize = require( '@stdlib/ndarray/base/tiling-block-size' );
import ndarray2array = require( '@stdlib/ndarray/base/to-array' );
import toFlippedlr = require( '@stdlib/ndarray/base/to-flippedlr' );
import toFlippedud = require( '@stdlib/ndarray/base/to-flippedud' );
Expand Down Expand Up @@ -3281,6 +3284,22 @@ interface Namespace {
*/
quaternaryLoopOrder: typeof quaternaryLoopOrder;

/**
* Returns a loop block size for multi-dimensional array tiled loops.
*
* @param dtypeX - first input array data type
* @param dtypeY - second input array data type
* @param dtypeZ - third input array data type
* @param dtypeW - fourth input array data type
* @param dtypeU - output array data type
* @returns block size (in units of elements)
*
* @example
* var bsize = ns.quaternaryBlockSize( 'float64', 'float64', 'float64', 'float64', 'float64' );
* // returns <number>
*/
quaternaryBlockSize: typeof quaternaryBlockSize;

/**
* Reorders ndarray dimensions and associated strides for loop interchange.
*
Expand Down Expand Up @@ -3349,6 +3368,23 @@ interface Namespace {
*/
quinaryLoopOrder: typeof quinaryLoopOrder;

/**
* Returns a loop block size for multi-dimensional array tiled loops.
*
* @param dtypeX - first input array data type
* @param dtypeY - second input array data type
* @param dtypeZ - third input array data type
* @param dtypeW - fourth input array data type
* @param dtypeU - fifth input array data type
* @param dtypeV - output array data type
* @returns block size (in units of elements)
*
* @example
* var bsize = ns.quinaryBlockSize( 'float64', 'float64', 'float64', 'float64', 'float64', 'float64' );
* // returns <number>
*/
quinaryBlockSize: typeof quinaryBlockSize;

/**
* Returns an array without singleton dimensions.
*
Expand Down Expand Up @@ -4371,6 +4407,18 @@ interface Namespace {
*/
ternaryBlockSize: typeof ternaryBlockSize;

/**
* Returns a loop block size for multi-dimensional array tiled loops.
*
* @param dtypes - list of input and output ndarray data types
* @returns block size (in units of elements)
*
* @example
* var bsize = ns.blockSize( [ 'float64', 'float64', 'float64', 'float64' ] );
* // returns <number>
*/
blockSize: typeof blockSize;

/**
* Converts an ndarray buffer to a generic array (which may include nested arrays).
*
Expand Down