Spaces:
Sleeping
Sleeping
File size: 57,024 Bytes
66c9c8a | 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 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 | ..
Autogenerated File - Do not edit. Run build_docs.py to generate.
.. functions:
.. currentmodule:: warp
Kernel Reference
================
Scalar Types
------------
.. class:: int8
.. class:: uint8
.. class:: int16
.. class:: uint16
.. class:: int32
.. class:: uint32
.. class:: int64
.. class:: uint64
.. class:: float16
.. class:: float32
.. class:: float64
.. class:: bool
Vector Types
------------
.. class:: vec2b
.. class:: vec2ub
.. class:: vec2s
.. class:: vec2us
.. class:: vec2i
.. class:: vec2ui
.. class:: vec2l
.. class:: vec2ul
.. class:: vec2h
.. class:: vec2f
.. class:: vec2d
.. class:: vec3b
.. class:: vec3ub
.. class:: vec3s
.. class:: vec3us
.. class:: vec3i
.. class:: vec3ui
.. class:: vec3l
.. class:: vec3ul
.. class:: vec3h
.. class:: vec3f
.. class:: vec3d
.. class:: vec4b
.. class:: vec4ub
.. class:: vec4s
.. class:: vec4us
.. class:: vec4i
.. class:: vec4ui
.. class:: vec4l
.. class:: vec4ul
.. class:: vec4h
.. class:: vec4f
.. class:: vec4d
.. class:: mat22h
.. class:: mat22f
.. class:: mat22d
.. class:: mat33h
.. class:: mat33f
.. class:: mat33d
.. class:: mat44h
.. class:: mat44f
.. class:: mat44d
.. class:: quath
.. class:: quatf
.. class:: quatd
.. class:: transformh
.. class:: transformf
.. class:: transformd
.. class:: spatial_vectorh
.. class:: spatial_vectorf
.. class:: spatial_vectord
.. class:: spatial_matrixh
.. class:: spatial_matrixf
.. class:: spatial_matrixd
Generic Types
-------------
.. class:: Int
.. class:: Float
.. class:: Scalar
.. class:: Vector
.. class:: Matrix
.. class:: Quaternion
.. class:: Transformation
.. class:: Array
Query Types
-------------
.. autoclass:: bvh_query_t
.. autoclass:: hash_grid_query_t
.. autoclass:: mesh_query_aabb_t
.. autoclass:: mesh_query_point_t
.. autoclass:: mesh_query_ray_t
Scalar Math
---------------
.. function:: min(x: Scalar, y: Scalar) -> Scalar
Return the minimum of two scalars.
.. function:: min(x: Vector[Any,Scalar], y: Vector[Any,Scalar]) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
Return the element-wise minimum of two vectors.
.. function:: min(v: Vector[Any,Scalar]) -> Scalar
:noindex:
:nocontentsentry:
Return the minimum element of a vector ``v``.
.. function:: max(x: Scalar, y: Scalar) -> Scalar
Return the maximum of two scalars.
.. function:: max(x: Vector[Any,Scalar], y: Vector[Any,Scalar]) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
Return the element-wise maximum of two vectors.
.. function:: max(v: Vector[Any,Scalar]) -> Scalar
:noindex:
:nocontentsentry:
Return the maximum element of a vector ``v``.
.. function:: clamp(x: Scalar, a: Scalar, b: Scalar) -> Scalar
Clamp the value of ``x`` to the range [a, b].
.. function:: abs(x: Scalar) -> Scalar
Return the absolute value of ``x``.
.. function:: sign(x: Scalar) -> Scalar
Return -1 if ``x`` < 0, return 1 otherwise.
.. function:: step(x: Scalar) -> Scalar
Return 1.0 if ``x`` < 0.0, return 0.0 otherwise.
.. function:: nonzero(x: Scalar) -> Scalar
Return 1.0 if ``x`` is not equal to zero, return 0.0 otherwise.
.. function:: sin(x: Float) -> Float
Return the sine of ``x`` in radians.
.. function:: cos(x: Float) -> Float
Return the cosine of ``x`` in radians.
.. function:: acos(x: Float) -> Float
Return arccos of ``x`` in radians. Inputs are automatically clamped to [-1.0, 1.0].
.. function:: asin(x: Float) -> Float
Return arcsin of ``x`` in radians. Inputs are automatically clamped to [-1.0, 1.0].
.. function:: sqrt(x: Float) -> Float
Return the square root of ``x``, where ``x`` is positive.
.. function:: cbrt(x: Float) -> Float
Return the cube root of ``x``.
.. function:: tan(x: Float) -> Float
Return the tangent of ``x`` in radians.
.. function:: atan(x: Float) -> Float
Return the arctangent of ``x`` in radians.
.. function:: atan2(y: Float, x: Float) -> Float
Return the 2-argument arctangent, atan2, of the point ``(x, y)`` in radians.
.. function:: sinh(x: Float) -> Float
Return the sinh of ``x``.
.. function:: cosh(x: Float) -> Float
Return the cosh of ``x``.
.. function:: tanh(x: Float) -> Float
Return the tanh of ``x``.
.. function:: degrees(x: Float) -> Float
Convert ``x`` from radians into degrees.
.. function:: radians(x: Float) -> Float
Convert ``x`` from degrees into radians.
.. function:: log(x: Float) -> Float
Return the natural logarithm (base-e) of ``x``, where ``x`` is positive.
.. function:: log2(x: Float) -> Float
Return the binary logarithm (base-2) of ``x``, where ``x`` is positive.
.. function:: log10(x: Float) -> Float
Return the common logarithm (base-10) of ``x``, where ``x`` is positive.
.. function:: exp(x: Float) -> Float
Return the value of the exponential function :math:`e^x`.
.. function:: pow(x: Float, y: Float) -> Float
Return the result of ``x`` raised to power of ``y``.
.. function:: round(x: Float) -> Float
Return the nearest integer value to ``x``, rounding halfway cases away from zero.
This is the most intuitive form of rounding in the colloquial sense, but can be slower than other options like :func:`warp.rint()`.
Differs from :func:`numpy.round()`, which behaves the same way as :func:`numpy.rint()`.
.. function:: rint(x: Float) -> Float
Return the nearest integer value to ``x``, rounding halfway cases to nearest even integer.
It is generally faster than :func:`warp.round()`. Equivalent to :func:`numpy.rint()`.
.. function:: trunc(x: Float) -> Float
Return the nearest integer that is closer to zero than ``x``.
In other words, it discards the fractional part of ``x``.
It is similar to casting ``float(int(x))``, but preserves the negative sign when x is in the range [-0.0, -1.0).
Equivalent to :func:`numpy.trunc()` and :func:`numpy.fix()`.
.. function:: floor(x: Float) -> Float
Return the largest integer that is less than or equal to ``x``.
.. function:: ceil(x: Float) -> Float
Return the smallest integer that is greater than or equal to ``x``.
.. function:: frac(x: Float) -> Float
Retrieve the fractional part of x.
In other words, it discards the integer part of x and is equivalent to ``x - trunc(x)``.
Vector Math
---------------
.. function:: dot(x: Vector[Any,Scalar], y: Vector[Any,Scalar]) -> Scalar
Compute the dot product between two vectors.
.. function:: dot(x: Quaternion[Float], y: Quaternion[Float]) -> Scalar
:noindex:
:nocontentsentry:
Compute the dot product between two quaternions.
.. function:: ddot(x: Matrix[Any,Any,Scalar], y: Matrix[Any,Any,Scalar]) -> Scalar
Compute the double dot product between two matrices.
.. function:: argmin(v: Vector[Any,Scalar]) -> uint32
Return the index of the minimum element of a vector ``v``. [1]_
.. function:: argmax(v: Vector[Any,Scalar]) -> uint32
Return the index of the maximum element of a vector ``v``. [1]_
.. function:: outer(x: Vector[Any,Scalar], y: Vector[Any,Scalar]) -> Matrix[Any,Any,Scalar]
Compute the outer product ``x*y^T`` for two vectors.
.. function:: cross(x: Vector[3,Scalar], y: Vector[3,Scalar]) -> Vector[3,Scalar]
Compute the cross product of two 3D vectors.
.. function:: skew(x: Vector[3,Scalar])
Compute the skew-symmetric 3x3 matrix for a 3D vector ``x``.
.. function:: length(x: Vector[Any,Float]) -> Scalar
Compute the length of a vector ``x``.
.. function:: length(x: Quaternion[Float]) -> Scalar
:noindex:
:nocontentsentry:
Compute the length of a quaternion ``x``.
.. function:: length_sq(x: Vector[Any,Scalar]) -> Scalar
Compute the squared length of a 2D vector ``x``.
.. function:: length_sq(x: Quaternion[Scalar]) -> Scalar
:noindex:
:nocontentsentry:
Compute the squared length of a quaternion ``x``.
.. function:: normalize(x: Vector[Any,Float]) -> Vector[Any,Scalar]
Compute the normalized value of ``x``. If ``length(x)`` is 0 then the zero vector is returned.
.. function:: normalize(x: Quaternion[Float]) -> Quaternion[Scalar]
:noindex:
:nocontentsentry:
Compute the normalized value of ``x``. If ``length(x)`` is 0, then the zero quaternion is returned.
.. function:: transpose(m: Matrix[Any,Any,Scalar])
Return the transpose of the matrix ``m``.
.. function:: inverse(m: Matrix[2,2,Float]) -> Matrix[Any,Any,Float]
Return the inverse of a 2x2 matrix ``m``.
.. function:: inverse(m: Matrix[3,3,Float]) -> Matrix[Any,Any,Float]
:noindex:
:nocontentsentry:
Return the inverse of a 3x3 matrix ``m``.
.. function:: inverse(m: Matrix[4,4,Float]) -> Matrix[Any,Any,Float]
:noindex:
:nocontentsentry:
Return the inverse of a 4x4 matrix ``m``.
.. function:: determinant(m: Matrix[2,2,Float]) -> Scalar
Return the determinant of a 2x2 matrix ``m``.
.. function:: determinant(m: Matrix[3,3,Float]) -> Scalar
:noindex:
:nocontentsentry:
Return the determinant of a 3x3 matrix ``m``.
.. function:: determinant(m: Matrix[4,4,Float]) -> Scalar
:noindex:
:nocontentsentry:
Return the determinant of a 4x4 matrix ``m``.
.. function:: trace(m: Matrix[Any,Any,Scalar]) -> Scalar
Return the trace of the matrix ``m``.
.. function:: diag(d: Vector[Any,Scalar]) -> Matrix[Any,Any,Scalar]
Returns a matrix with the components of the vector ``d`` on the diagonal.
.. function:: get_diag(m: Matrix[Any,Any,Scalar]) -> Vector[Any,Scalar]
Returns a vector containing the diagonal elements of the square matrix ``m``.
.. function:: cw_mul(x: Vector[Any,Scalar], y: Vector[Any,Scalar]) -> Vector[Any,Scalar]
Component-wise multiplication of two 2D vectors.
.. function:: cw_mul(x: Matrix[Any,Any,Scalar], y: Matrix[Any,Any,Scalar]) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
Component-wise multiplication of two 2D vectors.
.. function:: cw_div(x: Vector[Any,Scalar], y: Vector[Any,Scalar]) -> Vector[Any,Scalar]
Component-wise division of two 2D vectors.
.. function:: cw_div(x: Matrix[Any,Any,Scalar], y: Matrix[Any,Any,Scalar]) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
Component-wise division of two 2D vectors.
.. function:: vector(w: Vector[3,Float], v: Vector[3,Float])
Construct a 6D screw vector from two 3D vectors.
.. function:: vector(*arg_types: Scalar, length: int32, dtype: Scalar) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
Construct a vector of with given length and dtype.
.. function:: matrix(pos: Vector[3,Float], rot: Quaternion[Float], scale: Vector[3,Float]) -> Matrix[Any,Any,Float]
Construct a 4x4 transformation matrix that applies the transformations as
Translation(pos)*Rotation(rot)*Scale(scale) when applied to column vectors, i.e.: y = (TRS)*x
.. function:: matrix(*arg_types: Scalar, shape: Tuple[int, int], dtype: Scalar) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
Construct a matrix. If the positional ``arg_types`` are not given, then matrix will be zero-initialized.
.. function:: identity(n: int32, dtype: Scalar) -> Matrix[Any,Any,Scalar]
Create an identity matrix with shape=(n,n) with the type given by ``dtype``.
.. function:: svd3(A: Matrix[3,3,Float], U: Matrix[3,3,Float], sigma: Vector[3,Float], V: Matrix[3,3,Scalar]) -> None
Compute the SVD of a 3x3 matrix ``A``. The singular values are returned in ``sigma``,
while the left and right basis vectors are returned in ``U`` and ``V``.
.. function:: qr3(A: Matrix[3,3,Float], Q: Matrix[3,3,Float], R: Matrix[3,3,Float]) -> None
Compute the QR decomposition of a 3x3 matrix ``A``. The orthogonal matrix is returned in ``Q``,
while the upper triangular matrix is returned in ``R``.
.. function:: eig3(A: Matrix[3,3,Float], Q: Matrix[3,3,Float], d: Vector[3,Float]) -> None
Compute the eigendecomposition of a 3x3 matrix ``A``. The eigenvectors are returned as the columns of ``Q``,
while the corresponding eigenvalues are returned in ``d``.
Other
---------------
.. function:: lower_bound(arr: Array[Scalar], value: Scalar) -> int
Search a sorted array ``arr`` for the closest element greater than or equal to ``value``.
.. function:: lower_bound(arr: Array[Scalar], arr_begin: int32, arr_end: int32, value: Scalar) -> int
:noindex:
:nocontentsentry:
Search a sorted array ``arr`` in the range [arr_begin, arr_end) for the closest element greater than or equal to ``value``.
Quaternion Math
---------------
.. function:: quaternion() -> Quaternion[Float]
Construct a zero-initialized quaternion. Quaternions are laid out as
[ix, iy, iz, r], where ix, iy, iz are the imaginary part, and r the real part.
.. function:: quaternion(x: Float, y: Float, z: Float, w: Float) -> Quaternion[Float]
:noindex:
:nocontentsentry:
Create a quaternion using the supplied components (type inferred from component type).
.. function:: quaternion(i: Vector[3,Float], r: Float) -> Quaternion[Float]
:noindex:
:nocontentsentry:
Create a quaternion using the supplied vector/scalar (type inferred from scalar type).
.. function:: quaternion(q: Quaternion[Float])
:noindex:
:nocontentsentry:
Construct a quaternion of type dtype from another quaternion of a different dtype.
.. function:: quat_identity() -> quatf
Construct an identity quaternion with zero imaginary part and real part of 1.0
.. function:: quat_from_axis_angle(axis: Vector[3,Float], angle: Float) -> Quaternion[Scalar]
Construct a quaternion representing a rotation of angle radians around the given axis.
.. function:: quat_to_axis_angle(q: Quaternion[Float], axis: Vector[3,Float], angle: Float) -> None
Extract the rotation axis and angle radians a quaternion represents.
.. function:: quat_from_matrix(m: Matrix[3,3,Float]) -> Quaternion[Scalar]
Construct a quaternion from a 3x3 matrix.
.. function:: quat_rpy(roll: Float, pitch: Float, yaw: Float) -> Quaternion[Scalar]
Construct a quaternion representing a combined roll (z), pitch (x), yaw rotations (y) in radians.
.. function:: quat_inverse(q: Quaternion[Float]) -> Quaternion[Scalar]
Compute quaternion conjugate.
.. function:: quat_rotate(q: Quaternion[Float], p: Vector[3,Float]) -> Vector[3,Scalar]
Rotate a vector by a quaternion.
.. function:: quat_rotate_inv(q: Quaternion[Float], p: Vector[3,Float]) -> Vector[3,Scalar]
Rotate a vector by the inverse of a quaternion.
.. function:: quat_slerp(q0: Quaternion[Float], q1: Quaternion[Float], t: Float) -> Quaternion[Scalar]
Linearly interpolate between two quaternions.
.. function:: quat_to_matrix(q: Quaternion[Float]) -> Matrix[3,3,Scalar]
Convert a quaternion to a 3x3 rotation matrix.
Transformations
---------------
.. function:: transformation(p: Vector[3,Float], q: Quaternion[Float]) -> Transformation[Scalar]
Construct a rigid-body transformation with translation part ``p`` and rotation ``q``.
.. function:: transform_identity() -> transformf
Construct an identity transform with zero translation and identity rotation.
.. function:: transform_get_translation(t: Transformation[Float]) -> Vector[3,Scalar]
Return the translational part of a transform ``t``.
.. function:: transform_get_rotation(t: Transformation[Float]) -> Quaternion[Scalar]
Return the rotational part of a transform ``t``.
.. function:: transform_multiply(a: Transformation[Float], b: Transformation[Float]) -> Transformation[Scalar]
Multiply two rigid body transformations together.
.. function:: transform_point(t: Transformation[Scalar], p: Vector[3,Scalar]) -> Vector[3,Scalar]
Apply the transform to a point ``p`` treating the homogenous coordinate as w=1 (translation and rotation).
.. function:: transform_point(m: Matrix[4,4,Scalar], p: Vector[3,Scalar]) -> Vector[3,Scalar]
:noindex:
:nocontentsentry:
Apply the transform to a point ``p`` treating the homogenous coordinate as w=1.
The transformation is applied treating ``p`` as a column vector, e.g.: ``y = M*p``.
Note this is in contrast to some libraries, notably USD, which applies transforms to row vectors, ``y^T = p^T*M^T``.
If the transform is coming from a library that uses row-vectors, then users should transpose the transformation
matrix before calling this method.
.. function:: transform_vector(t: Transformation[Scalar], v: Vector[3,Scalar]) -> Vector[3,Scalar]
Apply the transform to a vector ``v`` treating the homogenous coordinate as w=0 (rotation only).
.. function:: transform_vector(m: Matrix[4,4,Scalar], v: Vector[3,Scalar]) -> Vector[3,Scalar]
:noindex:
:nocontentsentry:
Apply the transform to a vector ``v`` treating the homogenous coordinate as w=0.
The transformation is applied treating ``v`` as a column vector, e.g.: ``y = M*v``
note this is in contrast to some libraries, notably USD, which applies transforms to row vectors, ``y^T = v^T*M^T``.
If the transform is coming from a library that uses row-vectors, then users should transpose the transformation
matrix before calling this method.
.. function:: transform_inverse(t: Transformation[Float]) -> Transformation[Float]
Compute the inverse of the transformation ``t``.
Spatial Math
---------------
.. function:: spatial_adjoint(r: Matrix[3,3,Float], s: Matrix[3,3,Float]) -> Matrix[6,6,Scalar]
Construct a 6x6 spatial inertial matrix from two 3x3 diagonal blocks.
.. function:: spatial_dot(a: Vector[6,Float], b: Vector[6,Float]) -> Scalar
Compute the dot product of two 6D screw vectors.
.. function:: spatial_cross(a: Vector[6,Float], b: Vector[6,Float]) -> Vector[6,Float]
Compute the cross product of two 6D screw vectors.
.. function:: spatial_cross_dual(a: Vector[6,Float], b: Vector[6,Float]) -> Vector[6,Float]
Compute the dual cross product of two 6D screw vectors.
.. function:: spatial_top(a: Vector[6,Float])
Return the top (first) part of a 6D screw vector.
.. function:: spatial_bottom(a: Vector[6,Float])
Return the bottom (second) part of a 6D screw vector.
.. function:: spatial_jacobian(S: Array[Vector[6,Float]], joint_parents: Array[int32], joint_qd_start: Array[int32], joint_start: int32, joint_count: int32, J_start: int32, J_out: Array[Float]) -> None
.. function:: spatial_mass(I_s: Array[Matrix[6,6,Float]], joint_start: int32, joint_count: int32, M_start: int32, M: Array[Float]) -> None
Utility
---------------
.. function:: mlp(weights: Array[float32], bias: Array[float32], activation: Callable, index: int32, x: Array[float32], out: Array[float32]) -> None
Evaluate a multi-layer perceptron (MLP) layer in the form: ``out = act(weights*x + bias)``.
:param weights: A layer's network weights with dimensions ``(m, n)``.
:param bias: An array with dimensions ``(n)``.
:param activation: A ``wp.func`` function that takes a single scalar float as input and returns a scalar float as output
:param index: The batch item to process, typically each thread will process one item in the batch, in which case
index should be ``wp.tid()``
:param x: The feature matrix with dimensions ``(n, b)``
:param out: The network output with dimensions ``(m, b)``
:note: Feature and output matrices are transposed compared to some other frameworks such as PyTorch.
All matrices are assumed to be stored in flattened row-major memory layout (NumPy default).
.. function:: printf() -> None
Allows printing formatted strings using C-style format specifiers.
.. function:: print(value: Any) -> None
Print variable to stdout
.. function:: breakpoint() -> None
Debugger breakpoint
.. function:: tid() -> int
Return the current thread index for a 1D kernel launch. Note that this is the *global* index of the thread in the range [0, dim)
where dim is the parameter passed to kernel launch. This function may not be called from user-defined Warp functions.
.. function:: tid() -> Tuple[int, int]
:noindex:
:nocontentsentry:
Return the current thread indices for a 2D kernel launch. Use ``i,j = wp.tid()`` syntax to retrieve the
coordinates inside the kernel thread grid. This function may not be called from user-defined Warp functions.
.. function:: tid() -> Tuple[int, int, int]
:noindex:
:nocontentsentry:
Return the current thread indices for a 3D kernel launch. Use ``i,j,k = wp.tid()`` syntax to retrieve the
coordinates inside the kernel thread grid. This function may not be called from user-defined Warp functions.
.. function:: tid() -> Tuple[int, int, int, int]
:noindex:
:nocontentsentry:
Return the current thread indices for a 4D kernel launch. Use ``i,j,k,l = wp.tid()`` syntax to retrieve the
coordinates inside the kernel thread grid. This function may not be called from user-defined Warp functions.
.. function:: select(cond: bool, arg1: Any, arg2: Any)
Select between two arguments, if ``cond`` is ``False`` then return ``arg1``, otherwise return ``arg2``
.. function:: select(cond: bool, arg1: Any, arg2: Any)
:noindex:
:nocontentsentry:
Select between two arguments, if ``cond`` is ``False`` then return ``arg1``, otherwise return ``arg2``
.. function:: select(cond: int8, arg1: Any, arg2: Any)
:noindex:
:nocontentsentry:
Select between two arguments, if ``cond`` is ``False`` then return ``arg1``, otherwise return ``arg2``
.. function:: select(cond: uint8, arg1: Any, arg2: Any)
:noindex:
:nocontentsentry:
Select between two arguments, if ``cond`` is ``False`` then return ``arg1``, otherwise return ``arg2``
.. function:: select(cond: int16, arg1: Any, arg2: Any)
:noindex:
:nocontentsentry:
Select between two arguments, if ``cond`` is ``False`` then return ``arg1``, otherwise return ``arg2``
.. function:: select(cond: uint16, arg1: Any, arg2: Any)
:noindex:
:nocontentsentry:
Select between two arguments, if ``cond`` is ``False`` then return ``arg1``, otherwise return ``arg2``
.. function:: select(cond: int32, arg1: Any, arg2: Any)
:noindex:
:nocontentsentry:
Select between two arguments, if ``cond`` is ``False`` then return ``arg1``, otherwise return ``arg2``
.. function:: select(cond: uint32, arg1: Any, arg2: Any)
:noindex:
:nocontentsentry:
Select between two arguments, if ``cond`` is ``False`` then return ``arg1``, otherwise return ``arg2``
.. function:: select(cond: int64, arg1: Any, arg2: Any)
:noindex:
:nocontentsentry:
Select between two arguments, if ``cond`` is ``False`` then return ``arg1``, otherwise return ``arg2``
.. function:: select(cond: uint64, arg1: Any, arg2: Any)
:noindex:
:nocontentsentry:
Select between two arguments, if ``cond`` is ``False`` then return ``arg1``, otherwise return ``arg2``
.. function:: select(arr: Array[Any], arg1: Any, arg2: Any)
:noindex:
:nocontentsentry:
Select between two arguments, if ``arr`` is null then return ``arg1``, otherwise return ``arg2``
.. function:: atomic_add(a: Array[Any], i: int32, value: Any)
Atomically add ``value`` onto ``a[i]``.
.. function:: atomic_add(a: Array[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i,j]``.
.. function:: atomic_add(a: Array[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i,j,k]``.
.. function:: atomic_add(a: Array[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i,j,k,l]``.
.. function:: atomic_add(a: FabricArray[Any], i: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i]``.
.. function:: atomic_add(a: FabricArray[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i,j]``.
.. function:: atomic_add(a: FabricArray[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i,j,k]``.
.. function:: atomic_add(a: FabricArray[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i,j,k,l]``.
.. function:: atomic_add(a: IndexedFabricArray[Any], i: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i]``.
.. function:: atomic_add(a: IndexedFabricArray[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i,j]``.
.. function:: atomic_add(a: IndexedFabricArray[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i,j,k]``.
.. function:: atomic_add(a: IndexedFabricArray[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically add ``value`` onto ``a[i,j,k,l]``.
.. function:: atomic_sub(a: Array[Any], i: int32, value: Any)
Atomically subtract ``value`` onto ``a[i]``.
.. function:: atomic_sub(a: Array[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i,j]``.
.. function:: atomic_sub(a: Array[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i,j,k]``.
.. function:: atomic_sub(a: Array[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i,j,k,l]``.
.. function:: atomic_sub(a: FabricArray[Any], i: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i]``.
.. function:: atomic_sub(a: FabricArray[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i,j]``.
.. function:: atomic_sub(a: FabricArray[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i,j,k]``.
.. function:: atomic_sub(a: FabricArray[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i,j,k,l]``.
.. function:: atomic_sub(a: IndexedFabricArray[Any], i: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i]``.
.. function:: atomic_sub(a: IndexedFabricArray[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i,j]``.
.. function:: atomic_sub(a: IndexedFabricArray[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i,j,k]``.
.. function:: atomic_sub(a: IndexedFabricArray[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Atomically subtract ``value`` onto ``a[i,j,k,l]``.
.. function:: atomic_min(a: Array[Any], i: int32, value: Any)
Compute the minimum of ``value`` and ``a[i]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: Array[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i,j]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: Array[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i,j,k]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: Array[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i,j,k,l]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: FabricArray[Any], i: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: FabricArray[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i,j]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: FabricArray[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i,j,k]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: FabricArray[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i,j,k,l]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: IndexedFabricArray[Any], i: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: IndexedFabricArray[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i,j]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: IndexedFabricArray[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i,j,k]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_min(a: IndexedFabricArray[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the minimum of ``value`` and ``a[i,j,k,l]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: Array[Any], i: int32, value: Any)
Compute the maximum of ``value`` and ``a[i]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: Array[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i,j]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: Array[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i,j,k]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: Array[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i,j,k,l]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: FabricArray[Any], i: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: FabricArray[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i,j]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: FabricArray[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i,j,k]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: FabricArray[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i,j,k,l]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: IndexedFabricArray[Any], i: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: IndexedFabricArray[Any], i: int32, j: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i,j]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: IndexedFabricArray[Any], i: int32, j: int32, k: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i,j,k]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: atomic_max(a: IndexedFabricArray[Any], i: int32, j: int32, k: int32, l: int32, value: Any)
:noindex:
:nocontentsentry:
Compute the maximum of ``value`` and ``a[i,j,k,l]`` and atomically update the array.
Note that for vectors and matrices the operation is only atomic on a per-component basis.
.. function:: lerp(a: Float, b: Float, t: Float) -> Float
Linearly interpolate two values ``a`` and ``b`` using factor ``t``, computed as ``a*(1-t) + b*t``
.. function:: lerp(a: Vector[Any,Float], b: Vector[Any,Float], t: Float) -> Vector[Any,Float]
:noindex:
:nocontentsentry:
Linearly interpolate two values ``a`` and ``b`` using factor ``t``, computed as ``a*(1-t) + b*t``
.. function:: lerp(a: Matrix[Any,Any,Float], b: Matrix[Any,Any,Float], t: Float) -> Matrix[Any,Any,Float]
:noindex:
:nocontentsentry:
Linearly interpolate two values ``a`` and ``b`` using factor ``t``, computed as ``a*(1-t) + b*t``
.. function:: lerp(a: Quaternion[Float], b: Quaternion[Float], t: Float) -> Quaternion[Float]
:noindex:
:nocontentsentry:
Linearly interpolate two values ``a`` and ``b`` using factor ``t``, computed as ``a*(1-t) + b*t``
.. function:: lerp(a: Transformation[Float], b: Transformation[Float], t: Float) -> Transformation[Float]
:noindex:
:nocontentsentry:
Linearly interpolate two values ``a`` and ``b`` using factor ``t``, computed as ``a*(1-t) + b*t``
.. function:: smoothstep(edge0: Float, edge1: Float, x: Float) -> Float
Smoothly interpolate between two values ``edge0`` and ``edge1`` using a factor ``x``,
and return a result between 0 and 1 using a cubic Hermite interpolation after clamping.
.. function:: expect_near(arg1: Float, arg2: Float, tolerance: Float) -> None
Prints an error to stdout if ``arg1`` and ``arg2`` are not closer than tolerance in magnitude
.. function:: expect_near(arg1: vec3f, arg2: vec3f, tolerance: float32) -> None
:noindex:
:nocontentsentry:
Prints an error to stdout if any element of ``arg1`` and ``arg2`` are not closer than tolerance in magnitude
Geometry
---------------
.. function:: bvh_query_aabb(id: uint64, lower: vec3f, upper: vec3f) -> bvh_query_t
Construct an axis-aligned bounding box query against a BVH object. This query can be used to iterate over all bounds
inside a BVH.
:param id: The BVH identifier
:param lower: The lower bound of the bounding box in BVH space
:param upper: The upper bound of the bounding box in BVH space
.. function:: bvh_query_ray(id: uint64, start: vec3f, dir: vec3f) -> bvh_query_t
Construct a ray query against a BVH object. This query can be used to iterate over all bounds
that intersect the ray.
:param id: The BVH identifier
:param start: The start of the ray in BVH space
:param dir: The direction of the ray in BVH space
.. function:: bvh_query_next(query: bvh_query_t, index: int32) -> bool
Move to the next bound returned by the query.
The index of the current bound is stored in ``index``, returns ``False`` if there are no more overlapping bound.
.. function:: mesh_query_point(id: uint64, point: vec3f, max_dist: float32) -> mesh_query_point_t
Computes the closest point on the :class:`Mesh` with identifier ``id`` to the given ``point`` in space.
Identifies the sign of the distance using additional ray-casts to determine if the point is inside or outside.
This method is relatively robust, but does increase computational cost.
See below for additional sign determination methods.
:param id: The mesh identifier
:param point: The point in space to query
:param max_dist: Mesh faces above this distance will not be considered by the query
.. function:: mesh_query_point_no_sign(id: uint64, point: vec3f, max_dist: float32) -> mesh_query_point_t
Computes the closest point on the :class:`Mesh` with identifier ``id`` to the given ``point`` in space.
This method does not compute the sign of the point (inside/outside) which makes it faster than other point query methods.
:param id: The mesh identifier
:param point: The point in space to query
:param max_dist: Mesh faces above this distance will not be considered by the query
.. function:: mesh_query_furthest_point_no_sign(id: uint64, point: vec3f, min_dist: float32) -> mesh_query_point_t
Computes the furthest point on the mesh with identifier `id` to the given point in space.
This method does not compute the sign of the point (inside/outside).
:param id: The mesh identifier
:param point: The point in space to query
:param min_dist: Mesh faces below this distance will not be considered by the query
.. function:: mesh_query_point_sign_normal(id: uint64, point: vec3f, max_dist: float32, epsilon: float32) -> mesh_query_point_t
Computes the closest point on the :class:`Mesh` with identifier ``id`` to the given ``point`` in space.
Identifies the sign of the distance (inside/outside) using the angle-weighted pseudo normal.
This approach to sign determination is robust for well conditioned meshes that are watertight and non-self intersecting.
It is also comparatively fast to compute.
:param id: The mesh identifier
:param point: The point in space to query
:param max_dist: Mesh faces above this distance will not be considered by the query
:param epsilon: Epsilon treating distance values as equal, when locating the minimum distance vertex/face/edge, as a
fraction of the average edge length, also for treating closest point as being on edge/vertex default 1e-3
.. function:: mesh_query_point_sign_winding_number(id: uint64, point: vec3f, max_dist: float32, accuracy: float32, threshold: float32) -> mesh_query_point_t
Computes the closest point on the :class:`Mesh` with identifier ``id`` to the given point in space.
Identifies the sign using the winding number of the mesh relative to the query point. This method of sign determination is robust for poorly conditioned meshes
and provides a smooth approximation to sign even when the mesh is not watertight. This method is the most robust and accurate of the sign determination meshes
but also the most expensive.
.. note:: The :class:`Mesh` object must be constructed with ``support_winding_number=True`` for this method to return correct results.
:param id: The mesh identifier
:param point: The point in space to query
:param max_dist: Mesh faces above this distance will not be considered by the query
:param accuracy: Accuracy for computing the winding number with fast winding number method utilizing second-order dipole approximation, default 2.0
:param threshold: The threshold of the winding number to be considered inside, default 0.5
.. function:: mesh_query_ray(id: uint64, start: vec3f, dir: vec3f, max_t: float32) -> mesh_query_ray_t
Computes the closest ray hit on the :class:`Mesh` with identifier ``id``.
:param id: The mesh identifier
:param start: The start point of the ray
:param dir: The ray direction (should be normalized)
:param max_t: The maximum distance along the ray to check for intersections
.. function:: mesh_query_aabb(id: uint64, lower: vec3f, upper: vec3f) -> mesh_query_aabb_t
Construct an axis-aligned bounding box query against a :class:`Mesh`.
This query can be used to iterate over all triangles inside a volume.
:param id: The mesh identifier
:param lower: The lower bound of the bounding box in mesh space
:param upper: The upper bound of the bounding box in mesh space
.. function:: mesh_query_aabb_next(query: mesh_query_aabb_t, index: int32) -> bool
Move to the next triangle overlapping the query bounding box.
The index of the current face is stored in ``index``, returns ``False`` if there are no more overlapping triangles.
.. function:: mesh_eval_position(id: uint64, face: int32, bary_u: float32, bary_v: float32) -> vec3f
Evaluates the position on the :class:`Mesh` given a face index and barycentric coordinates.
.. function:: mesh_eval_velocity(id: uint64, face: int32, bary_u: float32, bary_v: float32) -> vec3f
Evaluates the velocity on the :class:`Mesh` given a face index and barycentric coordinates.
.. function:: hash_grid_query(id: uint64, point: vec3f, max_dist: float32) -> hash_grid_query_t
Construct a point query against a :class:`HashGrid`. This query can be used to iterate over all neighboring points within a fixed radius from the query point.
.. function:: hash_grid_query_next(query: hash_grid_query_t, index: int32) -> bool
Move to the next point in the hash grid query. The index of the current neighbor is stored in ``index``, returns ``False``
if there are no more neighbors.
.. function:: hash_grid_point_id(id: uint64, index: int32) -> int
Return the index of a point in the :class:`HashGrid`. This can be used to reorder threads such that grid
traversal occurs in a spatially coherent order.
Returns -1 if the :class:`HashGrid` has not been reserved.
.. function:: intersect_tri_tri(v0: vec3f, v1: vec3f, v2: vec3f, u0: vec3f, u1: vec3f, u2: vec3f) -> int
Tests for intersection between two triangles (v0, v1, v2) and (u0, u1, u2) using Moller's method. Returns > 0 if triangles intersect.
.. function:: mesh_get(id: uint64) -> Mesh
Retrieves the mesh given its index. [1]_
.. function:: mesh_eval_face_normal(id: uint64, face: int32) -> vec3f
Evaluates the face normal the mesh given a face index.
.. function:: mesh_get_point(id: uint64, index: int32) -> vec3f
Returns the point of the mesh given a index.
.. function:: mesh_get_velocity(id: uint64, index: int32) -> vec3f
Returns the velocity of the mesh given a index.
.. function:: mesh_get_index(id: uint64, index: int32) -> int
Returns the point-index of the mesh given a face-vertex index.
.. function:: closest_point_edge_edge(p1: vec3f, q1: vec3f, p2: vec3f, q2: vec3f, epsilon: float32) -> vec3f
Finds the closest points between two edges. Returns barycentric weights to the points on each edge, as well as the closest distance between the edges.
:param p1: First point of first edge
:param q1: Second point of first edge
:param p2: First point of second edge
:param q2: Second point of second edge
:param epsilon: Zero tolerance for determining if points in an edge are degenerate.
:param out: vec3 output containing (s,t,d), where `s` in [0,1] is the barycentric weight for the first edge, `t` is the barycentric weight for the second edge, and `d` is the distance between the two edges at these two closest points.
Volumes
---------------
.. function:: volume_sample_f(id: uint64, uvw: vec3f, sampling_mode: int32) -> float
Sample the volume given by ``id`` at the volume local-space point ``uvw``.
Interpolation should be :attr:`warp.Volume.CLOSEST` or :attr:`wp.Volume.LINEAR.`
.. function:: volume_sample_grad_f(id: uint64, uvw: vec3f, sampling_mode: int32, grad: vec3f) -> float
Sample the volume and its gradient given by ``id`` at the volume local-space point ``uvw``.
Interpolation should be :attr:`warp.Volume.CLOSEST` or :attr:`wp.Volume.LINEAR.`
.. function:: volume_lookup_f(id: uint64, i: int32, j: int32, k: int32) -> float
Returns the value of voxel with coordinates ``i``, ``j``, ``k``.
If the voxel at this index does not exist, this function returns the background value
.. function:: volume_store_f(id: uint64, i: int32, j: int32, k: int32, value: float32) -> None
Store ``value`` at the voxel with coordinates ``i``, ``j``, ``k``.
.. function:: volume_sample_v(id: uint64, uvw: vec3f, sampling_mode: int32) -> vec3f
Sample the vector volume given by ``id`` at the volume local-space point ``uvw``.
Interpolation should be :attr:`warp.Volume.CLOSEST` or :attr:`wp.Volume.LINEAR.`
.. function:: volume_lookup_v(id: uint64, i: int32, j: int32, k: int32) -> vec3f
Returns the vector value of voxel with coordinates ``i``, ``j``, ``k``.
If the voxel at this index does not exist, this function returns the background value.
.. function:: volume_store_v(id: uint64, i: int32, j: int32, k: int32, value: vec3f) -> None
Store ``value`` at the voxel with coordinates ``i``, ``j``, ``k``.
.. function:: volume_sample_i(id: uint64, uvw: vec3f) -> int
Sample the :class:`int32` volume given by ``id`` at the volume local-space point ``uvw``.
.. function:: volume_lookup_i(id: uint64, i: int32, j: int32, k: int32) -> int
Returns the :class:`int32` value of voxel with coordinates ``i``, ``j``, ``k``.
If the voxel at this index does not exist, this function returns the background value.
.. function:: volume_store_i(id: uint64, i: int32, j: int32, k: int32, value: int32) -> None
Store ``value`` at the voxel with coordinates ``i``, ``j``, ``k``.
.. function:: volume_index_to_world(id: uint64, uvw: vec3f) -> vec3f
Transform a point ``uvw`` defined in volume index space to world space given the volume's intrinsic affine transformation.
.. function:: volume_world_to_index(id: uint64, xyz: vec3f) -> vec3f
Transform a point ``xyz`` defined in volume world space to the volume's index space given the volume's intrinsic affine transformation.
.. function:: volume_index_to_world_dir(id: uint64, uvw: vec3f) -> vec3f
Transform a direction ``uvw`` defined in volume index space to world space given the volume's intrinsic affine transformation.
.. function:: volume_world_to_index_dir(id: uint64, xyz: vec3f) -> vec3f
Transform a direction ``xyz`` defined in volume world space to the volume's index space given the volume's intrinsic affine transformation.
Random
---------------
.. function:: rand_init(seed: int32) -> uint32
Initialize a new random number generator given a user-defined seed. Returns a 32-bit integer representing the RNG state.
.. function:: rand_init(seed: int32, offset: int32) -> uint32
:noindex:
:nocontentsentry:
Initialize a new random number generator given a user-defined seed and an offset.
This alternative constructor can be useful in parallel programs, where a kernel as a whole should share a seed,
but each thread should generate uncorrelated values. In this case usage should be ``r = rand_init(seed, tid)``
.. function:: randi(state: uint32) -> int
Return a random integer in the range [0, 2^32).
.. function:: randi(state: uint32, min: int32, max: int32) -> int
:noindex:
:nocontentsentry:
Return a random integer between [min, max).
.. function:: randf(state: uint32) -> float
Return a random float between [0.0, 1.0).
.. function:: randf(state: uint32, min: float32, max: float32) -> float
:noindex:
:nocontentsentry:
Return a random float between [min, max).
.. function:: randn(state: uint32) -> float
Sample a normal distribution.
.. function:: sample_cdf(state: uint32, cdf: Array[float32]) -> int
Inverse-transform sample a cumulative distribution function.
.. function:: sample_triangle(state: uint32) -> vec2f
Uniformly sample a triangle. Returns sample barycentric coordinates.
.. function:: sample_unit_ring(state: uint32) -> vec2f
Uniformly sample a ring in the xy plane.
.. function:: sample_unit_disk(state: uint32) -> vec2f
Uniformly sample a disk in the xy plane.
.. function:: sample_unit_sphere_surface(state: uint32) -> vec3f
Uniformly sample a unit sphere surface.
.. function:: sample_unit_sphere(state: uint32) -> vec3f
Uniformly sample a unit sphere.
.. function:: sample_unit_hemisphere_surface(state: uint32) -> vec3f
Uniformly sample a unit hemisphere surface.
.. function:: sample_unit_hemisphere(state: uint32) -> vec3f
Uniformly sample a unit hemisphere.
.. function:: sample_unit_square(state: uint32) -> vec2f
Uniformly sample a unit square.
.. function:: sample_unit_cube(state: uint32) -> vec3f
Uniformly sample a unit cube.
.. function:: poisson(state: uint32, lam: float32) -> uint32
Generate a random sample from a Poisson distribution.
:param state: RNG state
:param lam: The expected value of the distribution
.. function:: noise(state: uint32, x: float32) -> float
Non-periodic Perlin-style noise in 1D.
.. function:: noise(state: uint32, xy: vec2f) -> float
:noindex:
:nocontentsentry:
Non-periodic Perlin-style noise in 2D.
.. function:: noise(state: uint32, xyz: vec3f) -> float
:noindex:
:nocontentsentry:
Non-periodic Perlin-style noise in 3D.
.. function:: noise(state: uint32, xyzt: vec4f) -> float
:noindex:
:nocontentsentry:
Non-periodic Perlin-style noise in 4D.
.. function:: pnoise(state: uint32, x: float32, px: int32) -> float
Periodic Perlin-style noise in 1D.
.. function:: pnoise(state: uint32, xy: vec2f, px: int32, py: int32) -> float
:noindex:
:nocontentsentry:
Periodic Perlin-style noise in 2D.
.. function:: pnoise(state: uint32, xyz: vec3f, px: int32, py: int32, pz: int32) -> float
:noindex:
:nocontentsentry:
Periodic Perlin-style noise in 3D.
.. function:: pnoise(state: uint32, xyzt: vec4f, px: int32, py: int32, pz: int32, pt: int32) -> float
:noindex:
:nocontentsentry:
Periodic Perlin-style noise in 4D.
.. function:: curlnoise(state: uint32, xy: vec2f, octaves: uint32, lacunarity: float32, gain: float32) -> vec2f
Divergence-free vector field based on the gradient of a Perlin noise function. [1]_
.. function:: curlnoise(state: uint32, xyz: vec3f, octaves: uint32, lacunarity: float32, gain: float32) -> vec3f
:noindex:
:nocontentsentry:
Divergence-free vector field based on the curl of three Perlin noise functions. [1]_
.. function:: curlnoise(state: uint32, xyzt: vec4f, octaves: uint32, lacunarity: float32, gain: float32) -> vec3f
:noindex:
:nocontentsentry:
Divergence-free vector field based on the curl of three Perlin noise functions. [1]_
Operators
---------------
.. function:: add(x: Scalar, y: Scalar) -> Scalar
.. function:: add(x: Vector[Any,Scalar], y: Vector[Any,Scalar]) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: add(x: Quaternion[Scalar], y: Quaternion[Scalar]) -> Quaternion[Scalar]
:noindex:
:nocontentsentry:
.. function:: add(x: Matrix[Any,Any,Scalar], y: Matrix[Any,Any,Scalar]) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: add(x: Transformation[Scalar], y: Transformation[Scalar]) -> Transformation[Scalar]
:noindex:
:nocontentsentry:
.. function:: sub(x: Scalar, y: Scalar) -> Scalar
.. function:: sub(x: Vector[Any,Scalar], y: Vector[Any,Scalar]) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: sub(x: Matrix[Any,Any,Scalar], y: Matrix[Any,Any,Scalar]) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: sub(x: Quaternion[Scalar], y: Quaternion[Scalar]) -> Quaternion[Scalar]
:noindex:
:nocontentsentry:
.. function:: sub(x: Transformation[Scalar], y: Transformation[Scalar]) -> Transformation[Scalar]
:noindex:
:nocontentsentry:
.. function:: bit_and(x: Int, y: Int) -> Int
.. function:: bit_or(x: Int, y: Int) -> Int
.. function:: bit_xor(x: Int, y: Int) -> Int
.. function:: lshift(x: Int, y: Int) -> Int
.. function:: rshift(x: Int, y: Int) -> Int
.. function:: invert(x: Int) -> Int
.. function:: mul(x: Scalar, y: Scalar) -> Scalar
.. function:: mul(x: Vector[Any,Scalar], y: Scalar) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Scalar, y: Vector[Any,Scalar]) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Quaternion[Scalar], y: Scalar) -> Quaternion[Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Scalar, y: Quaternion[Scalar]) -> Quaternion[Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Quaternion[Scalar], y: Quaternion[Scalar]) -> Quaternion[Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Scalar, y: Matrix[Any,Any,Scalar]) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Matrix[Any,Any,Scalar], y: Scalar) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Matrix[Any,Any,Scalar], y: Vector[Any,Scalar]) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Vector[Any,Scalar], y: Matrix[Any,Any,Scalar]) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Matrix[Any,Any,Scalar], y: Matrix[Any,Any,Scalar])
:noindex:
:nocontentsentry:
.. function:: mul(x: Transformation[Scalar], y: Transformation[Scalar]) -> Transformation[Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Scalar, y: Transformation[Scalar]) -> Transformation[Scalar]
:noindex:
:nocontentsentry:
.. function:: mul(x: Transformation[Scalar], y: Scalar) -> Transformation[Scalar]
:noindex:
:nocontentsentry:
.. function:: mod(x: Scalar, y: Scalar) -> Scalar
.. function:: div(x: Scalar, y: Scalar) -> Scalar
.. function:: div(x: Vector[Any,Scalar], y: Scalar) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: div(x: Scalar, y: Vector[Any,Scalar]) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: div(x: Matrix[Any,Any,Scalar], y: Scalar) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: div(x: Scalar, y: Matrix[Any,Any,Scalar]) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: div(x: Quaternion[Scalar], y: Scalar) -> Quaternion[Scalar]
:noindex:
:nocontentsentry:
.. function:: div(x: Scalar, y: Quaternion[Scalar]) -> Quaternion[Scalar]
:noindex:
:nocontentsentry:
.. function:: floordiv(x: Scalar, y: Scalar) -> Scalar
.. function:: pos(x: Scalar) -> Scalar
.. function:: pos(x: Vector[Any,Scalar]) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: pos(x: Quaternion[Scalar]) -> Quaternion[Scalar]
:noindex:
:nocontentsentry:
.. function:: pos(x: Matrix[Any,Any,Scalar]) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: neg(x: Scalar) -> Scalar
.. function:: neg(x: Vector[Any,Scalar]) -> Vector[Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: neg(x: Quaternion[Scalar]) -> Quaternion[Scalar]
:noindex:
:nocontentsentry:
.. function:: neg(x: Matrix[Any,Any,Scalar]) -> Matrix[Any,Any,Scalar]
:noindex:
:nocontentsentry:
.. function:: unot(b: bool) -> bool
.. function:: unot(b: int8) -> bool
:noindex:
:nocontentsentry:
.. function:: unot(b: uint8) -> bool
:noindex:
:nocontentsentry:
.. function:: unot(b: int16) -> bool
:noindex:
:nocontentsentry:
.. function:: unot(b: uint16) -> bool
:noindex:
:nocontentsentry:
.. function:: unot(b: int32) -> bool
:noindex:
:nocontentsentry:
.. function:: unot(b: uint32) -> bool
:noindex:
:nocontentsentry:
.. function:: unot(b: int64) -> bool
:noindex:
:nocontentsentry:
.. function:: unot(b: uint64) -> bool
:noindex:
:nocontentsentry:
.. function:: unot(a: Array[Any]) -> bool
:noindex:
:nocontentsentry:
.. rubric:: Footnotes
.. [1] Note: function gradients not implemented for backpropagation.
|