File: repl.txt

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (1426 lines) | stat: -rw-r--r-- 33,695 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426

{{alias}}( fields[, options] )
    Returns a named typed tuple factory.

    Named tuples assign a property name, and thus a meaning, to each position in
    a tuple and allow for more readable, self-documenting code.

    Named typed tuples can be used wherever typed arrays are used, with the
    added benefit that they allow accessing fields by both field name and
    position index.

    Named typed tuples may be one the following data types:

    - float64: double-precision floating-point numbers (IEEE 754)
    - float32: single-precision floating-point numbers (IEEE 754)
    - int32: 32-bit two's complement signed integers
    - uint32: 32-bit unsigned integers
    - int16: 16-bit two's complement signed integers
    - uint16: 16-bit unsigned integers
    - int8: 8-bit two's complement signed integers
    - uint8: 8-bit unsigned integers
    - uint8c: 8-bit unsigned integers clamped to 0-255

    Parameters
    ----------
    fields: Array<string>
        Field (property) names.

    options: Object (optional)
        Function options.

    options.dtype: string (optional)
        Default tuple data type. If a data type is not provided to a named typed
        tuple factory, this option specifies the underlying tuple data type.
        Default: 'float64'.

    options.name: string (optional)
        Tuple name. Default: 'tuple'.

    Returns
    -------
    factory: Function
        Named typed tuple factory.

    Examples
    --------
    > var opts = {};
    > opts.name = 'Point';
    > var factory = {{alias}}( [ 'x', 'y' ], opts );
    > var tuple = factory();


factory()
    Returns a named typed tuple of the default data type.

    Returns
    -------
    tuple: TypedArray
        Named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > p = factory();
    > p.x
    0.0
    > p.y
    0.0
    > p[ 0 ]
    0.0
    > p[ 1 ]
    0.0


factory( dtype )
    Returns a named typed tuple of the specified data type.

    Parameters
    ----------
    dtype: string
        Tuple data type.

    Returns
    -------
    tuple: TypedArray
        Named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > p = factory( 'int32' );
    > p.x
    0
    > p.y
    0
    > p[ 0 ]
    0
    > p[ 1 ]
    0


factory( typedarray[, dtype] )
    Creates a named typed tuple from a typed array.

    Parameters
    ----------
    typedarray: TypedArray
        Typed array from which to generate a named typed tuple.

    dtype: string (optional)
        Tuple data type.

    Returns
    -------
    tuple: TypedArray
        Named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > p = factory( {{alias:@stdlib/array/float64}}[ 1.0, -1.0 ] );
    > p.x
    1.0
    > p.y
    -1.0
    > p[ 0 ]
    1.0
    > p[ 1 ]
    -1.0


factory( obj[, dtype] )
    Creates a named typed tuple from an array-like object or iterable.

    Parameters
    ----------
    obj: Object
        Array-like object or iterable from which to generate a named typed
        tuple.

    dtype: string (optional)
        Tuple data type.

    Returns
    -------
    tuple: TypedArray
        Named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > p = factory( [ 1, -1 ], 'int32' );
    > p.x
    1
    > p.y
    -1
    > p[ 0 ]
    1
    > p[ 1 ]
    -1


factory( buffer[, byteOffset][, dtype] )
    Returns a named typed tuple view of an ArrayBuffer.

    The view length equals the number of tuple fields.

    Parameters
    ----------
    buffer: ArrayBuffer
        Underlying ArrayBuffer.

    byteOffset: integer (optional)
        Integer byte offset specifying the location of the first tuple element.
        Default: 0.

    dtype: string (optional)
        Tuple data type.

    Returns
    -------
    tuple: TypedArray
        Named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var buf = new {{alias:@stdlib/array/buffer}}( 16 );
    > var p = factory( buf, 4, 'float32' );
    > p.x
    0.0
    > p.y
    0.0
    > p[ 0 ]
    0.0
    > p[ 1 ]
    0.0


