Skip to content

Commit 69eecad

Browse files
kgrytekgryte
committed
feat: add complex/float32/base/assert namespace
1 parent c89d08c commit 69eecad

File tree

7 files changed

+374
-0
lines changed

7 files changed

+374
-0
lines changed

‎lib/node_modules/@stdlib/complex/float32/base/assert/README.md

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 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+
# Assert
22+
23+
> Base (i.e., lower-level) single-precision complex floating-point number assertion functions.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var assert = require( '@stdlib/complex/float32/base/assert' );
31+
```
32+
33+
#### assert
34+
35+
Namespace containing base (i.e., lower-level) single-precision complex floating-point number assertion functions.
36+
37+
```javascript
38+
var ns = assert;
39+
// returns {...}
40+
```
41+
42+
The namespace contains the following functions:
43+
44+
<!-- <toc pattern="*"> -->
45+
46+
<!-- </toc> -->
47+
48+
</section>
49+
50+
<!-- /.usage -->
51+
52+
<!-- Package notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
53+
54+
<section class="notes">
55+
56+
</section>
57+
58+
<!-- /.notes -->
59+
60+
<section class="examples">
61+
62+
## Examples
63+
64+
<!-- TODO: better examples -->
65+
66+
<!-- eslint no-undef: "error" -->
67+
68+
```javascript
69+
var objectKeys = require( '@stdlib/utils/keys' );
70+
var ns = require( '@stdlib/complex/float32/base/assert' );
71+
72+
console.log( objectKeys( ns ) );
73+
```
74+
75+
</section>
76+
77+
<!-- /.examples -->
78+
79+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
80+
81+
<section class="related">
82+
83+
</section>
84+
85+
<!-- /.related -->
86+
87+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
88+
89+
<section class="links">
90+
91+
<!-- <toc-links> -->
92+
93+
<!-- </toc-links> -->
94+
95+
</section>
96+
97+
<!-- /.links -->

‎lib/node_modules/@stdlib/complex/float32/base/assert/docs/types/index.d.ts

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 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 isEqual = require( '@stdlib/complex/float32/base/assert/is-equal' );
24+
25+
/**
26+
* Interface describing the namespace.
27+
*/
28+
interface Namespace {
29+
/**
30+
* TODO
31+
*/
32+
isEqual: typeof isEqual;
33+
}
34+
35+
/**
36+
* Base (i.e., lower-level) single-precision complex floating-point number assertion functions.
37+
*/
38+
declare var ns: Namespace;
39+
40+
41+
// EXPORTS //
42+
43+
export = ns;

‎lib/node_modules/@stdlib/complex/float32/base/assert/docs/types/test.ts

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 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+
}

‎lib/node_modules/@stdlib/complex/float32/base/assert/examples/index.js

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 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 ) );

‎lib/node_modules/@stdlib/complex/float32/base/assert/lib/index.js

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 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+
* Top-level namespace.
34+
*
35+
* @namespace ns
36+
*/
37+
var ns = {};
38+
39+
/**
40+
* @name isEqual
41+
* @memberof ns
42+
* @readonly
43+
* @type {Function}
44+
* @see {@link module:@stdlib/complex/float32/base/assert/is-equal}
45+
*/
46+
setReadOnly( ns, 'isEqual', require( '@stdlib/complex/float32/base/assert/is-equal' ) );
47+
48+
/**
49+
* @name isNotEqual
50+
* @memberof ns
51+
* @readonly
52+
* @type {Function}
53+
* @see {@link module:@stdlib/complex/float32/base/assert/is-not-equal}
54+
*/
55+
setReadOnly( ns, 'isNotEqual', require( '@stdlib/complex/float32/base/assert/is-not-equal' ) );
56+
57+
/**
58+
* @name isSameValue
59+
* @memberof ns
60+
* @readonly
61+
* @type {Function}
62+
* @see {@link module:@stdlib/complex/float32/base/assert/is-same-value}
63+
*/
64+
setReadOnly( ns, 'isSameValue', require( '@stdlib/complex/float32/base/assert/is-same-value' ) );
65+
66+
/**
67+
* @name isSameValueZero
68+
* @memberof ns
69+
* @readonly
70+
* @type {Function}
71+
* @see {@link module:@stdlib/complex/float32/base/assert/is-same-value-zero}
72+
*/
73+
setReadOnly( ns, 'isSameValueZero', require( '@stdlib/complex/float32/base/assert/is-same-value-zero' ) );
74+
75+
76+
// EXPORTS //
77+
78+
module.exports = ns;

‎lib/node_modules/@stdlib/complex/float32/base/assert/package.json

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
{
2+
"name": "@stdlib/complex/float32/base/assert",
3+
"version": "0.0.0",
4+
"description": "Base (i.e., lower-level) single-precision complex number assertion functions.",
5+
"license": "Apache-2.0",
6+
"author": {
7+
"name": "The Stdlib Authors",
8+
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
9+
},
10+
"contributors": [
11+
{
12+
"name": "The Stdlib Authors",
13+
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
14+
}
15+
],
16+
"main": "lib/index.js",
17+
"directories": {
18+
"doc": "./docs",
19+
"example": "./examples",
20+
"lib": "./lib",
21+
"test": "./test"
22+
},
23+
"types": "./docs/types",
24+
"scripts": {},
25+
"homepage": "https://github.com/stdlib-js/stdlib",
26+
"repository": {
27+
"type": "git",
28+
"url": "git://github.com/stdlib-js/stdlib.git"
29+
},
30+
"bugs": {
31+
"url": "https://github.com/stdlib-js/stdlib/issues"
32+
},
33+
"dependencies": {},
34+
"devDependencies": {},
35+
"engines": {
36+
"node": ">=0.10.0",
37+
"npm": ">2.7.0"
38+
},
39+
"os": [
40+
"aix",
41+
"darwin",
42+
"freebsd",
43+
"linux",
44+
"macos",
45+
"openbsd",
46+
"sunos",
47+
"win32",
48+
"windows"
49+
],
50+
"keywords": [
51+
"stdlib",
52+
"stdtypes",
53+
"types",
54+
"complex",
55+
"cmplx",
56+
"number",
57+
"namespace",
58+
"ns",
59+
"float32",
60+
"base",
61+
"assert"
62+
]
63+
}

‎lib/node_modules/@stdlib/complex/float32/base/assert/test/test.js

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 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+
// MODULES //
22+
23+
var tape = require( 'tape' );
24+
var objectKeys = require( '@stdlib/utils/keys' );
25+
var ns = require( './../lib' );
26+
27+
28+
// TESTS //
29+
30+
tape( 'main export is an object', function test( t ) {
31+
t.ok( true, __filename );
32+
t.strictEqual( typeof ns, 'object', 'main export is an object' );
33+
t.end();
34+
});
35+
36+
tape( 'the exported object contains key-value pairs', function test( t ) {
37+
var keys = objectKeys( ns );
38+
t.equal( keys.length > 0, true, 'has keys' );
39+
t.end();
40+
});

0 commit comments

Comments
 (0)