Skip to content

Commit 1a21d26

Browse files
committed
Update documentation
1 parent 65bb7fa commit 1a21d26

File tree

2 files changed

+103
-1
lines changed

2 files changed

+103
-1
lines changed

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

+102
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ limitations under the License.
4040
var Complex64Array = require( '@stdlib/array/complex64' );
4141
```
4242

43+
<a name="constructor"></a>
44+
4345
#### Complex64Array()
4446

4547
Creates a 64-bit complex number array.
@@ -127,6 +129,106 @@ len = arr3.length;
127129
// returns 20
128130
```
129131

132+
* * *
133+
134+
### Properties
135+
136+
<a name="static-prop-bytes-per-element"></a>
137+
138+
#### Complex64Array.BYTES_PER_ELEMENT
139+
140+
Static property returning the size (in bytes) of each array element.
141+
142+
```javascript
143+
var nbytes = Complex64Array.BYTES_PER_ELEMENT;
144+
// returns 8
145+
```
146+
147+
<a name="prop-buffer"></a>
148+
149+
#### Complex64Array.prototype.buffer
150+
151+
Pointer to the underlying data buffer.
152+
153+
```javascript
154+
var arr = new Complex64Array( 2 );
155+
// returns <Complex64Array>
156+
157+
var buf = arr.buffer;
158+
// returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]
159+
```
160+
161+
<a name="prop-byte-length"></a>
162+
163+
#### Complex64Array.prototype.byteLength
164+
165+
Size (in bytes) of the array.
166+
167+
```javascript
168+
var arr = new Complex64Array( 10 );
169+
// returns <Complex64Array>
170+
171+
var nbytes = arr.byteLength;
172+
// returns 80
173+
```
174+
175+
<a name="prop-byte-offset"></a>
176+
177+
#### Complex64Array.prototype.byteOffset
178+
179+
Offset (in bytes) of the array from the start of its underlying `ArrayBuffer`.
180+
181+
```javascript
182+
var ArrayBuffer = require( '@stdlib/array/buffer' );
183+
184+
var arr = new Complex64Array( 10 );
185+
// returns <Complex64Array>
186+
187+
var offset = arr.byteOffset;
188+
// returns 0
189+
190+
var buf = new ArrayBuffer( 240 );
191+
arr = new Complex64Array( buf, 64 );
192+
// returns <Complex64Array>
193+
194+
offset = arr.byteOffset;
195+
// returns 64
196+
```
197+
198+
<a name="prop-bytes-per-element"></a>
199+
200+
#### Complex64Array.prototype.BYTES_PER_ELEMENT
201+
202+
Size (in bytes) of each array element.
203+
204+
```javascript
205+
var arr = new Complex64Array( 10 );
206+
// returns <Complex64Array>
207+
208+
var nbytes = arr.BYTES_PER_ELEMENT;
209+
// returns 8
210+
```
211+
212+
<a name="prop-length"></a>
213+
214+
#### Complex64Array.prototype.length
215+
216+
Number of array elements.
217+
218+
```javascript
219+
var arr = new Complex64Array( 10 );
220+
// returns <Complex64Array>
221+
222+
var len = arr.length;
223+
// returns 10
224+
```
225+
226+
* * *
227+
228+
#### Methods
229+
230+
231+
130232
</section>
131233

132234
<!-- /.usage -->

lib/node_modules/@stdlib/array/complex64/lib/main.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -806,7 +806,7 @@ Object.defineProperty( Complex64Array.prototype, 'get', {
806806
});
807807

808808
/**
809-
* Length of the array.
809+
* Number of array elements.
810810
*
811811
* @name length
812812
* @memberof Complex64Array.prototype

0 commit comments

Comments
 (0)