Skip to content

Commit 2a37c8e

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 83f1483 commit 2a37c8e

File tree

23 files changed

+1152
-1
lines changed

23 files changed

+1152
-1
lines changed

‎CHANGELOG.md

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<section class="release" id="unreleased">
66

7-
## Unreleased (2025-04-10)
7+
## Unreleased (2025-04-19)
88

99
<section class="packages">
1010

@@ -176,6 +176,28 @@
176176

177177
<!-- /.package -->
178178

179+
<section class="package" id="array-base-banded-unreleased">
180+
181+
#### [@stdlib/array/base/banded](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/banded)
182+
183+
<details>
184+
185+
<section class="features">
186+
187+
##### Features
188+
189+
- [`8213823`](https://github.com/stdlib-js/stdlib/commit/8213823c17f02cc771671778ab3de0205256e33e) - add `array/base/banded` namespace
190+
191+
</section>
192+
193+
<!-- /.features -->
194+
195+
</details>
196+
197+
</section>
198+
199+
<!-- /.package -->
200+
179201
<section class="package" id="array-base-banded-filled2d-by-unreleased">
180202

181203
#### [@stdlib/array/base/banded/filled2d-by](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/banded/filled2d-by)
@@ -1206,6 +1228,50 @@ This release closes the following issue:
12061228

12071229
<!-- /.package -->
12081230

1231+
<section class="package" id="array-base-symmetric-unreleased">
1232+
1233+
#### [@stdlib/array/base/symmetric](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/symmetric)
1234+
1235+
<details>
1236+
1237+
<section class="features">
1238+
1239+
##### Features
1240+
1241+
- [`61b8b4b`](https://github.com/stdlib-js/stdlib/commit/61b8b4b9d65ccda7f6e4b39f7d7b0830b1d8c4f7) - add `array/base/symmetric` namespace
1242+
1243+
</section>
1244+
1245+
<!-- /.features -->
1246+
1247+
</details>
1248+
1249+
</section>
1250+
1251+
<!-- /.package -->
1252+
1253+
<section class="package" id="array-base-symmetric-banded-unreleased">
1254+
1255+
#### [@stdlib/array/base/symmetric-banded](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/symmetric-banded)
1256+
1257+
<details>
1258+
1259+
<section class="features">
1260+
1261+
##### Features
1262+
1263+
- [`c58adef`](https://github.com/stdlib-js/stdlib/commit/c58adefe40e133648a8ccdbbea987fde9b6e9bd8) - add `array/base/symmetric-banded` namespace
1264+
1265+
</section>
1266+
1267+
<!-- /.features -->
1268+
1269+
</details>
1270+
1271+
</section>
1272+
1273+
<!-- /.package -->
1274+
12091275
<section class="package" id="array-base-symmetric-banded-filled2d-by-unreleased">
12101276

12111277
#### [@stdlib/array/base/symmetric-banded/filled2d-by](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/symmetric-banded/filled2d-by)
@@ -1693,6 +1759,9 @@ A total of 14 people contributed to this release. Thank you to the following con
16931759

16941760
<details>
16951761

1762+
- [`c58adef`](https://github.com/stdlib-js/stdlib/commit/c58adefe40e133648a8ccdbbea987fde9b6e9bd8) - **feat:** add `array/base/symmetric-banded` namespace _(by Athan Reines)_
1763+
- [`61b8b4b`](https://github.com/stdlib-js/stdlib/commit/61b8b4b9d65ccda7f6e4b39f7d7b0830b1d8c4f7) - **feat:** add `array/base/symmetric` namespace _(by Athan Reines)_
1764+
- [`8213823`](https://github.com/stdlib-js/stdlib/commit/8213823c17f02cc771671778ab3de0205256e33e) - **feat:** add `array/base/banded` namespace _(by Athan Reines)_
16961765
- [`ae78e67`](https://github.com/stdlib-js/stdlib/commit/ae78e67351f0fdd6c42988d32d48bab0ae6ec65c) - **feat:** add `array/base/count-ifs` [(#5952)](https://github.com/stdlib-js/stdlib/pull/5952) _(by Muhammad Haris, Athan Reines)_
16971766
- [`b0da3de`](https://github.com/stdlib-js/stdlib/commit/b0da3de9a0fa3d1e657ee5a05dcca053fe74e515) - **feat:** `add array/base/linspace2d` [(#5464)](https://github.com/stdlib-js/stdlib/pull/5464) _(by Muhammad Haris, Athan Reines, stdlib-bot)_
16981767
- [`40de89d`](https://github.com/stdlib-js/stdlib/commit/40de89d0b84ab345f198d6a90696c0762efde887) - **feat:** add `array/base/reshape` [(#5639)](https://github.com/stdlib-js/stdlib/pull/5639) _(by Muhammad Haris, Athan Reines)_

‎CONTRIBUTORS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Dorrin Sotoudeh <[email protected]>
5151
EuniceSim142 <[email protected]>
5252
Frank Kovacs <[email protected]>
5353
GK Bishnoi <[email protected]>
54+
GURU PRASAD SHARMA <[email protected]>
5455
Gaurav <[email protected]>
5556
Gautam sharma <[email protected]>
5657
Golden Kumar <[email protected]>
@@ -180,6 +181,7 @@ Yuvi Mittal <[email protected]>
180181
ditsu <[email protected]>
181182
ekambains <[email protected]>
182183
fadiothman22 <[email protected]>
184+
iraandrushko <[email protected]>
183185
lohithganni <[email protected]>
184186
olenkabilonizhka <[email protected]>
185187
pranav-1720 <[email protected]>

‎base/banded/README.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# Banded Arrays
22+
23+
> Banded array utilities.
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var ns = require( '@stdlib/array/base/banded' );
41+
```
42+
43+
#### ns
44+
45+
Namespace containing banded array utilities.
46+
47+
```javascript
48+
var o = ns;
49+
// returns {...}
50+
```
51+
52+
The namespace exports the following:
53+
54+
<!-- <toc pattern="*"> -->
55+
56+
<!-- </toc> -->
57+
58+
</section>
59+
60+
<!-- /.usage -->
61+
62+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
63+
64+
<section class="notes">
65+
66+
</section>
67+
68+
<!-- /.notes -->
69+
70+
<!-- Package usage examples. -->
71+
72+
<section class="examples">
73+
74+
## Examples
75+
76+
<!-- TODO: better examples -->
77+
78+
<!-- eslint no-undef: "error" -->
79+
80+
```javascript
81+
var objectKeys = require( '@stdlib/utils/keys' );
82+
var ns = require( '@stdlib/array/base/banded' );
83+
84+
console.log( objectKeys( ns ) );
85+
```
86+
87+
</section>
88+
89+
<!-- /.examples -->
90+
91+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
92+
93+
<section class="related">
94+
95+
</section>
96+
97+
<!-- /.related -->
98+
99+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
100+
101+
<section class="links">
102+
103+
</section>
104+
105+
<!-- /.links -->

‎base/banded/docs/types/index.d.ts

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/* eslint-disable max-lines */
22+
23+
import filled2dBy = require( './../../../../base/banded/filled2d-by' );
24+
25+
/**
26+
* Interface describing a namespace.
27+
*/
28+
interface Namespace {
29+
/**
30+
* TODO
31+
*/
32+
filled2dBy: typeof filled2dBy;
33+
}
34+
35+
/**
36+
* Banded array utilities.
37+
*/
38+
declare var ns: Namespace;
39+
40+
41+
// EXPORTS //
42+
43+
export = ns;

‎base/banded/docs/types/test.ts

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
/* eslint-disable @typescript-eslint/no-unused-expressions */
20+
21+
import ns = require( './index' );
22+
23+
24+
// TESTS //
25+
26+
// The exported value is the expected interface...
27+
{
28+
ns; // $ExpectType Namespace
29+
}

‎base/banded/examples/index.js

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
var objectKeys = require( '@stdlib/utils/keys' );
22+
var ns = require( './../lib' );
23+
24+
console.log( objectKeys( ns ) );

‎base/banded/lib/index.js

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
/*
22+
* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
23+
*/
24+
25+
// MODULES //
26+
27+
var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
28+
29+
30+
// MAIN //
31+
32+
/**
33+
* Namespace.
34+
*
35+
* @namespace ns
36+
*/
37+
var ns = {};
38+
39+
/**
40+
* @name filled2dBy
41+
* @memberof ns
42+
* @readonly
43+
* @type {Function}
44+
* @see {@link module:@stdlib/array/base/banded/filled2d-by}
45+
*/
46+
setReadOnly( ns, 'filled2dBy', require( './../../../base/banded/filled2d-by' ) );
47+
48+
/**
49+
* @name toCompact
50+
* @memberof ns
51+
* @readonly
52+
* @type {Function}
53+
* @see {@link module:@stdlib/array/base/banded/to-compact}
54+
*/
55+
setReadOnly( ns, 'toCompact', require( './../../../base/banded/to-compact' ) );
56+
57+
58+
// EXPORTS //
59+
60+
module.exports = ns;

0 commit comments

Comments
 (0)