Skip to content

Commit f6d6168

Browse files
committed
Auto-generated commit
1 parent c0d07ad commit f6d6168

File tree

2 files changed

+75
-2
lines changed

2 files changed

+75
-2
lines changed

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,13 +20,26 @@
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
- [`a4b312d`](https://github.com/stdlib-js/stdlib/commit/a4b312d7b75231f171b3c475d884e17e350f2856) - add `unaryFactory` to namespace
2425
- [`824f294`](https://github.com/stdlib-js/stdlib/commit/824f29485447d0e3224d1fcc784f2355b6b7fd14) - add `math/array/tools` namespace
2526

2627
</section>
2728

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

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

3245
</section>
@@ -81,6 +94,18 @@
8194

8295
<!-- /.packages -->
8396

97+
<section class="breaking-changes">
98+
99+
### BREAKING CHANGES
100+
101+
- [`2f0aa48`](https://github.com/stdlib-js/stdlib/commit/2f0aa48ef6d561779d4bd4c4a54fe00a5a26c0e1): remove `mulf` symbol
102+
103+
- To migrate, users should access the same symbol via the `number/float32/base` namespace.
104+
105+
</section>
106+
107+
<!-- /.breaking-changes -->
108+
84109
<section class="contributors">
85110

86111
### Contributors
@@ -100,6 +125,7 @@ A total of 2 people contributed to this release. Thank you to the following cont
100125

101126
<details>
102127

128+
- [`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)_
103129
- [`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)_
104130
- [`98336f5`](https://github.com/stdlib-js/stdlib/commit/98336f5011237a2d607be003f05060146e55d204) - **docs:** fix comment _(by Athan Reines)_
105131
- [`1e9b650`](https://github.com/stdlib-js/stdlib/commit/1e9b650d29bc3584af013e3ef7d4206dc674b0dd) - **docs:** fix comment _(by Athan Reines)_

docs/types/index.d.ts

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,63 @@
2121
/* eslint-disable max-lines */
2222

2323
import unary = require( '@stdlib/math-array-tools-unary' );
24+
import unaryFactory = require( '@stdlib/math-array-tools-unary-factory' );
2425

2526
/**
2627
* Interface describing the `tools` namespace.
2728
*/
2829
interface Namespace {
2930
/**
30-
* TODO
31+
* Constructor for applying a unary function to each element in a provided array.
32+
*
33+
* @param fcn - unary function to apply
34+
* @param idtypes - list of supported input data types
35+
* @param odtypes - list of supported output data types
36+
* @param policy - output data type policy
37+
* @returns instance
38+
*
39+
* @example
40+
* var base = require( '@stdlib/math-base-special-abs' );
41+
* var dtypes = require( '@stdlib/array-dtypes' );
42+
*
43+
* var idt = dtypes( 'real_and_generic' );
44+
* var odt = idt;
45+
* var policy = 'same';
46+
*
47+
* var abs = new Unary( base, idt, odt, policy );
48+
*
49+
* var x = [ -1.0, -2.0, -3.0 ];
50+
*
51+
* var y = abs.apply( x );
52+
* // returns [ 1.0, 2.0, 3.0 ]
3153
*/
3254
unary: typeof unary;
3355

56+
/**
57+
* Creates a function for applying a unary function to each element in a provided array.
58+
*
59+
* @param fcn - unary function to apply
60+
* @param idtypes - list of supported input data types
61+
* @param odtypes - list of supported output data types
62+
* @param policy - output data type policy
63+
* @returns function for applying a unary function
64+
*
65+
* @example
66+
* var base = require( '@stdlib/math-base-special-abs' );
67+
* var dtypes = require( '@stdlib/array-dtypes' );
68+
*
69+
* var idt = dtypes( 'real_and_generic' );
70+
* var odt = idt;
71+
* var policy = 'same';
72+
*
73+
* var abs = ns.unaryFactory( base, idt, odt, policy );
74+
*
75+
* var x = [ -1.0, -2.0, -3.0 ];
76+
*
77+
* var y = abs( x );
78+
* // returns [ 1.0, 2.0, 3.0 ]
79+
*/
80+
unaryFactory: typeof unaryFactory;
3481
}
3582

3683
/**

0 commit comments

Comments
 (0)