Skip to content

Commit 79d5c10

Browse files
committed
Auto-generated commit
1 parent 0d2e9ef commit 79d5c10

File tree

3 files changed

+0
-148
lines changed

3 files changed

+0
-148
lines changed

CHANGELOG.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@
8686

8787
##### Features
8888

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

131130
##### Features
132131

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

757755
<details>
758756

759-
- [`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)_
760757
- [`cff470f`](https://github.com/stdlib-js/stdlib/commit/cff470f9608165100c8c122fce70c40b1af864ec) - **docs:** update namespace table of contents (#4708) _(by stdlib-bot, Planeshifter)_
761758
- [`741b6f1`](https://github.com/stdlib-js/stdlib/commit/741b6f1df8ce11e77fb22c279cee6bbae3323176) - **feat:** add `spreadDimensions` to namespace _(by Athan Reines)_
762759
- [`3767255`](https://github.com/stdlib-js/stdlib/commit/3767255c7cfe85f09cea5c007e21297cd628245d) - **feat:** add `ndarray/base/spread-dimensions` _(by Athan Reines)_

base/assert/docs/types/index.d.ts

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ import isBufferLengthCompatibleShape = require( './../../../../base/assert/is-bu
2828
import isCastingMode = require( './../../../../base/assert/is-casting-mode' );
2929
import isColumnMajor = require( './../../../../base/assert/is-column-major' );
3030
import isColumnMajorContiguous = require( './../../../../base/assert/is-column-major-contiguous' );
31-
import isColumnMajorString = require( './../../../../base/assert/is-column-major-string' );
3231
import isComplexFloatingPointDataType = require( './../../../../base/assert/is-complex-floating-point-data-type' );
3332
import isContiguous = require( './../../../../base/assert/is-contiguous' );
3433
import isDataType = require( './../../../../base/assert/is-data-type' );
@@ -43,7 +42,6 @@ import isRealDataType = require( './../../../../base/assert/is-real-data-type' )
4342
import isRealFloatingPointDataType = require( './../../../../base/assert/is-real-floating-point-data-type' );
4443
import isRowMajor = require( './../../../../base/assert/is-row-major' );
4544
import isRowMajorContiguous = require( './../../../../base/assert/is-row-major-contiguous' );
46-
import isRowMajorString = require( './../../../../base/assert/is-row-major-string' );
4745
import isSafeDataTypeCast = require( './../../../../base/assert/is-safe-data-type-cast' );
4846
import isSameKindDataTypeCast = require( './../../../../base/assert/is-same-kind-data-type-cast' );
4947
import isSignedIntegerDataType = require( './../../../../base/assert/is-signed-integer-data-type' );
@@ -264,24 +262,6 @@ interface Namespace {
264262
*/
265263
isColumnMajorContiguous: typeof isColumnMajorContiguous;
266264

267-
/**
268-
* Tests whether an input value is the string representing column-major order.
269-
*
270-
* @param v - value to test
271-
* @returns boolean result
272-
*
273-
* @example
274-
* var bool = ns.isColumnMajorString( 'column-major' );
275-
* // returns true
276-
*
277-
* bool = ns.isColumnMajorString( 'row-major' );
278-
* // returns false
279-
*
280-
* bool = ns.isColumnMajorString( 'foo' );
281-
* // returns false
282-
*/
283-
isColumnMajorString: typeof isColumnMajorString;
284-
285265
/**
286266
* Tests whether an input value is a supported ndarray complex-valued floating-point data type.
287267
*
@@ -767,24 +747,6 @@ interface Namespace {
767747
*/
768748
isRowMajorContiguous: typeof isRowMajorContiguous;
769749

770-
/**
771-
* Tests whether an input value is the string representing row-major order.
772-
*
773-
* @param v - value to test
774-
* @returns boolean result
775-
*
776-
* @example
777-
* var bool = ns.isRowMajorString( 'row-major' );
778-
* // returns true
779-
*
780-
* bool = ns.isRowMajorString( 'column-major' );
781-
* // returns false
782-
*
783-
* bool = ns.isRowMajorString( 'foo' );
784-
* // returns false
785-
*/
786-
isRowMajorString: typeof isRowMajorString;
787-
788750
/**
789751
* Returns a boolean indicating if a provided ndarray data type can be safely cast to another ndarray data type.
790752
*

base/docs/types/index.d.ts

Lines changed: 0 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ import ndims = require( './../../../base/ndims' );
7676
import nextCartesianIndex = require( './../../../base/next-cartesian-index' );
7777
import nonsingletonDimensions = require( './../../../base/nonsingleton-dimensions' );
7878
import normalizeIndex = require( './../../../base/normalize-index' );
79-
import normalizeIndices = require( './../../../base/normalize-indices' );
8079
import nullary = require( './../../../base/nullary' );
8180
import nullaryLoopOrder = require( './../../../base/nullary-loop-interchange-order' );
8281
import nullaryBlockSize = require( './../../../base/nullary-tiling-block-size' );
@@ -103,16 +102,13 @@ import sliceDimensionFrom = require( './../../../base/slice-dimension-from' );
103102
import sliceDimensionTo = require( './../../../base/slice-dimension-to' );
104103
import sliceFrom = require( './../../../base/slice-from' );
105104
import sliceTo = require( './../../../base/slice-to' );
106-
import spreadDimensions = require( './../../../base/spread-dimensions' );
107105
import stride = require( './../../../base/stride' );
108106
import strides = require( './../../../base/strides' );
109107
import strides2offset = require( './../../../base/strides2offset' );
110108
import strides2order = require( './../../../base/strides2order' );
111109
import sub2ind = require( './../../../base/sub2ind' );
112110
import ndarray2array = require( './../../../base/to-array' );
113-
import toNormalizedIndices = require( './../../../base/to-normalized-indices' );
114111
import toReversed = require( './../../../base/to-reversed' );
115-
import toUniqueNormalizedIndices = require( './../../../base/to-unique-normalized-indices' );
116112
import transpose = require( './../../../base/transpose' );
117113
import unary = require( './../../../base/unary' );
118114
import unaryBy = require( './../../../base/unary-by' );
@@ -1869,27 +1865,6 @@ interface Namespace {
18691865
*/
18701866
normalizeIndex: typeof normalizeIndex;
18711867

1872-
/**
1873-
* Normalizes a list of indices to the interval `[0,max]`.
1874-
*
1875-
* ## Notes
1876-
*
1877-
* - If provided an out-of-bounds index, the function returns `null`.
1878-
* - The function mutates the input array, even when provided an out-of-bounds index.
1879-
*
1880-
* @param indices - indices
1881-
* @param max - maximum index
1882-
* @returns normalized indices or null
1883-
*
1884-
* @example
1885-
* var indices = ns.normalizeIndices( [ -2, 5 ], 10 );
1886-
* // returns [ 9, 5 ]
1887-
*
1888-
* indices = ns.normalizeIndices( [ -2, 15 ], 10 );
1889-
* // returns null
1890-
*/
1891-
normalizeIndices: typeof normalizeIndices;
1892-
18931868
/**
18941869
* Applies a nullary callback and assigns results to elements in an output ndarray.
18951870
*
@@ -2687,48 +2662,6 @@ interface Namespace {
26872662
*/
26882663
sliceTo: typeof sliceTo;
26892664

2690-
/**
2691-
* 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.
2692-
*
2693-
* ## Notes
2694-
*
2695-
* - 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`.
2696-
* - Provided dimension indices must resolve to normalized dimension indices arranged in ascending order.
2697-
*
2698-
* @param ndims - number of dimensions in the output array
2699-
* @param x - input array
2700-
* @param dims - dimension indices
2701-
* @returns output array
2702-
*
2703-
* @example
2704-
* var array = require( './../../../array' );
2705-
*
2706-
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
2707-
* // returns <ndarray>
2708-
*
2709-
* var shx = x.shape;
2710-
* // returns [ 2, 2 ]
2711-
*
2712-
* var y = ns.spreadDimensions( 5, x, [ 1, 3 ] );
2713-
* // returns <ndarray>
2714-
*
2715-
* var shy = y.shape;
2716-
* // returns [ 1, 2, 1, 2, 1 ]
2717-
*
2718-
* var v = y.get( 0, 0, 0, 0, 0 );
2719-
* // returns 1
2720-
*
2721-
* v = y.get( 0, 0, 0, 1, 0 );
2722-
* // returns 2
2723-
*
2724-
* v = y.get( 0, 1, 0, 0, 0 );
2725-
* // returns 3
2726-
*
2727-
* v = y.get( 0, 1, 0, 1, 0 );
2728-
* // returns 4
2729-
*/
2730-
spreadDimensions: typeof spreadDimensions;
2731-
27322665
/**
27332666
* Returns the stride along a specified dimension for a provided ndarray.
27342667
*
@@ -2932,26 +2865,6 @@ interface Namespace {
29322865
*/
29332866
ndarray2array: typeof ndarray2array;
29342867

2935-
/**
2936-
* Normalizes a list of indices to the interval `[0,max]`.
2937-
*
2938-
* ## Notes
2939-
*
2940-
* - If provided an out-of-bounds index, the function normalizes the index to `-1`.
2941-
*
2942-
* @param indices - indices
2943-
* @param max - maximum index
2944-
* @returns normalized indices
2945-
*
2946-
* @example
2947-
* var indices = ns.toNormalizedIndices( [ -2, 5 ], 10 );
2948-
* // returns [ 9, 5 ]
2949-
*
2950-
* indices = ns.toNormalizedIndices( [ -2, 15 ], 10 );
2951-
* // returns [ 9, -1 ]
2952-
*/
2953-
toNormalizedIndices: typeof toNormalizedIndices;
2954-
29552868
/**
29562869
* Returns a new ndarray where the order of elements of an input ndarray is reversed along each dimension.
29572870
*
@@ -2988,26 +2901,6 @@ interface Namespace {
29882901
*/
29892902
toReversed: typeof toReversed;
29902903

2991-
/**
2992-
* Returns a list of unique indices after normalizing to the interval `[0,max]`.
2993-
*
2994-
* ## Notes
2995-
*
2996-
* - If provided an out-of-bounds index, the function returns `null`.
2997-
*
2998-
* @param indices - indices
2999-
* @param max - maximum index
3000-
* @returns normalized indices (or null)
3001-
*
3002-
* @example
3003-
* var indices = ns.toUniqueNormalizedIndices( [ -2, 5 ], 10 );
3004-
* // returns [ 9, 5 ]
3005-
*
3006-
* indices = ns.toUniqueNormalizedIndices( [ -2, 15 ], 10 );
3007-
* // returns null
3008-
*/
3009-
toUniqueNormalizedIndices: typeof toUniqueNormalizedIndices;
3010-
30112904
/**
30122905
* Transposes a matrix (or a stack of matrices).
30132906
*

0 commit comments

Comments
 (0)