Skip to content

Commit 5f1953d

Browse files
committed
docs: move methods to preserve alphabetical order
1 parent 9272073 commit 5f1953d

File tree

2 files changed

+88
-88
lines changed

2 files changed

+88
-88
lines changed

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

+85-85
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,56 @@ len = arr.length;
514514
// returns 2
515515
```
516516

517+
<a name="method-at"></a>
518+
519+
#### Complex64Array.prototype.at( i )
520+
521+
Returns an array element located at integer position (index) `i`, with support for both nonnegative and negative integer positions.
522+
523+
```javascript
524+
var realf = require( '@stdlib/complex/realf' );
525+
var imagf = require( '@stdlib/complex/imagf' );
526+
527+
var arr = new Complex64Array( 10 );
528+
529+
// Set the first, second, and last elements:
530+
arr.set( [ 1.0, -1.0 ], 0 );
531+
arr.set( [ 2.0, -2.0 ], 1 );
532+
arr.set( [ 9.0, -9.0 ], 9 );
533+
534+
// Get the first element:
535+
var z = arr.at( 0 );
536+
// returns <Complex64>
537+
538+
var re = realf( z );
539+
// returns 1.0
540+
541+
var im = imagf( z );
542+
// returns -1.0
543+
544+
// Get the last element:
545+
z = arr.at( -1 );
546+
// returns <Complex64>
547+
548+
re = realf( z );
549+
// returns 9.0
550+
551+
im = imagf( z );
552+
// returns -9.0
553+
```
554+
555+
If provided an out-of-bounds index, the method returns `undefined`.
556+
557+
```javascript
558+
var arr = new Complex64Array( 10 );
559+
560+
var z = arr.at( 100 );
561+
// returns undefined
562+
563+
z = arr.at( -100 );
564+
// returns undefined
565+
```
566+
517567
<a name="method-copy-within"></a>
518568

519569
#### Complex64Array.prototype.copyWithin( target, start\[, end] )
@@ -748,91 +798,6 @@ var bool = it.next().done;
748798
// returns true
749799
```
750800

751-
<a name="method-get"></a>
752-
753-
#### Complex64Array.prototype.get( i )
754-
755-
Returns an array element located at a nonnegative integer position (index) `i`.
756-
757-
```javascript
758-
var realf = require( '@stdlib/complex/realf' );
759-
var imagf = require( '@stdlib/complex/imagf' );
760-
761-
var arr = new Complex64Array( 10 );
762-
763-
// Set the first element:
764-
arr.set( [ 1.0, -1.0 ], 0 );
765-
766-
// Get the first element:
767-
var z = arr.get( 0 );
768-
// returns <Complex64>
769-
770-
var re = realf( z );
771-
// returns 1.0
772-
773-
var im = imagf( z );
774-
// returns -1.0
775-
```
776-
777-
If provided an out-of-bounds index, the method returns `undefined`.
778-
779-
```javascript
780-
var arr = new Complex64Array( 10 );
781-
782-
var z = arr.get( 100 );
783-
// returns undefined
784-
```
785-
786-
<a name="method-at"></a>
787-
788-
#### Complex64Array.prototype.at( i )
789-
790-
Returns an array element located at integer position (index) `i`, with support for both nonnegative and negative integer positions.
791-
792-
```javascript
793-
var realf = require( '@stdlib/complex/realf' );
794-
var imagf = require( '@stdlib/complex/imagf' );
795-
796-
var arr = new Complex64Array( 10 );
797-
798-
// Set the first, second, and last elements:
799-
arr.set( [ 1.0, -1.0 ], 0 );
800-
arr.set( [ 2.0, -2.0 ], 1 );
801-
arr.set( [ 9.0, -9.0 ], 9 );
802-
803-
// Get the first element:
804-
var z = arr.at( 0 );
805-
// returns <Complex64>
806-
807-
var re = realf( z );
808-
// returns 1.0
809-
810-
var im = imagf( z );
811-
// returns -1.0
812-
813-
// Get the last element:
814-
z = arr.at( -1 );
815-
// returns <Complex64>
816-
817-
re = realf( z );
818-
// returns 9.0
819-
820-
im = imagf( z );
821-
// returns -9.0
822-
```
823-
824-
If provided an out-of-bounds index, the method returns `undefined`.
825-
826-
```javascript
827-
var arr = new Complex64Array( 10 );
828-
829-
var z = arr.at( 100 );
830-
// returns undefined
831-
832-
z = arr.at( -100 );
833-
// returns undefined
834-
```
835-
836801
<a name="method-every"></a>
837802

838803
#### Complex64Array.prototype.every( predicate\[, thisArg] )
@@ -891,6 +856,41 @@ var count = context.count;
891856
// returns 3
892857
```
893858

859+
<a name="method-get"></a>
860+
861+
#### Complex64Array.prototype.get( i )
862+
863+
Returns an array element located at a nonnegative integer position (index) `i`.
864+
865+
```javascript
866+
var realf = require( '@stdlib/complex/realf' );
867+
var imagf = require( '@stdlib/complex/imagf' );
868+
869+
var arr = new Complex64Array( 10 );
870+
871+
// Set the first element:
872+
arr.set( [ 1.0, -1.0 ], 0 );
873+
874+
// Get the first element:
875+
var z = arr.get( 0 );
876+
// returns <Complex64>
877+
878+
var re = realf( z );
879+
// returns 1.0
880+
881+
var im = imagf( z );
882+
// returns -1.0
883+
```
884+
885+
If provided an out-of-bounds index, the method returns `undefined`.
886+
887+
```javascript
888+
var arr = new Complex64Array( 10 );
889+
890+
var z = arr.get( 100 );
891+
// returns undefined
892+
```
893+
894894
<a name="method-set"></a>
895895

896896
#### Complex64Array.prototype.set( z\[, i] )

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ var HAS_ITERATOR_SYMBOL = hasIteratorSymbolSupport();
6565
* @param {*} value - value to test
6666
* @returns {boolean} boolean indicating if a value is a complex typed array
6767
*/
68-
function isComplexArray( value ) { // TODO: move to array/base/assert/is-complex-array
68+
function isComplexArray( value ) {
6969
return (
7070
value instanceof Complex64Array ||
7171
(
@@ -737,10 +737,10 @@ setReadOnly( Complex64Array.prototype, 'BYTES_PER_ELEMENT', Complex64Array.BYTES
737737
* var z = arr.get( 3 );
738738
*
739739
* var re = realf( z );
740-
* // returns 2
740+
* // returns 2.0
741741
*
742742
* var im = imagf( z );
743-
* // returns 2
743+
* // returns 2.0
744744
*/
745745
setReadOnly( Complex64Array.prototype, 'copyWithin', function copyWithin( target, start ) {
746746
if ( !isComplexArray( this ) ) {

0 commit comments

Comments
 (0)