factory.from( src[, map[, thisArg]] )
    Creates a new named typed tuple from an array-like object or an iterable.

    A callback is provided the following arguments:

    - value: source value.
    - index: source index.
    - field: tuple field.

    Parameters
    ----------
    src: ArrayLike|Iterable
        Source of tuple elements.

    map: Function (optional)
        Callback to invoke for each source element.

    thisArg: Any (optional)
        Callback execution context.

    Returns
    -------
    tuple: TypedArray
        Named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > function mapFcn( v ) { return v * 2.0; };
    > var p = factory.from( [ 1.0, -1.0 ], mapFcn );
    > p.x
    2.0
    > p.y
    -2.0
    > p[ 0 ]
    2.0
    > p[ 1 ]
    -2.0


factory.fromObject( obj[, map[, thisArg]] )
    Creates a new named typed tuple from an object containing tuple fields.

    A callback is provided the following arguments:

    - value: source object tuple field value.
    - field: source object tuple field name.

    Parameters
    ----------
    obj: Object
        Source object.

    map: Function (optional)
        Callback to invoke for each source object tuple field.

    thisArg: Any (optional)
        Callback execution context.

    Returns
    -------
    tuple: TypedArray
        Named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory.fromObject( { 'x': 2.0, 'y': -2.0 } );
    > p.x
    2.0
    > p.y
    -2.0
    > p[ 0 ]
    2.0
    > p[ 1 ]
    -2.0


factory.of( element0[, element1[, ...elementN]] )
    Creates a new named typed tuple from a variable number of arguments.

    The number of arguments *must* equal the number of tuple fields.

    Parameters
    ----------
    element0: number
        Tuple element.

    element1: number (optional)
        Tuple element.

    elementN: number (optional)
        Tuple elements.

    Returns
    -------
    tuple: TypedArray
        Named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory.of( 2.0, -2.0 );
    > p.x
    2.0
    > p.y
    -2.0
    > p[ 0 ]
    2.0
    > p[ 1 ]
    -2.0


tuple.BYTES_PER_ELEMENT
    Size (in bytes) of each tuple element.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > p.BYTES_PER_ELEMENT
    8


tuple.buffer
    Pointer to the underlying data buffer.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > p.buffer
    <ArrayBuffer>


tuple.byteLength
    Length (in bytes) of the tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > p.byteLength
    16


tuple.byteOffset
    Offset (in bytes) of a tuple from the start of its underlying ArrayBuffer.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > p.byteOffset
    0


tuple.length
    Tuple length (i.e., number of elements).

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > p.length
    2


tuple.name
    Tuple name.

    Examples
    --------
    > var opts = { 'name': 'Point' };
    > var factory = {{alias}}( [ 'x', 'y' ], opts );
    > var p = factory( [ 1.0, -1.0 ] );
    > p.name
    'Point'


tuple.fields
    Returns the list of tuple fields.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > p.fields
    [ 'x', 'y' ]


tuple.orderedFields
    Returns the list of tuple fields in index order.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > p[ 0 ]
    1.0
    > p.sort();
    > p[ 0 ]
    -1.0
    > p.fields
    [ 'x', 'y' ]
    > p.orderedFields
    [ 'y', 'x' ]


tuple.copyWithin( target, start[, end] )
    Copies a sequence of elements within the tuple starting at `start` and
    ending at `end` (non-inclusive) to the position starting at `target`.

    Parameters
    ----------
    target: integer
        Target start index position.

    start: integer
        Source start index position.

    end: integer (optional)
        Source end index position. Default: tuple.length.

    Returns
    -------
    tuple: TypedArray
        Modified tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z', 'w', 'v' ] );
    > var p = factory( [ 2.0, -2.0, 1.0, -1.0, 1.0 ] );
    > p.copyWithin( 3, 0, 2 );
    > p.w
    2.0
    > p.v
    -2.0


tuple.entries()
    Returns an iterator for iterating over tuple key-value pairs.

    Returns
    -------
    iter: Iterator
        Iterator for iterating over tuple key-value pairs.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > it = p.entries();
    > it.next().value
    [ 0, 'x', 1.0 ]
    > it.next().value
    [ 1, 'y', -1.0 ]
    > it.next().done
    true


