Skip to content

Commit 25698dc

Browse files
kgrytekgryte
committed
Add namespace
1 parent 8f4f336 commit 25698dc

5 files changed

Lines changed: 274 additions & 4 deletions

File tree

‎lib/node_modules/@stdlib/ndarray/README.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2018 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+
# ndarray
22+
23+
> Multidimensional arrays.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var ns = require( '@stdlib/ndarray' );
31+
```
32+
33+
#### ns
34+
35+
ndarray namespace.
36+
37+
```javascript
38+
var o = ns;
39+
// returns {...}
40+
```
41+
42+
</section>
43+
44+
<!-- /.usage -->
45+
46+
<section class="examples">
47+
48+
## Examples
49+
50+
<!-- TODO: better examples -->
51+
52+
<!-- eslint no-undef: "error" -->
53+
54+
```javascript
55+
var getKeys = require( '@stdlib/utils/keys' );
56+
var ns = require( '@stdlib/ndarray' );
57+
58+
console.log( getKeys( ns ) );
59+
```
60+
61+
</section>
62+
63+
<!-- /.examples -->
64+
65+
<section class="links">
66+
67+
</section>
68+
69+
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/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) 2018 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 getKeys = require( '@stdlib/utils/keys' );
22+
var ns = require( './../lib' );
23+
24+
console.log( getKeys( ns ) );

‎lib/node_modules/@stdlib/ndarray/lib/index.js‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2018 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 array
41+
* @memberof ns
42+
* @readonly
43+
* @type {Function}
44+
* @see {@link module:@stdlib/ndarray/array}
45+
*/
46+
setReadOnly( ns, 'array', require( '@stdlib/ndarray/array' ) );
47+
48+
/**
49+
* @name base
50+
* @memberof ns
51+
* @readonly
52+
* @type {Namespace}
53+
* @see {@link module:@stdlib/ndarray/base}
54+
*/
55+
setReadOnly( ns, 'base', require( '@stdlib/ndarray/base' ) );
56+
57+
/**
58+
* @name castingModes
59+
* @memberof ns
60+
* @readonly
61+
* @type {Function}
62+
* @see {@link module:@stdlib/ndarray/casting-modes}
63+
*/
64+
setReadOnly( ns, 'castingModes', require( '@stdlib/ndarray/casting-modes' ) );
65+
66+
/**
67+
* @name ndarray
68+
* @memberof ns
69+
* @readonly
70+
* @type {Function}
71+
* @see {@link module:@stdlib/ndarray/ctor}
72+
*/
73+
setReadOnly( ns, 'ndarray', require( '@stdlib/ndarray/ctor' ) );
74+
75+
/**
76+
* @name dtypes
77+
* @memberof ns
78+
* @readonly
79+
* @type {Function}
80+
* @see {@link module:@stdlib/ndarray/dtypes}
81+
*/
82+
setReadOnly( ns, 'dtypes', require( '@stdlib/ndarray/dtypes' ) );
83+
84+
/**
85+
* @name ind2sub
86+
* @memberof ns
87+
* @readonly
88+
* @type {Function}
89+
* @see {@link module:@stdlib/ndarray/ind2sub}
90+
*/
91+
setReadOnly( ns, 'ind2sub', require( '@stdlib/ndarray/ind2sub' ) );
92+
93+
/**
94+
* @name indexModes
95+
* @memberof ns
96+
* @readonly
97+
* @type {Function}
98+
* @see {@link module:@stdlib/ndarray/index-modes}
99+
*/
100+
setReadOnly( ns, 'indexModes', require( '@stdlib/ndarray/index-modes' ) );
101+
102+
/**
103+
* @name memoizedCtor
104+
* @memberof ns
105+
* @readonly
106+
* @type {Function}
107+
* @see {@link module:@stdlib/ndarray/memoized-ctor}
108+
*/
109+
setReadOnly( ns, 'memoizedCtor', require( '@stdlib/ndarray/memoized-ctor' ) );
110+
111+
/**
112+
* @name orders
113+
* @memberof ns
114+
* @readonly
115+
* @type {Function}
116+
* @see {@link module:@stdlib/ndarray/orders}
117+
*/
118+
setReadOnly( ns, 'orders', require( '@stdlib/ndarray/orders' ) );
119+
120+
/**
121+
* @name sub2ind
122+
* @memberof ns
123+
* @readonly
124+
* @type {Function}
125+
* @see {@link module:@stdlib/ndarray/sub2ind}
126+
*/
127+
setReadOnly( ns, 'sub2ind', require( '@stdlib/ndarray/sub2ind' ) );
128+
129+
130+
// EXPORTS //
131+
132+
module.exports = ns;

‎lib/node_modules/@stdlib/ndarray/package.json‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,19 @@
4949
"stdtypes",
5050
"types",
5151
"data",
52-
"structure",
53-
"array",
52+
"structures",
5453
"typed",
5554
"typed array",
5655
"typed-array",
56+
"array",
57+
"vector",
58+
"matrix",
59+
"ndarray",
60+
"tensor",
5761
"multidimensional",
58-
"dimensions",
59-
"dims"
62+
"buffer",
63+
"namespace",
64+
"ns"
6065
],
6166
"__stdlib__": {}
6267
}

‎lib/node_modules/@stdlib/ndarray/test/test.js‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2018 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 getKeys = 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.equal( 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 = getKeys( ns );
38+
t.equal( keys.length > 0, true, 'has keys' );
39+
t.end();
40+
});

0 commit comments

Comments
 (0)