Skip to content

Commit bd63e14

Browse files
committed
Auto-generated commit
1 parent bc273fb commit bd63e14

7 files changed

Lines changed: 45 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
### Features
1212

13+
- [`bbac071`](https://github.com/stdlib-js/stdlib/commit/bbac07144b6a85eb308745484ad491ce45bcd0f8) - add `atleast1d`, `atleast2d`, and `atleast3d` to namespace
14+
- [`7352d14`](https://github.com/stdlib-js/stdlib/commit/7352d144ee581fe70403014ce705c1463a23e171) - add `rowcat` to namespace
1315
- [`7633424`](https://github.com/stdlib-js/stdlib/commit/7633424ed747388a8b509d88a890372486c96aa3) - add `ndarray/base/atleast3d` [(#11548)](https://github.com/stdlib-js/stdlib/pull/11548)
1416
- [`7d01b62`](https://github.com/stdlib-js/stdlib/commit/7d01b625eefc60a1044b721a3cf619b70b2bcbfd) - add `ndarray/base/atleast1d` [(#11540)](https://github.com/stdlib-js/stdlib/pull/11540)
1517
- [`f0ac25a`](https://github.com/stdlib-js/stdlib/commit/f0ac25a6707662e3d5903146f6bcf47a74daa029) - add `ndarray/base/atleast2d` [(#11541)](https://github.com/stdlib-js/stdlib/pull/11541)
@@ -854,6 +856,9 @@ A total of 49 issues were closed in this release:
854856

855857
<details>
856858

859+
- [`3a73d93`](https://github.com/stdlib-js/stdlib/commit/3a73d932e39d6603c57d8e62de4aba731ffa2fba) - **docs:** update notes _(by Athan Reines)_
860+
- [`bbac071`](https://github.com/stdlib-js/stdlib/commit/bbac07144b6a85eb308745484ad491ce45bcd0f8) - **feat:** add `atleast1d`, `atleast2d`, and `atleast3d` to namespace _(by Athan Reines)_
861+
- [`7352d14`](https://github.com/stdlib-js/stdlib/commit/7352d144ee581fe70403014ce705c1463a23e171) - **feat:** add `rowcat` to namespace _(by Athan Reines)_
857862
- [`7633424`](https://github.com/stdlib-js/stdlib/commit/7633424ed747388a8b509d88a890372486c96aa3) - **feat:** add `ndarray/base/atleast3d` [(#11548)](https://github.com/stdlib-js/stdlib/pull/11548) _(by Muhammad Haris)_
858863
- [`7d01b62`](https://github.com/stdlib-js/stdlib/commit/7d01b625eefc60a1044b721a3cf619b70b2bcbfd) - **feat:** add `ndarray/base/atleast1d` [(#11540)](https://github.com/stdlib-js/stdlib/pull/11540) _(by Muhammad Haris)_
859864
- [`f0ac25a`](https://github.com/stdlib-js/stdlib/commit/f0ac25a6707662e3d5903146f6bcf47a74daa029) - **feat:** add `ndarray/base/atleast2d` [(#11541)](https://github.com/stdlib-js/stdlib/pull/11541) _(by Muhammad Haris)_

base/atleast1d/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The function accepts the following arguments:
6666

6767
## Notes
6868

69-
- If a provided ndarray has fewer than one dimension, the returned ndarray is a view on the input ndarray data buffer. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the view may affect multiple elements. If you need to write to the returned ndarray, copy the ndarray **before** performing operations which may mutate elements.
69+
- If a provided ndarray has fewer than one dimension, the function prepends singleton dimensions, and the returned ndarray is a view on the input ndarray data buffer.
7070

7171
- The returned ndarray is a "base" [ndarray][@stdlib/ndarray/base/ctor], and, thus, the returned [ndarray][@stdlib/ndarray/base/ctor] does not perform bounds checking or afford any of the guarantees of the non-base [ndarray][@stdlib/ndarray/ctor] constructor. The primary intent of this function is to broadcast an ndarray-like object within internal implementations and to do so with minimal overhead.
7272

base/atleast2d/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The function accepts the following arguments:
6666

6767
## Notes
6868

69-
- If a provided ndarray has fewer than two dimensions, the returned ndarray is a view on the input ndarray data buffer. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the view may affect multiple elements. If you need to write to the returned ndarray, copy the ndarray **before** performing operations which may mutate elements.
69+
- If a provided ndarray has fewer than two dimensions, the function prepends singleton dimensions, and the returned ndarray is a view on the input ndarray data buffer.
7070

7171
- The returned ndarray is a "base" [ndarray][@stdlib/ndarray/base/ctor], and, thus, the returned [ndarray][@stdlib/ndarray/base/ctor] does not perform bounds checking or afford any of the guarantees of the non-base [ndarray][@stdlib/ndarray/ctor] constructor. The primary intent of this function is to broadcast an ndarray-like object within internal implementations and to do so with minimal overhead.
7272

base/atleast3d/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The function accepts the following arguments:
6666

6767
## Notes
6868

69-
- If a provided ndarray has fewer than three dimensions, the returned ndarray is a view on the input ndarray data buffer. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the view may affect multiple elements. If you need to write to the returned ndarray, copy the ndarray **before** performing operations which may mutate elements.
69+
- If a provided ndarray has fewer than three dimensions, the function prepends singleton dimensions, and the returned ndarray is a view on the input ndarray data buffer.
7070

7171
- The returned ndarray is a "base" [ndarray][@stdlib/ndarray/base/ctor], and, thus, the returned [ndarray][@stdlib/ndarray/base/ctor] does not perform bounds checking or afford any of the guarantees of the non-base [ndarray][@stdlib/ndarray/ctor] constructor. The primary intent of this function is to broadcast an ndarray-like object within internal implementations and to do so with minimal overhead.
7272

base/atleastnd/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The function accepts the following arguments:
6666

6767
## Notes
6868

69-
- If a provided ndarray has fewer dimensions than `ndims`, the returned ndarray is a view on the input ndarray data buffer. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the view may affect multiple elements. If you need to write to the returned ndarray, copy the ndarray **before** performing operations which may mutate elements.
69+
- If a provided ndarray has fewer dimensions than `ndims`, the function prepends singleton dimensions, and the returned ndarray is a view on the input ndarray data buffer.
7070

7171
- The returned ndarray is a "base" [ndarray][@stdlib/ndarray/base/ctor], and, thus, the returned [ndarray][@stdlib/ndarray/base/ctor] does not perform bounds checking or afford any of the guarantees of the non-base [ndarray][@stdlib/ndarray/ctor] constructor. The primary intent of this function is to broadcast an ndarray-like object within internal implementations and to do so with minimal overhead.
7272

base/lib/index.js

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,33 @@ setReadOnly( ns, 'assign', require( './../../base/assign' ) );
8585
*/
8686
setReadOnly( ns, 'assignScalar', require( './../../base/assign-scalar' ) );
8787

88+
/**
89+
* @name atleast1d
90+
* @memberof ns
91+
* @readonly
92+
* @type {Function}
93+
* @see {@link module:@stdlib/ndarray/base/atleast1d}
94+
*/
95+
setReadOnly( ns, 'atleast1d', require( './../../base/atleast1d' ) );
96+
97+
/**
98+
* @name atleast2d
99+
* @memberof ns
100+
* @readonly
101+
* @type {Function}
102+
* @see {@link module:@stdlib/ndarray/base/atleast2d}
103+
*/
104+
setReadOnly( ns, 'atleast2d', require( './../../base/atleast2d' ) );
105+
106+
/**
107+
* @name atleast3d
108+
* @memberof ns
109+
* @readonly
110+
* @type {Function}
111+
* @see {@link module:@stdlib/ndarray/base/atleast3d}
112+
*/
113+
setReadOnly( ns, 'atleast3d', require( './../../base/atleast3d' ) );
114+
88115
/**
89116
* @name atleastnd
90117
* @memberof ns

lib/index.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -711,6 +711,15 @@ setReadOnly( ns, 'reverse', require( './../reverse' ) );
711711
*/
712712
setReadOnly( ns, 'reverseDimension', require( './../reverse-dimension' ) );
713713

714+
/**
715+
* @name rowcat
716+
* @memberof ns
717+
* @readonly
718+
* @type {Function}
719+
* @see {@link module:@stdlib/ndarray/rowcat}
720+
*/
721+
setReadOnly( ns, 'rowcat', require( './../rowcat' ) );
722+
714723
/**
715724
* @name safeCasts
716725
* @memberof ns

0 commit comments

Comments
 (0)