tuple.every( predicate[, thisArg] )
    Tests whether all tuple elements pass a test implemented by a predicate
    function.

    A predicate function is provided the following arguments:

    - value: tuple element.
    - index: tuple index.
    - field: tuple field name.
    - tuple: tuple on which the method is invoked.

    Parameters
    ----------
    predicate: Function
        Predicate function which tests tuple elements. If a predicate function
        returns a truthy value, a tuple element passes; otherwise, a tuple
        element fails.

    thisArg: Any (optional)
        Callback execution context.

    Returns
    -------
    bool: boolean
        Boolean indicating whether all tuple elements pass.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > function predicate( v ) { return ( v >= 0.0 ); };
    > p.every( predicate )
    false


tuple.fieldOf( searchElement[, fromIndex] )
    Returns the field of the first tuple element strictly equal to a search
    element.

    The method does not distinguish between signed and unsigned zero.

    If unable to locate a search element, the method returns `undefined`.

    Parameters
    ----------
    searchElement: number
        Search element.

    fromIndex: integer (optional)
        Tuple index from which to begin searching. If provided a negative value,
        the method resolves the start index relative to the last tuple element.
        Default: 0.

    Returns
    -------
    field: string|undefined
        Tuple field.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > var f = p.fieldOf( 2.0 )
    undefined
    > f = p.fieldOf( -1.0 )
    'z'


tuple.fill( value[, start[, end]] )
    Fills a tuple from a start index to an end index (non-inclusive) with a
    provided value.

    Parameters
    ----------
    value: number
        Fill value.

    start: integer (optional)
        Start index. If less than zero, the start index is resolved relative to
        the last tuple element. Default: 0.

    end: integer (optional)
        End index (non-inclusive). If less than zero, the end index is resolved
        relative to the last tuple element. Default: tuple.length.

    Returns
    -------
    tuple: TypedArray
        Modified tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > p.fill( 2.0 );
    > p.x
    2.0
    > p.y
    2.0


tuple.filter( predicate[, thisArg] )
    Creates a new tuple which includes those elements for which a predicate
    function returns a truthy value.

    A predicate function is provided the following arguments:

    - value: tuple element.
    - index: tuple index.
    - field: tuple field name.
    - tuple: tuple on which the method is invoked.

    The returned tuple has the same data type as the host tuple.

    If a predicate function does not return a truthy value for any tuple
    element, the method returns `null`.

    Parameters
    ----------
    predicate: Function
        Predicate function which filters tuple elements. If a predicate function
        returns a truthy value, a tuple element is included in the output tuple;
        otherwise, a tuple element is not included in the output tuple.

    thisArg: Any (optional)
        Callback execution context.

    Returns
    -------
    tuple: TypedArray
        A new named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p1 = factory( [ 1.0, 0.0, -1.0 ] );
    > function predicate( v ) { return ( v >= 0.0 ); };
    > var p2 = p1.filter( predicate );
    > p2.fields
    [ 'x', 'y' ]


tuple.find( predicate[, thisArg] )
    Returns the first tuple element for which a provided predicate function
    returns a truthy value.

    A predicate function is provided the following arguments:

    - value: tuple element.
    - index: tuple index.
    - field: tuple field name.
    - tuple: tuple on which the method is invoked.

    If a predicate function never returns a truthy value, the method returns
    `undefined`.

    Parameters
    ----------
    predicate: Function
        Predicate function which tests tuple elements.

    thisArg: Any (optional)
        Callback execution context.

    Returns
    -------
    value: number|undefined
        Tuple element.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > function predicate( v ) { return ( v < 0.0 ); };
    > var v = p.find( predicate )
    -1.0


tuple.findField( predicate[, thisArg] )
    Returns the field of the first tuple element for which a provided predicate
    function returns a truthy value.

    A predicate function is provided the following arguments:

    - value: tuple element.
    - index: tuple index.
    - field: tuple field name.
    - tuple: tuple on which the method is invoked.

    If a predicate function never returns a truthy value, the method returns
    `undefined`.

    Parameters
    ----------
    predicate: Function
        Predicate function which tests tuple elements.

    thisArg: Any (optional)
        Callback execution context.

    Returns
    -------
    field: string|undefined
        Tuple field.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > function predicate( v ) { return ( v < 0.0 ); };
    > var f = p.findField( predicate )
    'z'


