Skip to content

Commit 0030e39

Browse files
kgrytekgryte
committed
Move contents of types namespace to parent directory
1 parent a2db222 commit 0030e39

File tree

2,561 files changed

+58480
-58636
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,561 files changed

+58480
-58636
lines changed

‎TODO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -702,7 +702,7 @@
702702
- go
703703
- r
704704
705-
1. Add type specs to `@stdlib/types/` folder
705+
1. Add type specs to `@stdlib/` folder
706706
707707
- `abstract-ndarray`
708708
- `abstract-complex`

‎etc/eslint/rules/stdlib.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,15 +143,15 @@ rules[ 'stdlib/no-redeclare' ] = [ 'error', {
143143
* // Bad...
144144
*
145145
* // Invalid file extension:
146-
* var readme = require( '@stdlib/types/array/int32/README.md' );
146+
* var readme = require( '@stdlib/array/int32/README.md' );
147147
*
148148
* // Missing file extension:
149149
* var debug = require( 'debug/src/browser' );
150150
*
151151
* @example
152152
* // Good...
153153
*
154-
* var Int32Array = require( '@stdlib/types/array/int32' );
154+
* var Int32Array = require( '@stdlib/array/int32' );
155155
*
156156
* var debug = require( 'debug/src/browser.js' );
157157
*/
@@ -177,7 +177,7 @@ rules[ 'stdlib/require-file-extensions' ] = [ 'off', { // TODO: Enable once all
177177
*
178178
* @example
179179
* // Good...
180-
* var Float32Array = require( '@stdlib/types/array/float32' );
180+
* var Float32Array = require( '@stdlib/array/float32' );
181181
*
182182
* var arr = new Float32Array();
183183
*/

‎lib/node_modules/@stdlib/_tools/eslint/rules/no-redeclare/test/fixtures/invalid.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ test = {
5454
'',
5555
'// MODULES //',
5656
'',
57-
'var Float64Array = require( \'@stdlib/types/array/float64\' );'
57+
'var Float64Array = require( \'@stdlib/array/float64\' );'
5858
].join( '\n' ),
5959
'options': [{
6060
'builtinGlobals': true
@@ -74,8 +74,8 @@ test = {
7474
'',
7575
'// MODULES //',
7676
'',
77-
'var Float64Array = require( \'@stdlib/types/array/float64\' );',
78-
'var Float64Array = require( \'@stdlib/types/array/float64\' );'
77+
'var Float64Array = require( \'@stdlib/array/float64\' );',
78+
'var Float64Array = require( \'@stdlib/array/float64\' );'
7979
].join( '\n' ),
8080
'options': [{
8181
'builtinGlobals': false

‎lib/node_modules/@stdlib/_tools/eslint/rules/no-redeclare/test/fixtures/valid.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ test = {
8585
'',
8686
'// MODULES //',
8787
'',
88-
'var Float64Array = require( \'@stdlib/types/array/float64\' );'
88+
'var Float64Array = require( \'@stdlib/array/float64\' );'
8989
].join( '\n' ),
9090
'options': [{
9191
'builtinGlobals': false
@@ -105,7 +105,7 @@ test = {
105105
'',
106106
'// MODULES //',
107107
'',
108-
'var Float64Array = require( \'@stdlib/types/array/float64\' );'
108+
'var Float64Array = require( \'@stdlib/array/float64\' );'
109109
].join( '\n' ),
110110
'options': [{
111111
'builtinGlobals': true,

‎lib/node_modules/@stdlib/_tools/eslint/rules/require-file-extensions/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/require-file-extensions' );
2626

2727
```javascript
2828
// Invalid file extension:
29-
var readme = require( '@stdlib/types/array/int32/README.md' );
29+
var readme = require( '@stdlib/array/int32/README.md' );
3030

3131
// Missing file extension:
3232
var debug = require( 'debug/src/browser' );
@@ -35,7 +35,7 @@ var debug = require( 'debug/src/browser' );
3535
**Good**:
3636

3737
``` javascript
38-
var Int32Array = require( '@stdlib/types/array/int32' );
38+
var Int32Array = require( '@stdlib/array/int32' );
3939

4040
var debug = require( 'debug/src/browser.js' );
4141
```

‎lib/node_modules/@stdlib/_tools/eslint/rules/require-file-extensions/test/fixtures/valid.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ test = {
77
'code': [
88
'// MODULES //',
99
'',
10-
'var Int32Array = require( \'@stdlib/types/array/int32\' )'
10+
'var Int32Array = require( \'@stdlib/array/int32\' )'
1111
].join( '\n' )
1212
};
1313
valid.push( test );
@@ -23,7 +23,7 @@ test = {
2323
'code': [
2424
'// MODULES //',
2525
'',
26-
'var Int32Array = require( \'@stdlib/types/array/int32/lib/index.js\' )'
26+
'var Int32Array = require( \'@stdlib/array/int32/lib/index.js\' )'
2727
].join( '\n' )
2828
};
2929
valid.push( test );

‎lib/node_modules/@stdlib/_tools/eslint/rules/require-typed-arrays/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ var arr = new Float32Array();
3131
**Good**:
3232

3333
``` javascript
34-
var Float32Array = require( '@stdlib/types/array/float32' );
34+
var Float32Array = require( '@stdlib/array/float32' );
3535

3636
var arr = new Float32Array();
3737
```

‎lib/node_modules/@stdlib/_tools/eslint/rules/require-typed-arrays/test/fixtures/valid.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ test = {
77
'code': [
88
'// MODULES //',
99
'',
10-
'var Int32Array = require( \'@stdlib/types/array/int32\' )',
10+
'var Int32Array = require( \'@stdlib/array/int32\' )',
1111
'',
1212
'// VARIABLES //',
1313
'var arr = new Int32Array( [1,2,3] );'
@@ -19,7 +19,7 @@ test = {
1919
'code': [
2020
'// MODULES //',
2121
'',
22-
'var Int32Array = require( \'@stdlib/types/array/int32\' )',
22+
'var Int32Array = require( \'@stdlib/array/int32\' )',
2323
'',
2424
'// MAIN //',
2525
'',

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

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Arrays
2+
3+
> Arrays.
4+
5+
<section class="usage">
6+
7+
## Usage
8+
9+
```javascript
10+
var ns = require( '@stdlib/array' );
11+
```
12+
13+
#### ns
14+
15+
Arrays.
16+
17+
```javascript
18+
var o = ns;
19+
// returns {...}
20+
```
21+
22+
</section>
23+
24+
<!-- /.usage -->
25+
26+
<section class="examples">
27+
28+
## Examples
29+
30+
<!-- TODO: better examples -->
31+
32+
```javascript
33+
var getKeys = require( 'object-keys' ).shim();
34+
var ns = require( '@stdlib/array' );
35+
36+
console.log( getKeys( ns ) );
37+
```
38+
39+
</section>
40+
41+
<!-- /.examples -->
42+
43+
<section class="links">
44+
45+
</section>
46+
47+
<!-- /.links -->

‎lib/node_modules/@stdlib/array/buffer/README.md

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
# ArrayBuffer
2+
3+
> [Constructor][mdn-arraybuffer] which returns an object used to represent a generic, fixed-length raw binary data buffer.
4+
5+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
6+
7+
<section class="intro">
8+
9+
</section>
10+
11+
<!-- /.intro -->
12+
13+
<!-- Package usage documentation. -->
14+
15+
<section class="usage">
16+
17+
## Usage
18+
19+
```javascript
20+
var ArrayBuffer = require( '@stdlib/array/buffer' );
21+
```
22+
23+
#### ArrayBuffer( size )
24+
25+
Returns an [`ArrayBuffer`][mdn-arraybuffer] having a specified number of bytes.
26+
27+
<!-- eslint-disable stdlib/require-arraybuffer -->
28+
29+
```javascript
30+
var buf = new ArrayBuffer( 5 );
31+
// returns <ArrayBuffer>
32+
```
33+
34+
* * *
35+
36+
### Properties
37+
38+
#### ArrayBuffer.length
39+
40+
Number of input arguments the constructor accepts.
41+
42+
<!-- eslint-disable stdlib/require-arraybuffer -->
43+
44+
```javascript
45+
var len = ArrayBuffer.length;
46+
// returns 1
47+
```
48+
49+
#### ArrayBuffer.prototype.byteLength
50+
51+
**Read-only** property which returns the length (in bytes) of the [`ArrayBuffer`][mdn-arraybuffer].
52+
53+
<!-- eslint-disable stdlib/require-arraybuffer -->
54+
55+
```javascript
56+
var buf = new ArrayBuffer( 5 );
57+
var byteLength = buf.byteLength;
58+
// returns 5
59+
```
60+
61+
* * *
62+
63+
### Methods
64+
65+
#### ArrayBuffer.isView( arr )
66+
67+
Static method which returns a `boolean` indicating if provided a buffer view.
68+
69+
```javascript
70+
var Float64Array = require( '@stdlib/array/float64' );
71+
var view = new Float64Array( 10 );
72+
73+
var bool = ArrayBuffer.isView( view );
74+
// returns true
75+
```
76+
77+
#### ArrayBuffer.prototype.slice( \[start\[, end]] )
78+
79+
Copies the bytes of an `ArrayBuffer` to a new [`ArrayBuffer`][mdn-arraybuffer].
80+
81+
```javascript
82+
var b1 = new ArrayBuffer( 10 );
83+
84+
var b2 = b1.slice();
85+
// returns <ArrayBuffer>
86+
87+
var bool = ( b2 === b1 );
88+
// returns false
89+
```
90+
91+
By default, the method copies from the beginning of the [`ArrayBuffer`][mdn-arraybuffer]. To beginning copying from a different byte index, provide a `start` argument, specifying the starting byte index (inclusive).
92+
93+
```javascript
94+
var b1 = new ArrayBuffer( 10 );
95+
var b2 = b1.slice( 2 );
96+
97+
var nbytes = b2.byteLength;
98+
// returns 8
99+
```
100+
101+
If `start < 0`, the index is relative to the end of the [`ArrayBuffer`][mdn-arraybuffer].
102+
103+
```javascript
104+
var b1 = new ArrayBuffer( 10 );
105+
var b2 = b1.slice( -2 );
106+
107+
var nbytes = b2.byteLength;
108+
// returns 2
109+
```
110+
111+
By default, the method copies to the end of the [`ArrayBuffer`][mdn-arraybuffer]. To copy until a particular byte index, provide an `end` index, specifying the ending byte index (exclusive).
112+
113+
```javascript
114+
var b1 = new ArrayBuffer( 10 );
115+
var b2 = b1.slice( 2, 6 );
116+
117+
var nbytes = b2.byteLength;
118+
// returns 4
119+
```
120+
121+
If `end < 0`, the index is relative to the end of the [`ArrayBuffer`][mdn-arraybuffer].
122+
123+
```javascript
124+
var b1 = new ArrayBuffer( 10 );
125+
var b2 = b1.slice( 2, -2 );
126+
127+
var nbytes = b2.byteLength;
128+
// returns 6
129+
```
130+
131+
</section>
132+
133+
<!-- /.usage -->
134+
135+
* * *
136+
137+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
138+
139+
<section class="notes">
140+
141+
</section>
142+
143+
<!-- /.notes -->
144+
145+
<!-- Package usage examples. -->
146+
147+
<section class="examples">
148+
149+
## Examples
150+
151+
```javascript
152+
var randu = require( '@stdlib/random/base/randu' );
153+
var Float64Array = require( '@stdlib/array/float64' );
154+
var Uint8Array = require( '@stdlib/array/uint8' );
155+
var toBinaryString = require( '@stdlib/number/uint8/base/to-binary-string' );
156+
var ArrayBuffer = require( '@stdlib/array/buffer' );
157+
158+
var bytes;
159+
var buf;
160+
var arr;
161+
var i;
162+
163+
// Create a new ArrayBuffer:
164+
buf = new ArrayBuffer( 64 );
165+
166+
// Create a Float64 array buffer view:
167+
arr = new Float64Array( buf.byteLength/8 );
168+
for ( i = 0; i < arr.length; i++ ) {
169+
arr[ i ] = randu() * 100.0;
170+
}
171+
172+
// Create a "bytes" view of the array buffer:
173+
bytes = new Uint8Array( arr.buffer );
174+
175+
// Print the bytes:
176+
for ( i = 0; i < bytes.length; i++ ) {
177+
console.log( 'byte %d: %s', i, toBinaryString( bytes[ i ] ) );
178+
}
179+
```
180+
181+
</section>
182+
183+
<!-- /.examples -->
184+
185+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
186+
187+
<section class="references">
188+
189+
</section>
190+
191+
<!-- /.references -->
192+
193+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
194+
195+
<section class="links">
196+
197+
[mdn-arraybuffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
198+
199+
</section>
200+
201+
<!-- /.links -->

‎lib/node_modules/@stdlib/types/array/buffer/benchmark/benchmark.js renamed to ‎lib/node_modules/@stdlib/array/buffer/benchmark/benchmark.js

File renamed without changes.

‎lib/node_modules/@stdlib/types/array/buffer/benchmark/benchmark.length.js renamed to ‎lib/node_modules/@stdlib/array/buffer/benchmark/benchmark.length.js

File renamed without changes.

0 commit comments

Comments
 (0)