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 Jan 12, 2025
1 parent 0d2e9ef commit 79d5c10
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 148 deletions.
3 changes: 0 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@

##### Features

- [`e661213`](https://github.com/stdlib-js/stdlib/commit/e66121352ef767cdb87d19e938b1eccf7970fa3a) - update namespace TypeScript declarations [(#4706)](https://github.com/stdlib-js/stdlib/pull/4706)
- [`741b6f1`](https://github.com/stdlib-js/stdlib/commit/741b6f1df8ce11e77fb22c279cee6bbae3323176) - add `spreadDimensions` to namespace
- [`908239e`](https://github.com/stdlib-js/stdlib/commit/908239e7cc6b4b3e260d0cc1f5aebb9af35d83c6) - add `toUniqueNormalizedIndices` to namespace
- [`524e854`](https://github.com/stdlib-js/stdlib/commit/524e854202862d5b37d66470d719fac1270e33c1) - add `toNormalizedIndices` to namespace
Expand Down Expand Up @@ -130,7 +129,6 @@

##### Features

- [`e661213`](https://github.com/stdlib-js/stdlib/commit/e66121352ef767cdb87d19e938b1eccf7970fa3a) - update namespace TypeScript declarations [(#4706)](https://github.com/stdlib-js/stdlib/pull/4706)
- [`a94dcea`](https://github.com/stdlib-js/stdlib/commit/a94dceaa9469c774ee4622567e4c15a15e215bcf) - add `isColumnMajorString` to namespace
- [`5e1be08`](https://github.com/stdlib-js/stdlib/commit/5e1be08ff661fb981dc4a91c2e9d37d7396327f5) - add `isRowMajorString` to namespace
- [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190)
Expand Down Expand Up @@ -756,7 +754,6 @@ A total of 3 people contributed to this release. Thank you to the following cont

<details>

- [`e661213`](https://github.com/stdlib-js/stdlib/commit/e66121352ef767cdb87d19e938b1eccf7970fa3a) - **feat:** update namespace TypeScript declarations [(#4706)](https://github.com/stdlib-js/stdlib/pull/4706) _(by stdlib-bot)_
- [`cff470f`](https://github.com/stdlib-js/stdlib/commit/cff470f9608165100c8c122fce70c40b1af864ec) - **docs:** update namespace table of contents (#4708) _(by stdlib-bot, Planeshifter)_
- [`741b6f1`](https://github.com/stdlib-js/stdlib/commit/741b6f1df8ce11e77fb22c279cee6bbae3323176) - **feat:** add `spreadDimensions` to namespace _(by Athan Reines)_
- [`3767255`](https://github.com/stdlib-js/stdlib/commit/3767255c7cfe85f09cea5c007e21297cd628245d) - **feat:** add `ndarray/base/spread-dimensions` _(by Athan Reines)_
Expand Down
38 changes: 0 additions & 38 deletions base/assert/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ import isBufferLengthCompatibleShape = require( './../../../../base/assert/is-bu
import isCastingMode = require( './../../../../base/assert/is-casting-mode' );
import isColumnMajor = require( './../../../../base/assert/is-column-major' );
import isColumnMajorContiguous = require( './../../../../base/assert/is-column-major-contiguous' );
import isColumnMajorString = require( './../../../../base/assert/is-column-major-string' );
import isComplexFloatingPointDataType = require( './../../../../base/assert/is-complex-floating-point-data-type' );
import isContiguous = require( './../../../../base/assert/is-contiguous' );
import isDataType = require( './../../../../base/assert/is-data-type' );
Expand All @@ -43,7 +42,6 @@ import isRealDataType = require( './../../../../base/assert/is-real-data-type' )
import isRealFloatingPointDataType = require( './../../../../base/assert/is-real-floating-point-data-type' );
import isRowMajor = require( './../../../../base/assert/is-row-major' );
import isRowMajorContiguous = require( './../../../../base/assert/is-row-major-contiguous' );
import isRowMajorString = require( './../../../../base/assert/is-row-major-string' );
import isSafeDataTypeCast = require( './../../../../base/assert/is-safe-data-type-cast' );
import isSameKindDataTypeCast = require( './../../../../base/assert/is-same-kind-data-type-cast' );
import isSignedIntegerDataType = require( './../../../../base/assert/is-signed-integer-data-type' );
Expand Down Expand Up @@ -264,24 +262,6 @@ interface Namespace {
*/
isColumnMajorContiguous: typeof isColumnMajorContiguous;

/**
* Tests whether an input value is the string representing column-major order.
*
* @param v - value to test
* @returns boolean result
*
* @example
* var bool = ns.isColumnMajorString( 'column-major' );
* // returns true
*
* bool = ns.isColumnMajorString( 'row-major' );
* // returns false
*
* bool = ns.isColumnMajorString( 'foo' );
* // returns false
*/
isColumnMajorString: typeof isColumnMajorString;

/**
* Tests whether an input value is a supported ndarray complex-valued floating-point data type.
*
Expand Down Expand Up @@ -767,24 +747,6 @@ interface Namespace {
*/
isRowMajorContiguous: typeof isRowMajorContiguous;

/**
* Tests whether an input value is the string representing row-major order.
*
* @param v - value to test
* @returns boolean result
*
* @example
* var bool = ns.isRowMajorString( 'row-major' );
* // returns true
*
* bool = ns.isRowMajorString( 'column-major' );
* // returns false
*
* bool = ns.isRowMajorString( 'foo' );
* // returns false
*/
isRowMajorString: typeof isRowMajorString;

/**
* Returns a boolean indicating if a provided ndarray data type can be safely cast to another ndarray data type.
*
Expand Down
107 changes: 0 additions & 107 deletions base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ import ndims = require( './../../../base/ndims' );
import nextCartesianIndex = require( './../../../base/next-cartesian-index' );
import nonsingletonDimensions = require( './../../../base/nonsingleton-dimensions' );
import normalizeIndex = require( './../../../base/normalize-index' );
import normalizeIndices = require( './../../../base/normalize-indices' );
import nullary = require( './../../../base/nullary' );
import nullaryLoopOrder = require( './../../../base/nullary-loop-interchange-order' );
import nullaryBlockSize = require( './../../../base/nullary-tiling-block-size' );
Expand All @@ -103,16 +102,13 @@ import sliceDimensionFrom = require( './../../../base/slice-dimension-from' );
import sliceDimensionTo = require( './../../../base/slice-dimension-to' );
import sliceFrom = require( './../../../base/slice-from' );
import sliceTo = require( './../../../base/slice-to' );
import spreadDimensions = require( './../../../base/spread-dimensions' );
import stride = require( './../../../base/stride' );
import strides = require( './../../../base/strides' );
import strides2offset = require( './../../../base/strides2offset' );
import strides2order = require( './../../../base/strides2order' );
import sub2ind = require( './../../../base/sub2ind' );
import ndarray2array = require( './../../../base/to-array' );
import toNormalizedIndices = require( './../../../base/to-normalized-indices' );
import toReversed = require( './../../../base/to-reversed' );
import toUniqueNormalizedIndices = require( './../../../base/to-unique-normalized-indices' );
import transpose = require( './../../../base/transpose' );
import unary = require( './../../../base/unary' );
import unaryBy = require( './../../../base/unary-by' );
Expand Down Expand Up @@ -1869,27 +1865,6 @@ interface Namespace {
*/
normalizeIndex: typeof normalizeIndex;

/**
* Normalizes a list of indices to the interval `[0,max]`.
*
* ## Notes
*
* - If provided an out-of-bounds index, the function returns `null`.
* - The function mutates the input array, even when provided an out-of-bounds index.
*
* @param indices - indices
* @param max - maximum index
* @returns normalized indices or null
*
* @example
* var indices = ns.normalizeIndices( [ -2, 5 ], 10 );
* // returns [ 9, 5 ]
*
* indices = ns.normalizeIndices( [ -2, 15 ], 10 );
* // returns null
*/
normalizeIndices: typeof normalizeIndices;

/**
* Applies a nullary callback and assigns results to elements in an output ndarray.
*
Expand Down Expand Up @@ -2687,48 +2662,6 @@ interface Namespace {
*/
sliceTo: typeof sliceTo;

/**
* Expands the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions.
*
* ## Notes
*
* - Each provided dimension index must reside on the interval `[-ndims, ndims-1]`. If provided a negative dimension index, the position at which to place a respective dimension is computed as `ndims + index`.
* - Provided dimension indices must resolve to normalized dimension indices arranged in ascending order.
*
* @param ndims - number of dimensions in the output array
* @param x - input array
* @param dims - dimension indices
* @returns output array
*
* @example
* var array = require( './../../../array' );
*
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
* // returns <ndarray>
*
* var shx = x.shape;
* // returns [ 2, 2 ]
*
* var y = ns.spreadDimensions( 5, x, [ 1, 3 ] );
* // returns <ndarray>
*
* var shy = y.shape;
* // returns [ 1, 2, 1, 2, 1 ]
*
* var v = y.get( 0, 0, 0, 0, 0 );
* // returns 1
*
* v = y.get( 0, 0, 0, 1, 0 );
* // returns 2
*
* v = y.get( 0, 1, 0, 0, 0 );
* // returns 3
*
* v = y.get( 0, 1, 0, 1, 0 );
* // returns 4
*/
spreadDimensions: typeof spreadDimensions;

/**
* Returns the stride along a specified dimension for a provided ndarray.
*
Expand Down Expand Up @@ -2932,26 +2865,6 @@ interface Namespace {
*/
ndarray2array: typeof ndarray2array;

/**
* Normalizes a list of indices to the interval `[0,max]`.
*
* ## Notes
*
* - If provided an out-of-bounds index, the function normalizes the index to `-1`.
*
* @param indices - indices
* @param max - maximum index
* @returns normalized indices
*
* @example
* var indices = ns.toNormalizedIndices( [ -2, 5 ], 10 );
* // returns [ 9, 5 ]
*
* indices = ns.toNormalizedIndices( [ -2, 15 ], 10 );
* // returns [ 9, -1 ]
*/
toNormalizedIndices: typeof toNormalizedIndices;

/**
* Returns a new ndarray where the order of elements of an input ndarray is reversed along each dimension.
*
Expand Down Expand Up @@ -2988,26 +2901,6 @@ interface Namespace {
*/
toReversed: typeof toReversed;

/**
* Returns a list of unique indices after normalizing to the interval `[0,max]`.
*
* ## Notes
*
* - If provided an out-of-bounds index, the function returns `null`.
*
* @param indices - indices
* @param max - maximum index
* @returns normalized indices (or null)
*
* @example
* var indices = ns.toUniqueNormalizedIndices( [ -2, 5 ], 10 );
* // returns [ 9, 5 ]
*
* indices = ns.toUniqueNormalizedIndices( [ -2, 15 ], 10 );
* // returns null
*/
toUniqueNormalizedIndices: typeof toUniqueNormalizedIndices;

/**
* Transposes a matrix (or a stack of matrices).
*
Expand Down

0 comments on commit 79d5c10

Please sign in to comment.