tuple.findIndex( predicate[, thisArg] )
    Returns the index of the first tuple element for which a provided predicate
    function returns a truthy value.

    A predicate function is provided the following arguments:

    - value: tuple element.
    - index: tuple index.
    - field: tuple field name.
    - tuple: tuple on which the method is invoked.

    If a predicate function never returns a truthy value, the method returns
    `-1`.

    Parameters
    ----------
    predicate: Function
        Predicate function which tests tuple elements.

    thisArg: Any (optional)
        Callback execution context.

    Returns
    -------
    idx: integer
        Tuple index.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > function predicate( v ) { return ( v < 0.0 ); };
    > var idx = p.findIndex( predicate )
    2


tuple.forEach( fcn[, thisArg] )
    Invokes a callback for each tuple element.

    A provided function is provided the following arguments:

    - value: tuple element.
    - index: tuple index.
    - field: tuple field name.
    - tuple: tuple on which the method is invoked.

    Parameters
    ----------
    fcn: Function
        Function to invoke for each tuple element.

    thisArg: Any (optional)
        Callback execution context.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1, 0, -1 ], 'int32' );
    > var str = ' ';
    > function fcn( v, i, f ) { str += f + '=' + v + ' '; };
    > p.forEach( fcn );
    > str
    ' x=1 y=0 z=-1 '


tuple.includes( searchElement[, fromIndex] )
    Returns a boolean indicating whether a tuple includes a search element.

    The method does not distinguish between signed and unsigned zero.

    Parameters
    ----------
    searchElement: number
        Search element.

    fromIndex: integer (optional)
        Tuple index from which to begin searching. If provided a negative value,
        the method resolves the start index relative to the last tuple element.
        Default: 0.

    Returns
    -------
    bool: boolean
        Boolean indicating whether a tuple includes a search element.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > var bool = p.includes( 2.0 )
    false
    > bool = p.includes( -1.0 )
    true


tuple.indexOf( searchElement[, fromIndex] )
    Returns the index of the first tuple element strictly equal to a search
    element.

    The method does not distinguish between signed and unsigned zero.

    If unable to locate a search element, the method returns `-1`.

    Parameters
    ----------
    searchElement: number
        Search element.

    fromIndex: integer (optional)
        Tuple index from which to begin searching. If provided a negative value,
        the method resolves the start index relative to the last tuple element.
        Default: 0.

    Returns
    -------
    idx: integer
        Tuple index.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > var idx = p.indexOf( 2.0 )
    -1
    > idx = p.indexOf( -1.0 )
    2


tuple.ind2key( ind )
    Converts a tuple index to a field name.

    If provided an out-of-bounds index, the method returns `undefined`.

    Parameters
    ----------
    ind: integer
        Tuple index. If less than zero, the method resolves the index relative
        to the last tuple element.

    Returns
    -------
    field: string|undefined
        Field name.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > p.ind2key( 1 )
    'y'
    > p.ind2key( 100 )
    undefined


tuple.join( [separator] )
    Serializes a tuple by joining all tuple elements as a string.

    Parameters
    ----------
    separator: string (optional)
        String delineating tuple elements. Default: ','.

    Returns
    -------
    str: string
        Tuple serialized as a string.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1, 0, -1 ], 'int32' );
    > p.join( '|' )
    '1|0|-1'


tuple.keys()
    Returns an iterator for iterating over tuple keys.

    Returns
    -------
    iter: Iterator
        Iterator for iterating over tuple keys.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > it = p.keys();
    > it.next().value
    [ 0, 'x' ]
    > it.next().value
    [ 1, 'y' ]
    > it.next().done
    true


