← Back to branch summary

~ubuntu-branches/ubuntu/wily/julia/wily

« back to all changes in this revision

Viewing changes to doc/helpdb.jl

  • Committer: Package Import Robot
  • Author(s): Sébastien Villemot
  • Date: 2013-02-11 03:51:26 UTC
  • mfrom: (1.1.4)
  • Revision ID: package-import@ubuntu.com-20130211035126-hap464pbhd97wjbl
Tags: 0.1~20130211.git86fbe98d-1
* New upstream snapshot.
* debian/control:
   + add git to Recommends (for Julia package manager)
   + remove dependencies on libglpk-dev (it moved to its own package)
   + add explicit dependency on libgmp10 (there is no more a wrapper)
* fix-clean-rules.patch: remove patch, applied upstream
* gsvddense_blasint.patch: new patch
* Refresh other patches

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/helpdb.jl
246
246
 
247
247
"),
248
248
 
249
 
(E"Getting Around",E"Base",E"load",E"load(\"file\")
 
249
(E"Getting Around",E"Base",E"require",E"require(\"file\")
250
250
 
251
251
   Evaluate the contents of a source file
252
252
 
426
426
 
427
427
"),
428
428
 
 
429
(E"Types",E"Base",E"maxintfloat",E"maxintfloat(type)
 
430
 
 
431
   The largest integer losslessly representable by the given floating-
 
432
   point type
 
433
 
 
434
"),
 
435
 
429
436
(E"Types",E"Base",E"sizeof",E"sizeof(type)
430
437
 
431
438
   Size, in bytes, of the canonical binary representation of the given
505
512
 
506
513
"),
507
514
 
 
515
(E"Iteration",E"Base",E"zip",E"zip(iters...)
 
516
 
 
517
   For a set of iterable objects, returns an iterable of tuples, where
 
518
   the >>``<<i``th tuple contains the >>``<<i``th component of each
 
519
   input iterable.
 
520
 
 
521
   Note that \"zip\" is it's own inverse: [zip(zip(a...)...)...] ==
 
522
   [a...]
 
523
 
 
524
"),
 
525
 
508
526
(E"General Collections",E"Base",E"isempty",E"isempty(collection)
509
527
 
510
528
   Determine whether a collection is empty (has no elements).
603
621
 
604
622
"),
605
623
 
606
 
(E"Iterable Collections",E"Base",E"count",E"count(itr)
607
 
 
608
 
   Count the number of boolean elements in \"itr\" which are \"true\"
609
 
   rather than \"false\".
610
 
 
611
 
"),
612
 
 
613
 
(E"Iterable Collections",E"Base",E"countp",E"countp(p, itr)
614
 
 
615
 
   Count the number of elements in \"itr\" for which predicate \"p\"
616
 
   is true.
617
 
 
618
 
"),
619
 
 
620
 
(E"Iterable Collections",E"Base",E"anyp",E"anyp(p, itr)
 
624
(E"Iterable Collections",E"Base",E"any",E"any(p, itr)
621
625
 
622
626
   Determine whether any element of \"itr\" satisfies the given
623
627
   predicate.
624
628
 
625
629
"),
626
630
 
627
 
(E"Iterable Collections",E"Base",E"allp",E"allp(p, itr)
 
631
(E"Iterable Collections",E"Base",E"all",E"all(p, itr)
628
632
 
629
633
   Determine whether all elements of \"itr\" satisfy the given
630
634
   predicate.
653
657
 
654
658
"),
655
659
 
656
 
(E"Associative Collections",E"Base",E"Dict{K,V}",E"Dict{K,V}(n)
 
660
(E"Associative Collections",E"Base",E"Dict{K,V}",E"Dict{K,V}()
657
661
 
658
 
   Construct a hashtable with keys of type K and values of type V and
659
 
   intial size of n
 
662
   Construct a hashtable with keys of type K and values of type V
660
663
 
661
664
"),
662
665
 
673
676
 
674
677
"),
675
678
 
676
 
(E"Associative Collections",E"Base",E"del",E"del(collection, key)
 
679
(E"Associative Collections",E"Base",E"delete!",E"delete!(collection, key)
677
680
 
678
681
   Delete the mapping for the given key in a collection.
679
682
 
680
683
"),
681
684
 
682
 
(E"Associative Collections",E"Base",E"del_all",E"del_all(collection)
 
685
(E"Associative Collections",E"Base",E"empty!",E"empty!(collection)
683
686
 
684
687
   Delete all keys from a collection.
685
688
 
697
700
 
698
701
"),
699
702
 
700
 
(E"Associative Collections",E"Base",E"pairs",E"pairs(collection)
 
703
(E"Associative Collections",E"Base",E"collect",E"collect(collection)
701
704
 
702
 
   Return an array of all (key, value) tuples in a collection.
 
705
   Return an array of all items in a collection. For associative
 
706
   collections, returns (key, value) tuples.
703
707
 
704
708
"),
705
709
 
729
733
 
730
734
"),
731
735
 
732
 
(E"Set-Like Collections",E"Base",E"add",E"add(collection, key)
 
736
(E"Associative Collections",E"Base",E"eltype",E"eltype(collection)
 
737
 
 
738
   Returns the type tuple of the (key,value) pairs contained in
 
739
   collection.
 
740
 
 
741
"),
 
742
 
 
743
(E"Set-Like Collections",E"Base",E"add!",E"add!(collection, key)
733
744
 
734
745
   Add an element to a set-like collection.
735
746
 
813
824
 
814
825
"),
815
826
 
816
 
(E"Dequeues",E"Base",E"grow!",E"grow!(collection, n)
 
827
(E"Dequeues",E"Base",E"resize!",E"resize!(collection, n)
817
828
 
818
 
   Add uninitialized space for \"n\" elements at the end of a
819
 
   collection.
 
829
   Resize collection to contain \"n\" elements.
820
830
 
821
831
"),
822
832
 
826
836
 
827
837
"),
828
838
 
829
 
(E"Strings",E"Base",E"strlen",E"strlen(s)
 
839
(E"Strings",E"Base",E"length",E"length(s)
830
840
 
831
841
   The number of characters in string \"s\".
832
842
 
833
843
"),
834
844
 
835
 
(E"Strings",E"Base",E"length",E"length(s)
836
 
 
837
 
   The last valid index for string \"s\". Indexes are byte offsets and
838
 
   not character numbers.
839
 
 
840
 
"),
841
 
 
842
 
(E"Strings",E"Base",E"chars",E"chars(string)
 
845
(E"Strings",E"Base",E"collect",E"collect(string)
843
846
 
844
847
   Return an array of the characters in \"string\".
845
848
 
846
849
"),
847
850
 
848
 
(E"Strings",E"Base",E"strcat",E"strcat(strs...)
 
851
(E"Strings",E"Base",E"string",E"string(strs...)
849
852
 
850
853
   Concatenate strings.
851
854
 
902
905
 
903
906
"),
904
907
 
905
 
(E"Strings",E"Base",E"strchr",E"strchr(string, char[, i])
 
908
(E"Strings",E"Base",E"search",E"search(string, char[, i])
906
909
 
907
910
   Return the index of \"char\" in \"string\", giving 0 if not found.
908
911
   The second argument may also be a vector or a set of characters.
931
934
   characters, a string, or a regular expression (but regular
932
935
   expressions are only allowed on contiguous strings, such as ASCII
933
936
   or UTF-8 strings). The third argument optionally specifies a
934
 
   starting index. The return value is a tuple with 2 integers: the
935
 
   index of the match and the first valid index past the match (or an
936
 
   index beyond the end of the string if the match is at the end); it
937
 
   returns \"(0,0)\" if no match was found, and \"(start,start)\" if
938
 
   \"chars\" is empty.
 
937
   starting index. The return value is a range of indexes where the
 
938
   matching sequence is found, such that \"s[search(s,x)] == x\". The
 
939
   return value is \"0:-1\" if there is no match.
939
940
 
940
941
"),
941
942
 
1052
1053
 
1053
1054
"),
1054
1055
 
1055
 
(E"I/O",E"Base",E"stdout_stream",E"stdout_stream
 
1056
(E"Strings",E"Base",E"charwidth",E"charwidth(c)
 
1057
 
 
1058
   Gives the number of columns needed to print a character.
 
1059
 
 
1060
"),
 
1061
 
 
1062
(E"Strings",E"Base",E"strwidth",E"strwidth(s)
 
1063
 
 
1064
   Gives the number of columns needed to print a string.
 
1065
 
 
1066
"),
 
1067
 
 
1068
(E"I/O",E"Base",E"STDOUT",E"STDOUT
1056
1069
 
1057
1070
   Global variable referring to the standard out stream.
1058
1071
 
1059
1072
"),
1060
1073
 
1061
 
(E"I/O",E"Base",E"stderr_stream",E"stderr_stream
 
1074
(E"I/O",E"Base",E"STDERR",E"STDERR
1062
1075
 
1063
1076
   Global variable referring to the standard error stream.
1064
1077
 
1065
1078
"),
1066
1079
 
1067
 
(E"I/O",E"Base",E"stdin_stream",E"stdin_stream
 
1080
(E"I/O",E"Base",E"STDIN",E"STDIN
1068
1081
 
1069
1082
   Global variable referring to the standard input stream.
1070
1083
 
1101
1114
 
1102
1115
"),
1103
1116
 
1104
 
(E"I/O",E"Base",E"memio",E"memio([size])
 
1117
(E"I/O",E"Base",E"IOBuffer",E"IOBuffer([size])
1105
1118
 
1106
1119
   Create an in-memory I/O stream, optionally specifying how much
1107
1120
   initial space is needed.
1176
1189
 
1177
1190
"),
1178
1191
 
 
1192
(E"I/O",E"Base",E"eof",E"eof(stream)
 
1193
 
 
1194
   Tests whether an I/O stream is at end-of-file. If the stream is not
 
1195
   yet exhausted, this function will block to wait for more data if
 
1196
   necessary, and then return \"false\". Therefore it is always safe
 
1197
   to read one byte after seeing \"eof\" return \"false\".
 
1198
 
 
1199
"),
 
1200
 
1179
1201
(E"Text I/O",E"Base",E"show",E"show(x)
1180
1202
 
1181
1203
   Write an informative text representation of a value to the current
1236
1258
 
1237
1259
"),
1238
1260
 
1239
 
(E"Text I/O",E"Base",E"EachLine",E"EachLine(stream)
 
1261
(E"Text I/O",E"Base",E"each_line",E"each_line(stream)
1240
1262
 
1241
1263
   Create an iterable object that will yield each line from a stream.
1242
1264
 
1243
1265
"),
1244
1266
 
1245
 
(E"Text I/O",E"Base",E"dlmread",E"dlmread(filename, delim::Char)
 
1267
(E"Text I/O",E"Base",E"readdlm",E"readdlm(filename, delim::Char)
1246
1268
 
1247
1269
   Read a matrix from a text file where each line gives one row, with
1248
1270
   elements separated by the given delimeter. If all data is numeric,
1251
1273
 
1252
1274
"),
1253
1275
 
1254
 
(E"Text I/O",E"Base",E"dlmread",E"dlmread(filename, delim::Char, T::Type)
 
1276
(E"Text I/O",E"Base",E"readdlm",E"readdlm(filename, delim::Char, T::Type)
1255
1277
 
1256
1278
   Read a matrix from a text file with a given element type. If \"T\"
1257
1279
   is a numeric type, the result is an array of that type, with any
1261
1283
 
1262
1284
"),
1263
1285
 
1264
 
(E"Text I/O",E"Base",E"dlmwrite",E"dlmwrite(filename, array, delim::Char)
 
1286
(E"Text I/O",E"Base",E"writedlm",E"writedlm(filename, array, delim::Char)
1265
1287
 
1266
1288
   Write an array to a text file using the given delimeter (defaults
1267
1289
   to comma).
1268
1290
 
1269
1291
"),
1270
1292
 
1271
 
(E"Text I/O",E"Base",E"csvread",E"csvread(filename[, T::Type])
 
1293
(E"Text I/O",E"Base",E"readcsv",E"readcsv(filename[, T::Type])
1272
1294
 
1273
 
   Equivalent to \"dlmread\" with \"delim\" set to comma.
 
1295
   Equivalent to \"readdlm\" with \"delim\" set to comma.
1274
1296
 
1275
1297
"),
1276
1298
 
1277
 
(E"Text I/O",E"Base",E"csvwrite",E"csvwrite(filename, array)
 
1299
(E"Text I/O",E"Base",E"writecsv",E"writecsv(filename, array)
1278
1300
 
1279
 
   Equivalent to \"dlmwrite\" with \"delim\" set to comma.
 
1301
   Equivalent to \"writedlm\" with \"delim\" set to comma.
1280
1302
 
1281
1303
"),
1282
1304
 
1348
1370
 
1349
1371
"),
1350
1372
 
1351
 
(E"Mathematical Functions",E"Base",E"div",E"div()
1352
 
 
1353
 
   Integer truncating division
1354
 
 
1355
 
"),
1356
 
 
1357
 
(E"Mathematical Functions",E"Base",E"fld",E"fld()
1358
 
 
1359
 
   Integer floor division
1360
 
 
1361
 
"),
1362
 
 
1363
 
(E"Mathematical Functions",E"Base",E"mod",E"mod()
1364
 
 
1365
 
   Modulus after division
 
1373
(E"Mathematical Functions",E"Base",E"div",E"div(a, b)
 
1374
 
 
1375
   Compute a/b, truncating to an integer
 
1376
 
 
1377
"),
 
1378
 
 
1379
(E"Mathematical Functions",E"Base",E"fld",E"fld(a, b)
 
1380
 
 
1381
   Largest integer less than or equal to a/b
 
1382
 
 
1383
"),
 
1384
 
 
1385
(E"Mathematical Functions",E"Base",E"mod",E"mod(x, m)
 
1386
 
 
1387
   Modulus after division, returning in the range [0,m)
1366
1388
 
1367
1389
"),
1368
1390
 
1372
1394
 
1373
1395
"),
1374
1396
 
 
1397
(E"Mathematical Functions",E"Base",E"mod1",E"mod1(x, m)
 
1398
 
 
1399
   Modulus after division, returning in the range (0,m]
 
1400
 
 
1401
"),
 
1402
 
1375
1403
(E"Mathematical Functions",E"Base",E"//",E"//()
1376
1404
 
1377
1405
   Rational division
1378
1406
 
1379
1407
"),
1380
1408
 
 
1409
(E"Mathematical Functions",E"Base",E"num",E"num(x)
 
1410
 
 
1411
   Numerator of the rational representation of \"x\"
 
1412
 
 
1413
"),
 
1414
 
 
1415
(E"Mathematical Functions",E"Base",E"den",E"den(x)
 
1416
 
 
1417
   Denominator of the rational representation of \"x\"
 
1418
 
 
1419
"),
 
1420
 
1381
1421
(E"Mathematical Functions",E"",E"<< >>",E"<< >>
1382
1422
 
1383
1423
   Left and right shift operators
1391
1431
 
1392
1432
"),
1393
1433
 
 
1434
(E"Mathematical Functions",E"Base",E"cmp",E"cmp(x, y)
 
1435
 
 
1436
   Return -1, 0, or 1 depending on whether \"x<y\", \"x==y\", or
 
1437
   \"x>y\", respectively
 
1438
 
 
1439
"),
 
1440
 
1394
1441
(E"Mathematical Functions",E"Base",E"!",E"!()
1395
1442
 
1396
1443
   Boolean not
1423
1470
 
1424
1471
(E"Mathematical Functions",E"Base",E"sin",E"sin(x)
1425
1472
 
1426
 
   Compute sine of \"x\"
 
1473
   Compute sine of \"x\", where \"x\" is in radians
1427
1474
 
1428
1475
"),
1429
1476
 
1430
1477
(E"Mathematical Functions",E"Base",E"cos",E"cos(x)
1431
1478
 
1432
 
   Compute cosine of \"x\"
 
1479
   Compute cosine of \"x\", where \"x\" is in radians
1433
1480
 
1434
1481
"),
1435
1482
 
1436
1483
(E"Mathematical Functions",E"Base",E"tan",E"tan(x)
1437
1484
 
1438
 
   Compute tangent of \"x\"
 
1485
   Compute tangent of \"x\", where \"x\" is in radians
 
1486
 
 
1487
"),
 
1488
 
 
1489
(E"Mathematical Functions",E"Base",E"sind",E"sind(x)
 
1490
 
 
1491
   Compute sine of \"x\", where \"x\" is in degrees
 
1492
 
 
1493
"),
 
1494
 
 
1495
(E"Mathematical Functions",E"Base",E"cosd",E"cosd(x)
 
1496
 
 
1497
   Compute cosine of \"x\", where \"x\" is in degrees
 
1498
 
 
1499
"),
 
1500
 
 
1501
(E"Mathematical Functions",E"Base",E"tand",E"tand(x)
 
1502
 
 
1503
   Compute tangent of \"x\", where \"x\" is in degrees
1439
1504
 
1440
1505
"),
1441
1506
 
1442
1507
(E"Mathematical Functions",E"Base",E"sinh",E"sinh(x)
1443
1508
 
1444
 
   Compute hyperbolic sine of \"x\" specified in radians
 
1509
   Compute hyperbolic sine of \"x\"
1445
1510
 
1446
1511
"),
1447
1512
 
1448
1513
(E"Mathematical Functions",E"Base",E"cosh",E"cosh(x)
1449
1514
 
1450
 
   Compute hyperbolic cosine of \"x\" specified in radians
 
1515
   Compute hyperbolic cosine of \"x\"
1451
1516
 
1452
1517
"),
1453
1518
 
1454
1519
(E"Mathematical Functions",E"Base",E"tanh",E"tanh(x)
1455
1520
 
1456
 
   Compute hyperbolic tangent of \"x\" specified in radians
 
1521
   Compute hyperbolic tangent of \"x\"
1457
1522
 
1458
1523
"),
1459
1524
 
1460
1525
(E"Mathematical Functions",E"Base",E"asin",E"asin(x)
1461
1526
 
1462
 
   Compute the inverse sine of \"x\" specified in radians
 
1527
   Compute the inverse sine of \"x\", where the output is in radians
1463
1528
 
1464
1529
"),
1465
1530
 
1466
1531
(E"Mathematical Functions",E"Base",E"acos",E"acos(x)
1467
1532
 
1468
 
   Compute the inverse cosine of \"x\" specified in radians
 
1533
   Compute the inverse cosine of \"x\", where the output is in radians
1469
1534
 
1470
1535
"),
1471
1536
 
1472
1537
(E"Mathematical Functions",E"Base",E"atan",E"atan(x)
1473
1538
 
1474
 
   Compute the inverse tangent of \"x\" specified in radians
 
1539
   Compute the inverse tangent of \"x\", where the output is in
 
1540
   radians
1475
1541
 
1476
1542
"),
1477
1543
 
1482
1548
 
1483
1549
"),
1484
1550
 
 
1551
(E"Mathematical Functions",E"Base",E"asind",E"asind(x)
 
1552
 
 
1553
   Compute the inverse sine of \"x\", where the output is in degrees
 
1554
 
 
1555
"),
 
1556
 
 
1557
(E"Mathematical Functions",E"Base",E"acosd",E"acosd(x)
 
1558
 
 
1559
   Compute the inverse cosine of \"x\", where the output is in degrees
 
1560
 
 
1561
"),
 
1562
 
 
1563
(E"Mathematical Functions",E"Base",E"atand",E"atand(x)
 
1564
 
 
1565
   Compute the inverse tangent of \"x\", where the output is in
 
1566
   degrees
 
1567
 
 
1568
"),
 
1569
 
1485
1570
(E"Mathematical Functions",E"Base",E"sec",E"sec(x)
1486
1571
 
1487
 
   Compute the secant of \"x\" specified in radians
 
1572
   Compute the secant of \"x\", where \"x\" is in radians
1488
1573
 
1489
1574
"),
1490
1575
 
1491
1576
(E"Mathematical Functions",E"Base",E"csc",E"csc(x)
1492
1577
 
1493
 
   Compute the cosecant of \"x\" specified in radians
 
1578
   Compute the cosecant of \"x\", where \"x\" is in radians
1494
1579
 
1495
1580
"),
1496
1581
 
1497
1582
(E"Mathematical Functions",E"Base",E"cot",E"cot(x)
1498
1583
 
1499
 
   Compute the cotangent of \"x\" specified in radians
 
1584
   Compute the cotangent of \"x\", where \"x\" is in radians
 
1585
 
 
1586
"),
 
1587
 
 
1588
(E"Mathematical Functions",E"Base",E"secd",E"secd(x)
 
1589
 
 
1590
   Compute the secant of \"x\", where \"x\" is in degrees
 
1591
 
 
1592
"),
 
1593
 
 
1594
(E"Mathematical Functions",E"Base",E"cscd",E"cscd(x)
 
1595
 
 
1596
   Compute the cosecant of \"x\", where \"x\" is in degrees
 
1597
 
 
1598
"),
 
1599
 
 
1600
(E"Mathematical Functions",E"Base",E"cotd",E"cotd(x)
 
1601
 
 
1602
   Compute the cotangent of \"x\", where \"x\" is in degrees
1500
1603
 
1501
1604
"),
1502
1605
 
1503
1606
(E"Mathematical Functions",E"Base",E"asec",E"asec(x)
1504
1607
 
1505
 
   Compute the inverse secant of \"x\" specified in radians
 
1608
   Compute the inverse secant of \"x\", where the output is in radians
1506
1609
 
1507
1610
"),
1508
1611
 
1509
1612
(E"Mathematical Functions",E"Base",E"acsc",E"acsc(x)
1510
1613
 
1511
 
   Compute the inverse cosecant of \"x\" specified in radians
 
1614
   Compute the inverse cosecant of \"x\", where the output is in
 
1615
   radians
1512
1616
 
1513
1617
"),
1514
1618
 
1515
1619
(E"Mathematical Functions",E"Base",E"acot",E"acot(x)
1516
1620
 
1517
 
   Compute the inverse cotangent of \"x\" specified in radians
 
1621
   Compute the inverse cotangent of \"x\", where the output is in
 
1622
   radians
 
1623
 
 
1624
"),
 
1625
 
 
1626
(E"Mathematical Functions",E"Base",E"asecd",E"asecd(x)
 
1627
 
 
1628
   Compute the inverse secant of \"x\", where the output is in degrees
 
1629
 
 
1630
"),
 
1631
 
 
1632
(E"Mathematical Functions",E"Base",E"acscd",E"acscd(x)
 
1633
 
 
1634
   Compute the inverse cosecant of \"x\", where the output is in
 
1635
   degrees
 
1636
 
 
1637
"),
 
1638
 
 
1639
(E"Mathematical Functions",E"Base",E"acotd",E"acotd(x)
 
1640
 
 
1641
   Compute the inverse cotangent of \"x\", where the output is in
 
1642
   degrees
1518
1643
 
1519
1644
"),
1520
1645
 
1521
1646
(E"Mathematical Functions",E"Base",E"sech",E"sech(x)
1522
1647
 
1523
 
   Compute the hyperbolic secant of \"x\" specified in radians
 
1648
   Compute the hyperbolic secant of \"x\"
1524
1649
 
1525
1650
"),
1526
1651
 
1527
1652
(E"Mathematical Functions",E"Base",E"csch",E"csch(x)
1528
1653
 
1529
 
   Compute the hyperbolic cosecant of \"x\" specified in radians
 
1654
   Compute the hyperbolic cosecant of \"x\"
1530
1655
 
1531
1656
"),
1532
1657
 
1533
1658
(E"Mathematical Functions",E"Base",E"coth",E"coth(x)
1534
1659
 
1535
 
   Compute the hyperbolic cotangent of \"x\" specified in radians
 
1660
   Compute the hyperbolic cotangent of \"x\"
1536
1661
 
1537
1662
"),
1538
1663
 
1539
1664
(E"Mathematical Functions",E"Base",E"asinh",E"asinh(x)
1540
1665
 
1541
 
   Compute the inverse hyperbolic sine of \"x\" specified in radians
 
1666
   Compute the inverse hyperbolic sine of \"x\"
1542
1667
 
1543
1668
"),
1544
1669
 
1545
1670
(E"Mathematical Functions",E"Base",E"acosh",E"acosh(x)
1546
1671
 
1547
 
   Compute the inverse hyperbolic cosine of \"x\" specified in radians
 
1672
   Compute the inverse hyperbolic cosine of \"x\"
1548
1673
 
1549
1674
"),
1550
1675
 
1551
1676
(E"Mathematical Functions",E"Base",E"atanh",E"atanh(x)
1552
1677
 
1553
 
   Compute the inverse hyperbolic cotangent of \"x\" specified in
1554
 
   radians
 
1678
   Compute the inverse hyperbolic cotangent of \"x\"
1555
1679
 
1556
1680
"),
1557
1681
 
1558
1682
(E"Mathematical Functions",E"Base",E"asech",E"asech(x)
1559
1683
 
1560
 
   Compute the inverse hyperbolic secant of \"x\" specified in radians
 
1684
   Compute the inverse hyperbolic secant of \"x\"
1561
1685
 
1562
1686
"),
1563
1687
 
1564
1688
(E"Mathematical Functions",E"Base",E"acsch",E"acsch(x)
1565
1689
 
1566
 
   Compute the inverse hyperbolic cosecant of \"x\" specified in
1567
 
   radians
 
1690
   Compute the inverse hyperbolic cosecant of \"x\"
1568
1691
 
1569
1692
"),
1570
1693
 
1571
1694
(E"Mathematical Functions",E"Base",E"acoth",E"acoth(x)
1572
1695
 
1573
 
   Compute the inverse hyperbolic cotangent of \"x\" specified in
1574
 
   radians
 
1696
   Compute the inverse hyperbolic cotangent of \"x\"
1575
1697
 
1576
1698
"),
1577
1699
 
1587
1709
 
1588
1710
"),
1589
1711
 
 
1712
(E"Mathematical Functions",E"Base",E"degrees2radians",E"degrees2radians(x)
 
1713
 
 
1714
   Convert \"x\" from degrees to radians
 
1715
 
 
1716
"),
 
1717
 
1590
1718
(E"Mathematical Functions",E"Base",E"hypot",E"hypot(x, y)
1591
1719
 
1592
1720
   Compute the \\sqrt{(x^2+y^2)} without undue overflow or underflow
1874
2002
 
1875
2003
"),
1876
2004
 
 
2005
(E"Mathematical Functions",E"Base",E"factor",E"factor(n)
 
2006
 
 
2007
   Compute the prime factorization of an integer \"n\". Returns a
 
2008
   dictionary. The keys of the dictionary correspond to the factors,
 
2009
   and hence are of the same type as \"n\". The value associated with
 
2010
   each key indicates the number of times the factor appears in the
 
2011
   factorization.
 
2012
 
 
2013
   **Example**: 100=2*2*5*5; then, \"factor(100) -> [5=>2,2=>2]\"
 
2014
 
 
2015
"),
 
2016
 
1877
2017
(E"Mathematical Functions",E"Base",E"gcd",E"gcd(x, y)
1878
2018
 
1879
2019
   Greatest common divisor
1886
2026
 
1887
2027
"),
1888
2028
 
 
2029
(E"Mathematical Functions",E"Base",E"gcdx",E"gcdx(x, y)
 
2030
 
 
2031
   Greatest common divisor, also returning integer coefficients \"u\"
 
2032
   and \"v\" that solve \"ux+vy == gcd(x,y)\"
 
2033
 
 
2034
"),
 
2035
 
 
2036
(E"Mathematical Functions",E"Base",E"ispow2",E"ispow2(n)
 
2037
 
 
2038
   Test whether \"n\" is a power of two
 
2039
 
 
2040
"),
 
2041
 
1889
2042
(E"Mathematical Functions",E"Base",E"nextpow2",E"nextpow2(n)
1890
2043
 
1891
2044
   Next power of two not less than \"n\"
1892
2045
 
1893
2046
"),
1894
2047
 
 
2048
(E"Mathematical Functions",E"Base",E"prevpow2",E"prevpow2(n)
 
2049
 
 
2050
   Previous power of two not greater than \"n\"
 
2051
 
 
2052
"),
 
2053
 
1895
2054
(E"Mathematical Functions",E"Base",E"nextpow",E"nextpow(a, n)
1896
2055
 
1897
2056
   Next power of \"a\" not less than \"n\"
1918
2077
 
1919
2078
"),
1920
2079
 
 
2080
(E"Mathematical Functions",E"Base",E"invmod",E"invmod(x, m)
 
2081
 
 
2082
   Inverse of \"x\", modulo \"m\"
 
2083
 
 
2084
"),
 
2085
 
1921
2086
(E"Mathematical Functions",E"Base",E"powermod",E"powermod(x, p, m)
1922
2087
 
1923
2088
   Compute \"mod(x^p, m)\"
1926
2091
 
1927
2092
(E"Mathematical Functions",E"Base",E"gamma",E"gamma(x)
1928
2093
 
 
2094
   Compute the gamma function of \"x\"
 
2095
 
1929
2096
"),
1930
2097
 
1931
2098
(E"Mathematical Functions",E"Base",E"lgamma",E"lgamma(x)
1932
2099
 
 
2100
   Compute the logarithm of \"gamma(x)\"
 
2101
 
1933
2102
"),
1934
2103
 
1935
2104
(E"Mathematical Functions",E"Base",E"lfact",E"lfact(x)
1936
2105
 
 
2106
   Compute the logarithmic factorial of \"x\"
 
2107
 
 
2108
"),
 
2109
 
 
2110
(E"Mathematical Functions",E"Base",E"digamma",E"digamma(x)
 
2111
 
 
2112
   Compute the digamma function of \"x\" (the logarithmic derivative
 
2113
   of \"gamma(x)\")
 
2114
 
1937
2115
"),
1938
2116
 
1939
2117
(E"Mathematical Functions",E"Base",E"airyai",E"airy(x)
2099
2277
 
2100
2278
"),
2101
2279
 
 
2280
(E"Data Formats",E"Base",E"isbool",E"isbool(x)
 
2281
 
 
2282
   Test whether number or array is boolean
 
2283
 
 
2284
"),
 
2285
 
 
2286
(E"Data Formats",E"Base",E"int",E"int(x)
 
2287
 
 
2288
   Convert a number or array to the default integer type on your
 
2289
   platform. Alternatively, \"x\" can be a string, which is parsed as
 
2290
   an integer.
 
2291
 
 
2292
"),
 
2293
 
 
2294
(E"Data Formats",E"Base",E"integer",E"integer(x)
 
2295
 
 
2296
   Convert a number or array to integer type. If \"x\" is already of
 
2297
   integer type it is unchanged, otherwise it converts it to the
 
2298
   default integer type on your platform.
 
2299
 
 
2300
"),
 
2301
 
 
2302
(E"Data Formats",E"Base",E"isinteger",E"isinteger(x)
 
2303
 
 
2304
   Test whether a number or array is of integer type
 
2305
 
 
2306
"),
 
2307
 
2102
2308
(E"Data Formats",E"Base",E"int8",E"int8(x)
2103
2309
 
2104
2310
   Convert a number or array to \"Int8\" data type
2123
2329
 
2124
2330
"),
2125
2331
 
 
2332
(E"Data Formats",E"Base",E"int128",E"int128(x)
 
2333
 
 
2334
   Convert a number or array to \"Int128\" data type
 
2335
 
 
2336
"),
 
2337
 
2126
2338
(E"Data Formats",E"Base",E"uint8",E"uint8(x)
2127
2339
 
2128
2340
   Convert a number or array to \"Uint8\" data type
2147
2359
 
2148
2360
"),
2149
2361
 
 
2362
(E"Data Formats",E"Base",E"uint128",E"uint128(x)
 
2363
 
 
2364
   Convert a number or array to \"Uint128\" data type
 
2365
 
 
2366
"),
 
2367
 
2150
2368
(E"Data Formats",E"Base",E"float32",E"float32(x)
2151
2369
 
2152
2370
   Convert a number or array to \"Float32\" data type
2159
2377
 
2160
2378
"),
2161
2379
 
 
2380
(E"Data Formats",E"Base",E"float",E"float(x)
 
2381
 
 
2382
   Convert a number, array, or string to a \"FloatingPoint\" data
 
2383
   type. For numeric data, the smallest suitable \"FloatingPoint\"
 
2384
   type is used. For strings, it converts to \"Float64\".
 
2385
 
 
2386
"),
 
2387
 
 
2388
(E"Data Formats",E"Base",E"float64_valued",E"float64_valued(x::Rational)
 
2389
 
 
2390
   True if \"x\" can be losslessly represented as a \"Float64\" data
 
2391
   type
 
2392
 
 
2393
"),
 
2394
 
 
2395
(E"Data Formats",E"Base",E"complex64",E"complex64(r, i)
 
2396
 
 
2397
   Convert to \"r+i*im\" represented as a \"Complex64\" data type
 
2398
 
 
2399
"),
 
2400
 
 
2401
(E"Data Formats",E"Base",E"complex128",E"complex128(r, i)
 
2402
 
 
2403
   Convert to \"r+i*im\" represented as a \"Complex128\" data type
 
2404
 
 
2405
"),
 
2406
 
2162
2407
(E"Data Formats",E"Base",E"char",E"char(x)
2163
2408
 
2164
2409
   Convert a number or array to \"Char\" data type
2242
2487
 
2243
2488
"),
2244
2489
 
 
2490
(E"Numbers",E"Base",E"isinf",E"isinf(f)
 
2491
 
 
2492
   Test whether a number is infinite
 
2493
 
 
2494
"),
 
2495
 
2245
2496
(E"Numbers",E"Base",E"isnan",E"isnan(f)
2246
2497
 
2247
2498
   Test whether a floating point number is not a number (NaN)
2248
2499
 
2249
2500
"),
2250
2501
 
 
2502
(E"Numbers",E"Base",E"inf",E"inf(f)
 
2503
 
 
2504
   Returns infinity in the same floating point type as \"f\" (or \"f\"
 
2505
   can by the type itself)
 
2506
 
 
2507
"),
 
2508
 
 
2509
(E"Numbers",E"Base",E"nan",E"nan(f)
 
2510
 
 
2511
   Returns NaN in the same floating point type as \"f\" (or \"f\" can
 
2512
   by the type itself)
 
2513
 
 
2514
"),
 
2515
 
2251
2516
(E"Numbers",E"Base",E"nextfloat",E"nextfloat(f)
2252
2517
 
2253
2518
   Get the next floating point number in lexicographic order
2302
2567
 
2303
2568
"),
2304
2569
 
 
2570
(E"Numbers",E"Base",E"count_ones",E"count_ones(x::Integer) -> Integer
 
2571
 
 
2572
   Number of ones in the binary representation of \"x\".
 
2573
 
 
2574
   **Example**: \"count_ones(7) -> 3\"
 
2575
 
 
2576
"),
 
2577
 
 
2578
(E"Numbers",E"Base",E"count_zeros",E"count_zeros(x::Integer) -> Integer
 
2579
 
 
2580
   Number of zeros in the binary representation of \"x\".
 
2581
 
 
2582
   **Example**: \"count_zeros(int32(2 ^ 16 - 1)) -> 16\"
 
2583
 
 
2584
"),
 
2585
 
 
2586
(E"Numbers",E"Base",E"leading_zeros",E"leading_zeros(x::Integer) -> Integer
 
2587
 
 
2588
   Number of zeros leading the binary representation of \"x\".
 
2589
 
 
2590
   **Example**: \"leading_zeros(int32(1)) -> 31\"
 
2591
 
 
2592
"),
 
2593
 
 
2594
(E"Numbers",E"Base",E"leading_ones",E"leading_ones(x::Integer) -> Integer
 
2595
 
 
2596
   Number of ones leading the binary representation of \"x\".
 
2597
 
 
2598
   **Example**: \"leading_ones(int32(2 ^ 32 - 2)) -> 31\"
 
2599
 
 
2600
"),
 
2601
 
 
2602
(E"Numbers",E"Base",E"trailing_zeros",E"trailing_zeros(x::Integer) -> Integer
 
2603
 
 
2604
   Number of zeros trailing the binary representation of \"x\".
 
2605
 
 
2606
   **Example**: \"trailing_zeros(2) -> 1\"
 
2607
 
 
2608
"),
 
2609
 
 
2610
(E"Numbers",E"Base",E"trailing_ones",E"trailing_ones(x::Integer) -> Integer
 
2611
 
 
2612
   Number of ones trailing the binary representation of \"x\".
 
2613
 
 
2614
   **Example**: \"trailing_ones(3) -> 2\"
 
2615
 
 
2616
"),
 
2617
 
 
2618
(E"Numbers",E"Base",E"isprime",E"isprime(x::Integer) -> Bool
 
2619
 
 
2620
      Returns \"true\" if \"x\" is prime, and \"false\" otherwise.
 
2621
 
 
2622
   **Example**: \"isprime(3) -> true\"
 
2623
 
 
2624
"),
 
2625
 
2305
2626
(E"Random Numbers",E"Base",E"srand",E"srand([rng], seed)
2306
2627
 
2307
2628
   Seed the RNG with a \"seed\", which may be an unsigned integer or a
2401
2722
 
2402
2723
"),
2403
2724
 
2404
 
(E"Arrays",E"Base",E"numel",E"numel(A)
2405
 
 
2406
 
   Returns the number of elements in A
2407
 
 
2408
 
"),
2409
 
 
2410
2725
(E"Arrays",E"Base",E"length",E"length(A)
2411
2726
 
2412
2727
   Returns the number of elements in A (note that this differs from
2671
2986
 
2672
2987
"),
2673
2988
 
2674
 
(E"Arrays",E"Base",E"permute",E"permute(A, perm)
 
2989
(E"Arrays",E"Base",E"permutedims",E"permutedims(A, perm)
2675
2990
 
2676
2991
   Permute the dimensions of array \"A\". \"perm\" is a vector
2677
2992
   specifying a permutation of length \"ndims(A)\". This is a
2680
2995
 
2681
2996
"),
2682
2997
 
2683
 
(E"Arrays",E"Base",E"ipermute",E"ipermute(A, perm)
 
2998
(E"Arrays",E"Base",E"ipermutedims",E"ipermutedims(A, perm)
2684
2999
 
2685
 
   Like \"permute\", except the inverse of the given permutation is
2686
 
   applied.
 
3000
   Like \"permutedims\", except the inverse of the given permutation
 
3001
   is applied.
2687
3002
 
2688
3003
"),
2689
3004
 
2690
 
(E"Arrays",E"Base",E"squeeze",E"squeeze(A)
 
3005
(E"Arrays",E"Base",E"squeeze",E"squeeze(A, dims)
2691
3006
 
2692
 
   Remove singleton dimensions from the shape of array \"A\"
 
3007
   Remove the dimensions specified by \"dims\" from array \"A\"
2693
3008
 
2694
3009
"),
2695
3010
 
2696
3011
(E"Arrays",E"Base",E"vec",E"vec(A)
2697
3012
 
2698
 
   Make a vector out of an array with only one non-singleton
2699
 
   dimension.
 
3013
   Vectorize an array using column-major convention.
2700
3014
 
2701
3015
"),
2702
3016
 
2848
3162
 
2849
3163
"),
2850
3164
 
2851
 
(E"Linear Algebra",E"Base",E"lu",E"lu(A) -> LU
2852
 
 
2853
 
   Compute LU factorization. LU is an \"LU factorization\" type that
2854
 
   can be used as an ordinary matrix.
2855
 
 
2856
 
"),
2857
 
 
2858
 
(E"Linear Algebra",E"Base",E"chol",E"chol(A)
2859
 
 
2860
 
   Compute Cholesky factorization
2861
 
 
2862
 
"),
2863
 
 
2864
 
(E"Linear Algebra",E"Base",E"qr",E"qr(A)
2865
 
 
2866
 
   Compute QR factorization
2867
 
 
2868
 
"),
2869
 
 
2870
 
(E"Linear Algebra",E"Base",E"qrp",E"qrp(A)
2871
 
 
2872
 
   Compute QR factorization with pivoting
2873
 
 
2874
 
"),
2875
 
 
2876
 
(E"Linear Algebra",E"Base",E"factors",E"factors(D)
2877
 
 
2878
 
   Return the factors of a decomposition D. For an LU decomposition,
2879
 
   factors(LU) -> L, U, p
 
3165
(E"Linear Algebra",E"Base",E"factors",E"factors(F)
 
3166
 
 
3167
   Return the factors of a factorization \"F\". For example, in the
 
3168
   case of an LU decomposition, factors(LU) -> L, U, P
 
3169
 
 
3170
"),
 
3171
 
 
3172
(E"Linear Algebra",E"Base",E"lu",E"lu(A) -> L, U, P
 
3173
 
 
3174
   Compute the LU factorization of \"A\", such that \"A[P,:] = L*U\".
 
3175
 
 
3176
"),
 
3177
 
 
3178
(E"Linear Algebra",E"Base",E"lufact",E"lufact(A) -> LUDense
 
3179
 
 
3180
   Compute the LU factorization of \"A\" and return a \"LUDense\"
 
3181
   object. \"factors(lufact(A))\" returns the triangular matrices
 
3182
   containing the factorization. The following functions are available
 
3183
   for \"LUDense\" objects: \"size\", \"factors\", \"\\\", \"inv\",
 
3184
   \"det\".
 
3185
 
 
3186
"),
 
3187
 
 
3188
(E"Linear Algebra",E"Base",E"lufact!",E"lufact!(A) -> LUDense
 
3189
 
 
3190
   \"lufact!\" is the same as \"lufact\" but saves space by
 
3191
   overwriting the input A, instead of creating a copy.
 
3192
 
 
3193
"),
 
3194
 
 
3195
(E"Linear Algebra",E"Base",E"chol",E"chol(A[, LU]) -> F
 
3196
 
 
3197
   Compute Cholesky factorization of a symmetric positive-definite
 
3198
   matrix \"A\" and return the matrix \"F\". If \"LU\" is \"L\"
 
3199
   (Lower), \"A = L*L'\". If \"LU\" is \"U\" (Upper), \"A = R'*R\".
 
3200
 
 
3201
"),
 
3202
 
 
3203
(E"Linear Algebra",E"Base",E"cholfact",E"cholfact(A[, LU]) -> CholeskyDense
 
3204
 
 
3205
   Compute the Cholesky factorization of a symmetric positive-definite
 
3206
   matrix \"A\" and return a \"CholeskyDense\" object. \"LU\" may be
 
3207
   'L' for using the lower part or 'U' for the upper part. The default
 
3208
   is to use 'U'. \"factors(cholfact(A))\" returns the triangular
 
3209
   matrix containing the factorization. The following functions are
 
3210
   available for \"CholeskyDense\" objects: \"size\", \"factors\",
 
3211
   \"\\\", \"inv\", \"det\". A \"LAPACK.PosDefException\" error is
 
3212
   thrown in case the matrix is not positive definite.
 
3213
 
 
3214
"),
 
3215
 
 
3216
(E"Linear Algebra",E"Base",E"cholpfact",E"cholpfact(A[, LU]) -> CholeskyPivotedDense
 
3217
 
 
3218
   Compute the pivoted Cholesky factorization of a symmetric positive
 
3219
   semi-definite matrix \"A\" and return a \"CholeskyDensePivoted\"
 
3220
   object. \"LU\" may be 'L' for using the lower part or 'U' for the
 
3221
   upper part. The default is to use 'U'. \"factors(cholpfact(A))\"
 
3222
   returns the triangular matrix containing the factorization. The
 
3223
   following functions are available for \"CholeskyDensePivoted\"
 
3224
   objects: \"size\", \"factors\", \"\\\", \"inv\", \"det\". A
 
3225
   \"LAPACK.RankDeficientException\" error is thrown in case the
 
3226
   matrix is rank deficient.
 
3227
 
 
3228
"),
 
3229
 
 
3230
(E"Linear Algebra",E"Base",E"cholpfact!",E"cholpfact!(A[, LU]) -> CholeskyPivotedDense
 
3231
 
 
3232
   \"cholpfact!\" is the same as \"cholpfact\" but saves space by
 
3233
   overwriting the input A, instead of creating a copy.
 
3234
 
 
3235
"),
 
3236
 
 
3237
(E"Linear Algebra",E"Base",E"qr",E"qr(A) -> Q, R
 
3238
 
 
3239
   Compute the QR factorization of \"A\" such that \"A = Q*R\". Also
 
3240
   see \"qrd\".
 
3241
 
 
3242
"),
 
3243
 
 
3244
(E"Linear Algebra",E"Base",E"qrfact",E"qrfact(A)
 
3245
 
 
3246
   Compute the QR factorization of \"A\" and return a \"QRDense\"
 
3247
   object. \"factors(qrfact(A))\" returns \"Q\" and \"R\". The
 
3248
   following functions are available for \"QRDense\" objects:
 
3249
   \"size\", \"factors\", \"qmulQR\", \"qTmulQR\", \"\\\".
 
3250
 
 
3251
"),
 
3252
 
 
3253
(E"Linear Algebra",E"Base",E"qrfact!",E"qrfact!(A)
 
3254
 
 
3255
   \"qrfact!\" is the same as \"qrfact\" but saves space by
 
3256
   overwriting the input A, instead of creating a copy.
 
3257
 
 
3258
"),
 
3259
 
 
3260
(E"Linear Algebra",E"Base",E"qrp",E"qrp(A) -> Q, R, P
 
3261
 
 
3262
   Compute the QR factorization of \"A\" with pivoting, such that
 
3263
   \"A*I[:,P] = Q*R\", where \"I\" is the identity matrix. Also see
 
3264
   \"qrpfact\".
 
3265
 
 
3266
"),
 
3267
 
 
3268
(E"Linear Algebra",E"Base",E"qrpfact",E"qrpfact(A) -> QRPivotedDense
 
3269
 
 
3270
   Compute the QR factorization of \"A\" with pivoting and return a
 
3271
   \"QRDensePivoted\" object. \"factors(qrpfact(A))\" returns \"Q\"
 
3272
   and \"R\". The following functions are available for
 
3273
   \"QRDensePivoted\" objects: \"size\", \"factors\", \"qmulQR\",
 
3274
   \"qTmulQR\", \"\\\".
 
3275
 
 
3276
"),
 
3277
 
 
3278
(E"Linear Algebra",E"Base",E"qrpfact!",E"qrpfact!(A) -> QRPivotedDense
 
3279
 
 
3280
   \"qrpfact!\" is the same as \"qrpfact\" but saves space by
 
3281
   overwriting the input A, instead of creating a copy.
 
3282
 
 
3283
"),
 
3284
 
 
3285
(E"Linear Algebra",E"Base",E"qmulQR",E"qmulQR(QR, A)
 
3286
 
 
3287
   Perform Q*A efficiently, where Q is a an orthogonal matrix defined
 
3288
   as the product of k elementary reflectors from the QR
 
3289
   decomposition.
 
3290
 
 
3291
"),
 
3292
 
 
3293
(E"Linear Algebra",E"Base",E"qTmulQR",E"qTmulQR(QR, A)
 
3294
 
 
3295
   Perform Q'>>*<<A efficiently, where Q is a an orthogonal matrix
 
3296
   defined as the product of k elementary reflectors from the QR
 
3297
   decomposition.
2880
3298
 
2881
3299
"),
2882
3300
 
2892
3310
 
2893
3311
"),
2894
3312
 
2895
 
(E"Linear Algebra",E"Base",E"svd",E"svd(A) -> U, S, V
 
3313
(E"Linear Algebra",E"Base",E"svdfact",E"svdfact(A[, thin]) -> SVDDense
 
3314
 
 
3315
   Compute the Singular Value Decomposition (SVD) of \"A\" and return
 
3316
   an \"SVDDense\" object. \"factors(svdfact(A))\" returns \"U\",
 
3317
   \"S\", and \"Vt\", such that \"A = U*diagm(S)*Vt\". If \"thin\" is
 
3318
   \"true\", an economy mode decomposition is returned.
 
3319
 
 
3320
"),
 
3321
 
 
3322
(E"Linear Algebra",E"Base",E"svdfact!",E"svdfact!(A[, thin]) -> SVDDense
 
3323
 
 
3324
   \"svdfact!\" is the same as \"svdfact\" but saves space by
 
3325
   overwriting the input A, instead of creating a copy. If \"thin\" is
 
3326
   \"true\", an economy mode decomposition is returned.
 
3327
 
 
3328
"),
 
3329
 
 
3330
(E"Linear Algebra",E"Base",E"svd",E"svd(A[, thin]) -> U, S, V
2896
3331
 
2897
3332
   Compute the SVD of A, returning \"U\", \"S\", and \"V\" such that
2898
 
   \"A = U*S*V'\".
 
3333
   \"A = U*S*V'\". If \"thin\" is \"true\", an economy mode
 
3334
   decomposition is returned.
2899
3335
 
2900
3336
"),
2901
3337
 
2902
 
(E"Linear Algebra",E"Base",E"svdt",E"svdt(A) -> U, S, Vt
 
3338
(E"Linear Algebra",E"Base",E"svdt",E"svdt(A[, thin]) -> U, S, Vt
2903
3339
 
2904
3340
   Compute the SVD of A, returning \"U\", \"S\", and \"Vt\" such that
2905
 
   \"A = U*S*Vt\".
 
3341
   \"A = U*S*Vt\". If \"thin\" is \"true\", an economy mode
 
3342
   decomposition is returned.
2906
3343
 
2907
3344
"),
2908
3345
 
2912
3349
 
2913
3350
"),
2914
3351
 
 
3352
(E"Linear Algebra",E"Base",E"svdvals!",E"svdvals!(A)
 
3353
 
 
3354
   Returns the singular values of \"A\", while saving space by
 
3355
   overwriting the input.
 
3356
 
 
3357
"),
 
3358
 
 
3359
(E"Linear Algebra",E"Base",E"svdfact",E"svdfact(A, B) -> GSVDDense
 
3360
 
 
3361
   Compute the generalized SVD of \"A\" and \"B\", returning a
 
3362
   \"GSVDDense\" Factorization object.
 
3363
 
 
3364
"),
 
3365
 
 
3366
(E"Linear Algebra",E"Base",E"svd",E"svd(A, B) -> U, V, X, C, S
 
3367
 
 
3368
   Compute the generalized SVD of \"A\" and \"B\".
 
3369
 
 
3370
"),
 
3371
 
 
3372
(E"Linear Algebra",E"Base",E"svdvals",E"svdvals(A, B)
 
3373
 
 
3374
   Return only the singular values from the generalized singular value
 
3375
   decomposition of \"A\" and \"B\".
 
3376
 
 
3377
"),
 
3378
 
2915
3379
(E"Linear Algebra",E"Base",E"triu",E"triu(M)
2916
3380
 
2917
3381
   Upper triangle of a matrix
3068
3532
 
3069
3533
"),
3070
3534
 
 
3535
(E"Combinatorics",E"Base",E"permute!",E"permute!(v, p)
 
3536
 
 
3537
   Permute vector \"v\" in-place, according to permutation \"p\".  No
 
3538
   checking is done to verify that \"p\" is a permutation.
 
3539
 
 
3540
   To return a new permutation, use \"v[p]\".  Note that this is
 
3541
   generally faster than \"permute!(v,p)\" for large vectors.
 
3542
 
 
3543
"),
 
3544
 
 
3545
(E"Combinatorics",E"Base",E"ipermute!",E"ipermute!(v, p)
 
3546
 
 
3547
   Like permute!, but the inverse of the given permutation is applied.
 
3548
 
 
3549
"),
 
3550
 
3071
3551
(E"Combinatorics",E"Base",E"randcycle",E"randcycle(n)
3072
3552
 
3073
3553
   Construct a random cyclic permutation of the given length
3188
3668
 
3189
3669
"),
3190
3670
 
3191
 
(E"Statistics",E"Base",E"histc",E"histc(v, e)
 
3671
(E"Statistics",E"Base",E"hist",E"hist(v, e)
3192
3672
 
3193
3673
   Compute the histogram of \"v\" using a vector \"e\" as the edges
3194
3674
   for the bins
3786
4266
 
3787
4267
"),
3788
4268
 
3789
 
(E"Distributed Arrays",E"Base",E"darray",E"darray(init, type, dims[, distdim, procs, dist])
3790
 
 
3791
 
   Construct a distributed array. \"init\" is a function of three
3792
 
   arguments that will run on each processor, and should return an
3793
 
   \"Array\" holding the local data for the current processor. Its
3794
 
   arguments are \"(T,d,da)\" where \"T\" is the element type, \"d\"
3795
 
   is the dimensions of the needed local piece, and \"da\" is the new
3796
 
   \"DArray\" being constructed (though, of course, it is not fully
3797
 
   initialized). \"type\" is the element type. \"dims\" is the
3798
 
   dimensions of the entire \"DArray\". \"distdim\" is the dimension
3799
 
   to distribute in. \"procs\" is a vector of processor ids to use.
3800
 
   \"dist\" is a vector giving the first index of each contiguous
3801
 
   distributed piece, such that the nth piece consists of indexes
3802
 
   \"dist[n]\" through \"dist[n+1]-1\". If you have a vector \"v\" of
3803
 
   the sizes of the pieces, \"dist\" can be computed as
3804
 
   \"cumsum([1,v])\". Fortunately, all arguments after \"dims\" are
3805
 
   optional.
3806
 
 
3807
 
"),
3808
 
 
3809
 
(E"Distributed Arrays",E"Base",E"darray",E"darray(f, A)
3810
 
 
3811
 
   Transform \"DArray\" \"A\" to another of the same type and
3812
 
   distribution by applying function \"f\" to each block of \"A\".
3813
 
 
3814
 
"),
3815
 
 
3816
 
(E"Distributed Arrays",E"Base",E"dzeros",E"dzeros([type], dims, ...)
 
4269
(E"Distributed Arrays",E"Base",E"DArray",E"DArray(init, dims[, procs, dist])
 
4270
 
 
4271
   Construct a distributed array. \"init\" is a function accepting a
 
4272
   tuple of index ranges. This function should return a chunk of the
 
4273
   distributed array for the specified indexes. \"dims\" is the
 
4274
   overall size of the distributed array. \"procs\" optionally
 
4275
   specifies a vector of processor IDs to use. \"dist\" is an integer
 
4276
   vector specifying how many chunks the distributed array should be
 
4277
   divided into in each dimension.
 
4278
 
 
4279
"),
 
4280
 
 
4281
(E"Distributed Arrays",E"Base",E"dzeros",E"dzeros(dims, ...)
3817
4282
 
3818
4283
   Construct a distributed array of zeros. Trailing arguments are the
3819
4284
   same as those accepted by \"darray\".
3820
4285
 
3821
4286
"),
3822
4287
 
3823
 
(E"Distributed Arrays",E"Base",E"dones",E"dones([type], dims, ...)
 
4288
(E"Distributed Arrays",E"Base",E"dones",E"dones(dims, ...)
3824
4289
 
3825
4290
   Construct a distributed array of ones. Trailing arguments are the
3826
4291
   same as those accepted by \"darray\".
3848
4313
 
3849
4314
"),
3850
4315
 
3851
 
(E"Distributed Arrays",E"Base",E"dcell",E"dcell(dims, ...)
3852
 
 
3853
 
   Construct a distributed cell array. Trailing arguments are the same
3854
 
   as those accepted by \"darray\".
3855
 
 
3856
 
"),
3857
 
 
3858
 
(E"Distributed Arrays",E"Base",E"distribute",E"distribute(a[, distdim])
 
4316
(E"Distributed Arrays",E"Base",E"distribute",E"distribute(a)
3859
4317
 
3860
4318
   Convert a local array to distributed
3861
4319
 
3867
4325
 
3868
4326
"),
3869
4327
 
3870
 
(E"Distributed Arrays",E"Base",E"changedist",E"changedist(d, distdim)
3871
 
 
3872
 
   Change the distributed dimension of a \"DArray\"
3873
 
 
3874
 
"),
3875
 
 
3876
4328
(E"Distributed Arrays",E"Base",E"myindexes",E"myindexes(d)
3877
4329
 
3878
4330
   A tuple describing the indexes owned by the local processor
3879
4331
 
3880
4332
"),
3881
4333
 
3882
 
(E"Distributed Arrays",E"Base",E"owner",E"owner(d, i)
3883
 
 
3884
 
   Get the id of the processor holding index \"i\" in the distributed
3885
 
   dimension
3886
 
 
3887
 
"),
3888
 
 
3889
4334
(E"Distributed Arrays",E"Base",E"procs",E"procs(d)
3890
4335
 
3891
4336
   Get the vector of processors storing pieces of \"d\"
3892
4337
 
3893
4338
"),
3894
4339
 
3895
 
(E"Distributed Arrays",E"Base",E"distdim",E"distdim(d)
3896
 
 
3897
 
   Get the distributed dimension of \"d\"
3898
 
 
3899
 
"),
3900
 
 
3901
 
(E"System",E"Base",E"system",E"system(\"command\")
3902
 
 
3903
 
   Run a shell command.
 
4340
(E"System",E"Base",E"run",E"run(command)
 
4341
 
 
4342
   Run a command object, constructed with backticks. Throws an error
 
4343
   if anything goes wrong, including the process exiting with a non-
 
4344
   zero status.
 
4345
 
 
4346
"),
 
4347
 
 
4348
(E"System",E"Base",E"success",E"success(command)
 
4349
 
 
4350
   Run a command object, constructed with backticks, and tell whether
 
4351
   it was successful (exited with a code of 0).
 
4352
 
 
4353
"),
 
4354
 
 
4355
(E"System",E"Base",E"readsfrom",E"readsfrom(command)
 
4356
 
 
4357
   Starts running a command asynchronously, and returns a tuple
 
4358
   (stream,process). The first value is a stream reading from the
 
4359
   process' standard output.
 
4360
 
 
4361
"),
 
4362
 
 
4363
(E"System",E"Base",E"writesto",E"writesto(command)
 
4364
 
 
4365
   Starts running a command asynchronously, and returns a tuple
 
4366
   (stream,process). The first value is a stream writing to the
 
4367
   process' standard input.
3904
4368
 
3905
4369
"),
3906
4370
 
5895
6359
 
5896
6360
"),
5897
6361
 
5898
 
(E"Base.Sort",E"Base.Sort",E"sortr",E"sortr(v[, dim])
5899
 
 
5900
 
   Sort a vector in descending order. If \"dim\" is provided, sort
5901
 
   along the given dimension.
5902
 
 
5903
 
"),
5904
 
 
5905
 
(E"Base.Sort",E"Base.Sort",E"sortr",E"sortr(alg, ...)
5906
 
 
5907
 
   Sort in descending order with a specific sorting algorithm
5908
 
   (InsertionSort, QuickSort, MergeSort, or TimSort).
5909
 
 
5910
 
"),
5911
 
 
5912
 
(E"Base.Sort",E"Base.Sort",E"sortr!",E"sortr!(...)
5913
 
 
5914
 
   In-place \"sortr\".
5915
 
 
5916
 
"),
5917
 
 
5918
6362
(E"Base.Sort",E"Base.Sort",E"sortby",E"sortby(by, v[, dim])
5919
6363
 
5920
6364
   Sort a vector according to \"by(v)\".   If \"dim\" is provided,
5935
6379
 
5936
6380
"),
5937
6381
 
5938
 
(E"Base.Sort",E"Base.Sort",E"sortperm",E"sortperm(v) -> s,p
5939
 
 
5940
 
   Sort a vector in ascending order, also constructing the permutation
5941
 
   that sorts the vector.
5942
 
 
5943
 
"),
5944
 
 
5945
 
(E"Base.Sort",E"Base.Sort",E"sortperm",E"sortperm(lessthan, v) -> s,p
5946
 
 
5947
 
   Sort a vector with a custom comparison function, also constructing
5948
 
   the permutation that sorts the vector.
5949
 
 
5950
 
"),
5951
 
 
5952
 
(E"Base.Sort",E"Base.Sort",E"sortperm",E"sortperm(alg, ...) -> s,p
 
6382
(E"Base.Sort",E"Base.Sort",E"sortperm",E"sortperm(v)
 
6383
 
 
6384
   Return a permutation vector, which when applied to the input vector
 
6385
   \"v\" will sort it.
 
6386
 
 
6387
"),
 
6388
 
 
6389
(E"Base.Sort",E"Base.Sort",E"sortperm",E"sortperm(lessthan, v)
 
6390
 
 
6391
   Return a permutation vector, which when applied to the input vector
 
6392
   \"v\" will sort it, using the specified \"lessthan\" comparison
 
6393
   function.
 
6394
 
 
6395
"),
 
6396
 
 
6397
(E"Base.Sort",E"Base.Sort",E"sortperm",E"sortperm(alg, ...)
5953
6398
 
5954
6399
   \"sortperm\" using a specific sorting algorithm (\"InsertionSort\",
5955
6400
   \"QuickSort\", \"MergeSort\", or \"TimSort\").
5956
6401
 
5957
6402
"),
5958
6403
 
5959
 
(E"Base.Sort",E"Base.Sort",E"sortperm!",E"sortperm!(...) -> s,p
 
6404
(E"Base.Sort",E"Base.Sort",E"sortperm!",E"sortperm!(...)
5960
6405
 
5961
6406
   In-place \"sortperm\".
5962
6407
 
5963
6408
"),
5964
6409
 
5965
 
(E"Base.Sort",E"Base.Sort",E"sortpermr",E"sortpermr(v) -> s,p
5966
 
 
5967
 
   Sort a vector in descending order, also constructing the
5968
 
   permutation that sorts the vector!
5969
 
 
5970
 
"),
5971
 
 
5972
 
(E"Base.Sort",E"Base.Sort",E"sortpermr",E"sortpermr(alg, ...) -> s,p
5973
 
 
5974
 
   \"sortpermr\" using a specific sorting algorithm
5975
 
   (\"InsertionSort\", \"QuickSort\", \"MergeSort\", or \"TimSort\").
5976
 
 
5977
 
"),
5978
 
 
5979
 
(E"Base.Sort",E"Base.Sort",E"sortpermr!",E"sortpermr!(v) -> s,p
5980
 
 
5981
 
   In-place \"sortpermr\".
5982
 
 
5983
 
"),
5984
 
 
5985
 
(E"Base.Sort",E"Base.Sort",E"sortpermby",E"sortpermby(by, v) -> s,p
5986
 
 
5987
 
   Sort a vector according to the result of function \"by\" applied to
5988
 
   all values, also constructing the permutation that sorts the
5989
 
   vector.
5990
 
 
5991
 
"),
5992
 
 
5993
 
(E"Base.Sort",E"Base.Sort",E"sortpermby",E"sortpermby(alg, ...) -> s,p
5994
 
 
5995
 
   \"sortpermby\" using a specific sorting algorithm
5996
 
   (\"InsertionSort\", \"QuickSort\", \"MergeSort\", or \"TimSort\").
5997
 
 
5998
 
"),
5999
 
 
6000
 
(E"Base.Sort",E"Base.Sort",E"sortpermby!",E"sortpermby!(...) -> s,p
6001
 
 
6002
 
   In-place \"sortpermby\".
6003
 
 
6004
 
"),
6005
 
 
6006
6410
(E"Base.Sort",E"Base.Sort",E"issorted",E"issorted(v)
6007
6411
 
6008
6412
   Test whether a vector is in ascending sorted order