Skip to content

Commit fb05381

Browse files
committed
Auto-generated commit
1 parent 356ec73 commit fb05381

2 files changed

Lines changed: 100 additions & 0 deletions

File tree

‎CHANGELOG.md‎

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

1111
### Features
1212

13+
- [`9e91810`](https://github.com/stdlib-js/stdlib/commit/9e91810bfa37f32b66e04ac1ee69b640ea2e43ff) - update `ndarray/base/assert` TypeScript declarations [(#13119)](https://github.com/stdlib-js/stdlib/pull/13119)
1314
- [`8bf9161`](https://github.com/stdlib-js/stdlib/commit/8bf91614301abf9249ff3ea9379baa4bc6c450e0) - add `ndarray/matrix` namespace
1415
- [`dc9a2a7`](https://github.com/stdlib-js/stdlib/commit/dc9a2a7eb4962f9743ba7a7369a6593669370296) - add `ndarray/matrix/ctor`
1516
- [`585603b`](https://github.com/stdlib-js/stdlib/commit/585603b45bb17f82056940bd0cf3dca981a20fbb) - add support for `Float16Array`
@@ -48,6 +49,7 @@
4849

4950
<details>
5051

52+
- [`9e91810`](https://github.com/stdlib-js/stdlib/commit/9e91810bfa37f32b66e04ac1ee69b640ea2e43ff) - **feat:** update `ndarray/base/assert` TypeScript declarations [(#13119)](https://github.com/stdlib-js/stdlib/pull/13119) _(by stdlib-bot)_
5153
- [`839aaf6`](https://github.com/stdlib-js/stdlib/commit/839aaf681cf5e10b2f4d1ed566d716dd2726421b) - **docs:** update documentation [(#13120)](https://github.com/stdlib-js/stdlib/pull/13120) _(by stdlib-bot)_
5254
- [`4a14673`](https://github.com/stdlib-js/stdlib/commit/4a1467352fcbd486caca6564a300c627449d796d) - **docs:** update namespace table of contents [(#13121)](https://github.com/stdlib-js/stdlib/pull/13121) _(by stdlib-bot)_
5355
- [`8bf9161`](https://github.com/stdlib-js/stdlib/commit/8bf91614301abf9249ff3ea9379baa4bc6c450e0) - **feat:** add `ndarray/matrix` namespace _(by Athan Reines)_

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

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
import hasEqualShape = require( './../../../../base/assert/has-equal-shape' );
2424
import isAllowedDataTypeCast = require( './../../../../base/assert/is-allowed-data-type-cast' );
25+
import isBinaryDataType = require( './../../../../base/assert/is-binary-data-type' );
2526
import isBooleanDataType = require( './../../../../base/assert/is-boolean-data-type' );
2627
import isBooleanIndexDataType = require( './../../../../base/assert/is-boolean-index-data-type' );
2728
import isBufferLengthCompatible = require( './../../../../base/assert/is-buffer-length-compatible' );
@@ -38,6 +39,7 @@ import isDataTypeObject = require( './../../../../base/assert/is-data-type-objec
3839
import isDataTypeString = require( './../../../../base/assert/is-data-type-string' );
3940
import isEqualDataType = require( './../../../../base/assert/is-equal-data-type' );
4041
import isFloatingPointDataType = require( './../../../../base/assert/is-floating-point-data-type' );
42+
import isGenericDataType = require( './../../../../base/assert/is-generic-data-type' );
4143
import isIndexDataType = require( './../../../../base/assert/is-index-data-type' );
4244
import isIndexMode = require( './../../../../base/assert/is-index-mode' );
4345
import isInputCastingPolicy = require( './../../../../base/assert/is-input-casting-policy' );
@@ -101,6 +103,54 @@ interface Namespace {
101103
*/
102104
isAllowedDataTypeCast: typeof isAllowedDataTypeCast;
103105

106+
/**
107+
* Tests whether an input value is a supported ndarray binary data type.
108+
*
109+
* @param v - value to test
110+
* @returns boolean indicating whether an input value is a supported ndarray binary data type
111+
*
112+
* @example
113+
* var bool = ns.isBinaryDataType( 'binary' );
114+
* // returns true
115+
*
116+
* bool = ns.isBinaryDataType( 'bool' );
117+
* // returns false
118+
*
119+
* bool = ns.isBinaryDataType( 'float32' );
120+
* // returns false
121+
*
122+
* bool = ns.isBinaryDataType( 'float64' );
123+
* // returns false
124+
*
125+
* bool = ns.isBinaryDataType( 'generic' );
126+
* // returns false
127+
*
128+
* bool = ns.isBinaryDataType( 'int16' );
129+
* // returns false
130+
*
131+
* bool = ns.isBinaryDataType( 'int32' );
132+
* // returns false
133+
*
134+
* bool = ns.isBinaryDataType( 'int8' );
135+
* // returns false
136+
*
137+
* bool = ns.isBinaryDataType( 'uint16' );
138+
* // returns false
139+
*
140+
* bool = ns.isBinaryDataType( 'uint32' );
141+
* // returns false
142+
*
143+
* bool = ns.isBinaryDataType( 'uint8' );
144+
* // returns false
145+
*
146+
* bool = ns.isBinaryDataType( 'uint8c' );
147+
* // returns false
148+
*
149+
* bool = ns.isBinaryDataType( 'foo' );
150+
* // returns false
151+
*/
152+
isBinaryDataType: typeof isBinaryDataType;
153+
104154
/**
105155
* Tests whether an input value is a supported ndarray boolean data type.
106156
*
@@ -663,6 +713,54 @@ interface Namespace {
663713
*/
664714
isFloatingPointDataType: typeof isFloatingPointDataType;
665715

716+
/**
717+
* Tests whether an input value is a supported ndarray generic data type.
718+
*
719+
* @param v - value to test
720+
* @returns boolean indicating whether an input value is a supported ndarray generic data type
721+
*
722+
* @example
723+
* var bool = ns.isGenericDataType( 'binary' );
724+
* // returns false
725+
*
726+
* bool = ns.isGenericDataType( 'bool' );
727+
* // returns false
728+
*
729+
* bool = ns.isGenericDataType( 'float32' );
730+
* // returns false
731+
*
732+
* bool = ns.isGenericDataType( 'float64' );
733+
* // returns false
734+
*
735+
* bool = ns.isGenericDataType( 'generic' );
736+
* // returns true
737+
*
738+
* bool = ns.isGenericDataType( 'int16' );
739+
* // returns false
740+
*
741+
* bool = ns.isGenericDataType( 'int32' );
742+
* // returns false
743+
*
744+
* bool = ns.isGenericDataType( 'int8' );
745+
* // returns false
746+
*
747+
* bool = ns.isGenericDataType( 'uint16' );
748+
* // returns false
749+
*
750+
* bool = ns.isGenericDataType( 'uint32' );
751+
* // returns false
752+
*
753+
* bool = ns.isGenericDataType( 'uint8' );
754+
* // returns false
755+
*
756+
* bool = ns.isGenericDataType( 'uint8c' );
757+
* // returns false
758+
*
759+
* bool = ns.isGenericDataType( 'foo' );
760+
* // returns false
761+
*/
762+
isGenericDataType: typeof isGenericDataType;
763+
666764
/**
667765
* Tests whether an input value is a supported ndarray index data type.
668766
*

0 commit comments

Comments
 (0)