tuple.key2ind( field )
    Converts a field name to a tuple index.

    If provided an unknown field name, the method returns `-1`.

    Parameters
    ----------
    field: string
        Tuple field name.

    Returns
    -------
    idx: integer
        Tuple index.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > p.key2ind( 'y' )
    1


tuple.lastFieldOf( searchElement[, fromIndex] )
    Returns the field of the last tuple element strictly equal to a search
    element.

    The method iterates from the last tuple element to the first tuple element.

    The method does not distinguish between signed and unsigned zero.

    If unable to locate a search element, the method returns `undefined`.

    Parameters
    ----------
    searchElement: number
        Search element.

    fromIndex: integer (optional)
        Tuple index from which to begin searching. If provided a negative value,
        the method resolves the start index relative to the last tuple element.
        Default: -1.

    Returns
    -------
    field: string|undefined
        Tuple field.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z', 'w', 'v' ] );
    > var p = factory( [ 1.0, 0.0, -1.0, 0.0, 1.0 ] );
    > var f = p.lastFieldOf( 2.0 )
    undefined
    > f = p.lastFieldOf( 0.0 )
    'w'


tuple.lastIndexOf( searchElement[, fromIndex] )
    Returns the index of the last tuple element strictly equal to a search
    element.

    The method iterates from the last tuple element to the first tuple element.

    The method does not distinguish between signed and unsigned zero.

    If unable to locate a search element, the method returns `-1`.

    Parameters
    ----------
    searchElement: number
        Search element.

    fromIndex: integer (optional)
        Tuple index from which to begin searching. If provided a negative value,
        the method resolves the start index relative to the last tuple element.
        Default: -1.

    Returns
    -------
    idx: integer
        Tuple index.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z', 'w', 'v' ] );
    > var p = factory( [ 1.0, 0.0, -1.0, 0.0, 1.0 ] );
    > var idx = p.lastIndexOf( 2.0 )
    -1
    > idx = p.lastIndexOf( 0.0 )
    3


tuple.map( fcn[, thisArg] )
    Maps each tuple element to an element in a new tuple.

    A provided function is provided the following arguments:

    - value: tuple element.
    - index: tuple index.
    - field: tuple field name.
    - tuple: tuple on which the method is invoked.

    The returned tuple has the same data type as the host tuple.

    Parameters
    ----------
    fcn: Function
        Function which maps tuple elements to elements in the new tuple.

    thisArg: Any (optional)
        Callback execution context.

    Returns
    -------
    tuple: TypedArray
        A new named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p1 = factory( [ 1.0, 0.0, -1.0 ] );
    > function fcn( v ) { return v * 2.0; };
    > var p2 = p1.map( fcn );
    > p2.x
    2.0
    > p2.y
    0.0
    > p2.z
    -2.0


tuple.reduce( fcn[, initialValue] )
    Applies a function against an accumulator and each element in a tuple and
    returns the accumulated result.

    The provided function is provided the following arguments:

    - acc: accumulated result.
    - value: current tuple element.
    - index: index of the current tuple element.
    - field: field name corresponding to the current tuple element.
    - tuple: tuple on which the method is invoked.

    If provided an initial value, the method invokes a provided function with
    the initial value as the first argument and the first tuple element as the
    second argument.

    If not provided an initial value, the method invokes a provided function
    with the first tuple element as the first argument and the second tuple
    element as the second argument.

    Parameters
    ----------
    fcn: Function
        Function to apply.

    initialValue: Any (optional)
        Initial accumulation value.

    Returns
    -------
    out: Any
        Accumulated result.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > function fcn( acc, v ) { return acc + (v*v); };
    > var v = p.reduce( fcn, 0.0 )
    2.0


tuple.reduceRight( fcn[, initialValue] )
    Applies a function against an accumulator and each element in a tuple and
    returns the accumulated result, iterating from right to left.

    The provided function is provided the following arguments:

    - acc: accumulated result.
    - value: current tuple element.
    - index: index of the current tuple element.
    - field: field name corresponding to the current tuple element.
    - tuple: tuple on which the method is invoked.

    If provided an initial value, the method invokes a provided function with
    the initial value as the first argument and the last tuple element as the
    second argument.

    If not provided an initial value, the method invokes a provided function
    with the last tuple element as the first argument and the second-to-last
    tuple element as the second argument.

    Parameters
    ----------
    fcn: Function
        Function to apply.

    initialValue: Any (optional)
        Initial accumulation value.

    Returns
    -------
    out: Any
        Accumulated result.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > function fcn( acc, v ) { return acc + (v*v); };
    > var v = p.reduceRight( fcn, 0.0 )
    2.0


