Skip to content

Commit 8979958

Browse files
committed
Auto-generated commit
1 parent ff6895c commit 8979958

2 files changed

Lines changed: 46 additions & 5 deletions

File tree

CHANGELOG.md

Lines changed: 27 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-02-25)
7+
## Unreleased (2025-02-27)
88

99
<section class="packages">
1010

@@ -20,12 +20,25 @@
2020

2121
##### Features
2222

23+
- [`2f0aa48`](https://github.com/stdlib-js/stdlib/commit/2f0aa48ef6d561779d4bd4c4a54fe00a5a26c0e1) - update namespace TypeScript declarations [(#5436)](https://github.com/stdlib-js/stdlib/pull/5436)
2324
- [`7aa1502`](https://github.com/stdlib-js/stdlib/commit/7aa150232101abdd4b45c713dfaa71811fcdf850) - add `math/array/special`
2425

2526
</section>
2627

2728
<!-- /.features -->
2829

30+
<section class="breaking-changes">
31+
32+
##### BREAKING CHANGES
33+
34+
- [`2f0aa48`](https://github.com/stdlib-js/stdlib/commit/2f0aa48ef6d561779d4bd4c4a54fe00a5a26c0e1): remove `mulf` symbol
35+
36+
- To migrate, users should access the same symbol via the `number/float32/base` namespace.
37+
38+
</section>
39+
40+
<!-- /.breaking-changes -->
41+
2942
</details>
3043

3144
</section>
@@ -58,6 +71,18 @@
5871

5972
<!-- /.packages -->
6073

74+
<section class="breaking-changes">
75+
76+
### BREAKING CHANGES
77+
78+
- [`2f0aa48`](https://github.com/stdlib-js/stdlib/commit/2f0aa48ef6d561779d4bd4c4a54fe00a5a26c0e1): remove `mulf` symbol
79+
80+
- To migrate, users should access the same symbol via the `number/float32/base` namespace.
81+
82+
</section>
83+
84+
<!-- /.breaking-changes -->
85+
6186
<section class="contributors">
6287

6388
### Contributors
@@ -77,6 +102,7 @@ A total of 2 people contributed to this release. Thank you to the following cont
77102

78103
<details>
79104

105+
- [`2f0aa48`](https://github.com/stdlib-js/stdlib/commit/2f0aa48ef6d561779d4bd4c4a54fe00a5a26c0e1) - **feat:** update namespace TypeScript declarations [(#5436)](https://github.com/stdlib-js/stdlib/pull/5436) _(by stdlib-bot)_
80106
- [`9d532b5`](https://github.com/stdlib-js/stdlib/commit/9d532b5510055d80c5df8ba4c8e897c1670dcd1a) - **docs:** update namespace table of contents [(#5438)](https://github.com/stdlib-js/stdlib/pull/5438) _(by stdlib-bot, Philipp Burckhardt)_
81107
- [`7aa1502`](https://github.com/stdlib-js/stdlib/commit/7aa150232101abdd4b45c713dfaa71811fcdf850) - **feat:** add `math/array/special` _(by Athan Reines)_
82108
- [`6788899`](https://github.com/stdlib-js/stdlib/commit/678889947a970319197de4db6d48bcac3adf224c) - **feat:** add `math/array/special/abs` _(by Athan Reines)_

docs/types/index.d.ts

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,33 @@
2323
import abs = require( '@stdlib/math-array-special-abs' );
2424

2525
/**
26-
* Interface describing the namespace.
26+
* Interface describing the `special` namespace.
2727
*/
2828
interface Namespace {
2929
/**
30-
* TODO
30+
* Computes the absolute value for each element in an input array.
31+
*
32+
* @param x - input array
33+
* @param options - function options
34+
* @returns output array
35+
*
36+
* @example
37+
* var out = ns.abs( [ -1.0, -2.0, -3.0 ] );
38+
* // returns [ 1.0, 2.0, 3.0 ]
39+
*
40+
* @example
41+
* var y = [ 0.0, 0.0, 0.0 ];
42+
*
43+
* var out = ns.abs.assign( [ -1.0, -2.0, -3.0 ], y );
44+
* // returns [ 1.0, 2.0, 3.0 ]
45+
*
46+
* var bool = ( out === y );
3147
*/
3248
abs: typeof abs;
33-
3449
}
3550

3651
/**
37-
* Namespace.
52+
* Special math functions applied to arrays.
3853
*/
3954
declare var ns: Namespace;
4055

0 commit comments

Comments
 (0)