tuple.reverse()
    Reverses a tuple *in-place*.

    This method mutates the tuple on which the method is invoked.

    Returns
    -------
    tuple: TypedArray
        Modified tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > p[ 0 ]
    1.0
    > p.x
    1.0
    > p.reverse();
    > p[ 0 ]
    -1.0
    > p.x
    1.0


tuple.set( arr[, offset] )
    Sets tuple elements.

    Parameters
    ----------
    arr: ArrayLike
        Source array containing tuple values to set.

    offset: integer (optional)
        Tuple index at which to start writing values. Default: 0.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, 0.0, -1.0 ] );
    > p[ 1 ]
    0.0
    > p.y
    0.0
    > p.set( [ -2.0, 2.0 ], 1 );
    > p[ 1 ]
    -2.0
    > p.y
    -2.0
    > p[ 2 ]
    2.0
    > p.z
    2.0


tuple.slice( [begin[, end]] )
    Copies tuple elements to a new tuple with the same underlying data type as
    the host tuple.

    If the method is unable to resolve indices to a non-empty tuple subsequence,
    the method returns `null`.

    Parameters
    ----------
    begin: integer (optional)
        Start element index (inclusive). If less than zero, the start index is
        resolved relative to the last tuple element. Default: 0.

    end: integer (optional)
        End element index (exclusive). If less than zero, the end index is
        resolved relative to the last tuple element. Default: tuple.length.

    Returns
    -------
    tuple: TypedArray
        A new named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p1 = factory( [ 1.0, 0.0, -1.0 ] );
    > p1.fields
    [ 'x', 'y', 'z' ]
    > var p2 = p1.slice( 1 );
    > p2.fields
    [ 'y', 'z' ]
    > p2.y
    0.0
    > p2.z
    -1.0


tuple.some( predicate[, thisArg] )
    Tests whether at least one tuple element passes a test implemented by a
    predicate function.

    A predicate function is provided the following arguments:

    - value: tuple element.
    - index: tuple index.
    - field: tuple field name.
    - tuple: tuple on which the method is invoked.

    Parameters
    ----------
    predicate: Function
        Predicate function which tests tuple elements. If a predicate function
        returns a truthy value, a tuple element passes; otherwise, a tuple
        element fails.

    thisArg: Any (optional)
        Callback execution context.

    Returns
    -------
    bool: boolean
        Boolean indicating whether at least one tuple element passes.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > function predicate( v ) { return ( v < 0.0 ); };
    > p.some( predicate )
    true


tuple.sort( [compareFunction] )
    Sorts a tuple *in-place*.

    Sorting a tuple does *not* affect field assignments. Accessing a tuple field
    before and after sorting will always return the same tuple element. However,
    this behavior is generally not true when accessing tuple elements according
    to tuple index. In summary, sorting affects index order but not field
    assignments.

    The comparison function is provided two tuple elements per invocation: `a`
    and `b`.

    The comparison function return value determines the sort order as follows:

    - If the comparison function returns a value less than zero, then the method
    sorts `a` to an index lower than `b` (i.e., `a` should come *before* `b`).

    - If the comparison function returns a value greater than zero, then the
    method sorts `a` to an index higher than `b` (i.e., `b` should come *before*
    `a`).

    - If the comparison function returns zero, then the relative order of `a`
    and `b` should remain unchanged.

    This method mutates the tuple on which the method is invoked.

    Parameters
    ----------
    compareFunction: Function (optional)
        Function which specifies the sort order. The default sort order is
        ascending order.

    Returns
    -------
    tuple: TypedArray
        Modified tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z', 'w', 'v' ] );
    > var p = factory( [ 1.0, -1.0, 0.0, 2.0, -2.0 ] );
    > p.sort();
    > p.orderedFields
    [ 'v', 'y', 'z', 'x', 'w' ]
    > p[ 0 ]
    -2.0
    > p.x
    1.0
    > p[ 1 ]
    -1.0
    > p.y
    -1.0
    > p.key2ind( 'x' )
    3


tuple.subarray( [begin[, end]] )
    Creates a new typed array over the same underlying ArrayBuffer and with the
    same underlying data type as the host tuple.

    If the method is unable to resolve indices to a non-empty tuple subsequence,
    the method returns an empty typed array.

    Parameters
    ----------
    begin: integer (optional)
        Start element index (inclusive). If less than zero, the start index is
        resolved relative to the last tuple element. Default: 0.

    end: integer (optional)
        End element index (exclusive). If less than zero, the end index is
        resolved relative to the last tuple element. Default: tuple.length.

    Returns
    -------
    arr: TypedArray
        A new typed array view.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z', 'w', 'v' ] );
    > var p = factory( [ 1.0, -1.0, 0.0, 2.0, -2.0 ] );
    > var arr = p.subarray( 2 )
    <Float64Array>[ 0.0, 2.0, -2.0 ]
    > arr.length
    3


tuple.subtuple( [begin[, end]] )
    Creates a new named typed tuple over the same underlying ArrayBuffer and
    with the same underlying data type as the host tuple.

    If the function is unable to resolve indices to a non-empty tuple
    subsequence, the function returns `null`.

    Parameters
    ----------
    begin: integer (optional)
        Start element index (inclusive). If less than zero, the start index is
        resolved relative to the last tuple element. Default: 0.

    end: integer (optional)
        End element index (exclusive). If less than zero, the end index is
        resolved relative to the last tuple element. Default: tuple.length.

    Returns
    -------
    tuple: TypedArray|null
        A new named typed tuple.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z', 'w', 'v' ] );
    > var p1 = factory( [ 1.0, -1.0, 0.0, 2.0, -2.0 ] );
    > var p2 = p1.subtuple( 2 );
    > p2.fields
    [ 'z', 'w', 'v' ]
    > p2[ 0 ]
    0.0
    > p2.z
    0.0
    > p2[ 1 ]
    2.0
    > p2.w
    2.0
    > p2[ 2 ]
    -2.0
    > p2.v
    -2.0
    > p2.length
    3


tuple.toJSON()
    Serializes a tuple as JSON.

    Returns
    -------
    obj: Object
        A tuple JSON representation.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, -1.0, 0.0 ] );
    > p.toJSON()
    { 'x': 1.0, 'y': -1.0, 'z': 0.0 }


tuple.toLocaleString( [locales[, options]] )
    Serializes a tuple as a locale-specific string.

    Parameters
    ----------
    locales: string|Array<string> (optional)
        A BCP 47 language tag, or an array of such tags.

    options: Object (optional)
        Options.

    Returns
    -------
    str: string
        A typed array string representation.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y', 'z' ] );
    > var p = factory( [ 1.0, -1.0, 0.0 ], 'int32' );
    > p.toLocaleString()
    '1,-1,0'


tuple.toString()
    Serializes a tuple as a string.

    Returns
    -------
    str: string
        A tuple string representation.

    Examples
    --------
    > opts = { 'name': 'Point' };
    > var factory = {{alias}}( [ 'x', 'y', 'z' ], opts );
    > var p = factory( [ 1.0, -1.0, 0.0 ] );
    > p.toString()
    'Point(x=1, y=-1, z=0)'


tuple.values()
    Returns an iterator for iterating over tuple elements.

    Returns
    -------
    iter: Iterator
        Iterator for iterating over tuple elements.

    Examples
    --------
    > var factory = {{alias}}( [ 'x', 'y' ] );
    > var p = factory( [ 1.0, -1.0 ] );
    > it = p.values();
    > it.next().value
    1.0
    > it.next().value
    -1.0
    > it.next().done
    true

    See Also
    --------