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 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
//! Safe interface for NumPy's [N-dimensional arrays][ndarray]
//!
//! [ndarray]: https://numpy.org/doc/stable/reference/arrays.ndarray.html
use std::{
marker::PhantomData,
mem,
ops::Deref,
os::raw::{c_int, c_void},
ptr, slice,
};
use ndarray::{
Array, ArrayBase, ArrayView, ArrayViewMut, Axis, Data, Dim, Dimension, IntoDimension, Ix0, Ix1,
Ix2, Ix3, Ix4, Ix5, Ix6, IxDyn, RawArrayView, RawArrayViewMut, RawData, ShapeBuilder,
StrideShape,
};
use num_traits::AsPrimitive;
use pyo3::{
ffi, pyobject_native_type_base,
types::{DerefToPyAny, PyAnyMethods, PyModule},
AsPyPointer, Bound, DowncastError, FromPyObject, IntoPy, Py, PyAny, PyErr, PyNativeType,
PyObject, PyResult, PyTypeInfo, Python,
};
use crate::borrow::{PyReadonlyArray, PyReadwriteArray};
use crate::cold;
use crate::convert::{ArrayExt, IntoPyArray, NpyIndex, ToNpyDims, ToPyArray};
use crate::dtype::{Element, PyArrayDescrMethods};
use crate::error::{
BorrowError, DimensionalityError, FromVecError, IgnoreError, NotContiguousError, TypeError,
DIMENSIONALITY_MISMATCH_ERR, MAX_DIMENSIONALITY_ERR,
};
use crate::npyffi::{self, npy_intp, NPY_ORDER, PY_ARRAY_API};
use crate::slice_container::PySliceContainer;
use crate::untyped_array::{PyUntypedArray, PyUntypedArrayMethods};
/// A safe, statically-typed wrapper for NumPy's [`ndarray`][ndarray] class.
///
/// # Memory location
///
/// - Allocated by Rust: Constructed via [`IntoPyArray`] or
/// [`from_vec`][Self::from_vec] or [`from_owned_array`][Self::from_owned_array].
///
/// These methods transfers ownership of the Rust allocation into a suitable Python object
/// and uses the memory as the internal buffer backing the NumPy array.
///
/// Please note that some destructive methods like [`resize`][Self::resize] will fail
/// when used with this kind of array as NumPy cannot reallocate the internal buffer.
///
/// - Allocated by NumPy: Constructed via other methods, like [`ToPyArray`] or
/// [`from_slice`][Self::from_slice] or [`from_array`][Self::from_array].
///
/// These methods allocate memory in Python's private heap via NumPy's API.
///
/// In both cases, `PyArray` is managed by Python so it can neither be moved from
/// nor deallocated manually.
///
/// # References
///
/// Like [`new`][Self::new], all constructor methods of `PyArray` return a shared reference `&PyArray`
/// instead of an owned value. This design follows [PyO3's ownership concept][pyo3-memory],
/// i.e. the return value is GIL-bound owning reference into Python's heap.
///
/// # Element type and dimensionality
///
/// `PyArray` has two type parametes `T` and `D`.
/// `T` represents the type of its elements, e.g. [`f32`] or [`PyObject`].
/// `D` represents its dimensionality, e.g [`Ix2`][type@Ix2] or [`IxDyn`][type@IxDyn].
///
/// Element types are Rust types which implement the [`Element`] trait.
/// Dimensions are represented by the [`ndarray::Dimension`] trait.
///
/// Typically, `Ix1, Ix2, ...` are used for fixed dimensionality arrays,
/// and `IxDyn` is used for dynamic dimensionality arrays. Type aliases
/// for combining `PyArray` with these types are provided, e.g. [`PyArray1`] or [`PyArrayDyn`].
///
/// To specify concrete dimension like `3×4×5`, types which implement the [`ndarray::IntoDimension`]
/// trait are used. Typically, this means arrays like `[3, 4, 5]` or tuples like `(3, 4, 5)`.
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use ndarray::{array, Array};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0., 4., 1.).reshape([2, 2]).unwrap();
/// let array = array![[3., 4.], [5., 6.]];
///
/// assert_eq!(
/// array.dot(&pyarray.readonly().as_array()),
/// array![[8., 15.], [12., 23.]]
/// );
/// });
/// ```
///
/// [ndarray]: https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html
/// [pyo3-memory]: https://pyo3.rs/main/memory.html
#[repr(transparent)]
pub struct PyArray<T, D>(PyAny, PhantomData<T>, PhantomData<D>);
/// Zero-dimensional array.
pub type PyArray0<T> = PyArray<T, Ix0>;
/// One-dimensional array.
pub type PyArray1<T> = PyArray<T, Ix1>;
/// Two-dimensional array.
pub type PyArray2<T> = PyArray<T, Ix2>;
/// Three-dimensional array.
pub type PyArray3<T> = PyArray<T, Ix3>;
/// Four-dimensional array.
pub type PyArray4<T> = PyArray<T, Ix4>;
/// Five-dimensional array.
pub type PyArray5<T> = PyArray<T, Ix5>;
/// Six-dimensional array.
pub type PyArray6<T> = PyArray<T, Ix6>;
/// Dynamic-dimensional array.
pub type PyArrayDyn<T> = PyArray<T, IxDyn>;
/// Returns a handle to NumPy's multiarray module.
pub fn get_array_module<'py>(py: Python<'py>) -> PyResult<Bound<'_, PyModule>> {
PyModule::import_bound(py, npyffi::array::MOD_NAME)
}
impl<T, D> DerefToPyAny for PyArray<T, D> {}
unsafe impl<T: Element, D: Dimension> PyTypeInfo for PyArray<T, D> {
const NAME: &'static str = "PyArray<T, D>";
const MODULE: Option<&'static str> = Some("numpy");
fn type_object_raw<'py>(py: Python<'py>) -> *mut ffi::PyTypeObject {
unsafe { npyffi::PY_ARRAY_API.get_type_object(py, npyffi::NpyTypes::PyArray_Type) }
}
fn is_type_of_bound(ob: &Bound<'_, PyAny>) -> bool {
Self::extract::<IgnoreError>(ob).is_ok()
}
}
pyobject_native_type_base!(PyArray<T, D>; T; D);
impl<T, D> AsRef<PyAny> for PyArray<T, D> {
#[inline]
fn as_ref(&self) -> &PyAny {
&self.0
}
}
impl<T, D> Deref for PyArray<T, D> {
type Target = PyUntypedArray;
#[inline]
fn deref(&self) -> &Self::Target {
self.as_untyped()
}
}
unsafe impl<T, D> AsPyPointer for PyArray<T, D> {
#[inline]
fn as_ptr(&self) -> *mut ffi::PyObject {
self.0.as_ptr()
}
}
impl<T, D> IntoPy<Py<PyArray<T, D>>> for &'_ PyArray<T, D> {
#[inline]
fn into_py<'py>(self, py: Python<'py>) -> Py<PyArray<T, D>> {
unsafe { Py::from_borrowed_ptr(py, self.as_ptr()) }
}
}
impl<T, D> From<&'_ PyArray<T, D>> for Py<PyArray<T, D>> {
#[inline]
fn from(other: &PyArray<T, D>) -> Self {
unsafe { Py::from_borrowed_ptr(other.py(), other.as_ptr()) }
}
}
impl<'a, T, D> From<&'a PyArray<T, D>> for &'a PyAny {
fn from(ob: &'a PyArray<T, D>) -> Self {
unsafe { &*(ob as *const PyArray<T, D> as *const PyAny) }
}
}
impl<T, D> IntoPy<PyObject> for PyArray<T, D> {
fn into_py<'py>(self, py: Python<'py>) -> PyObject {
unsafe { PyObject::from_borrowed_ptr(py, self.as_ptr()) }
}
}
impl<'py, T: Element, D: Dimension> FromPyObject<'py> for &'py PyArray<T, D> {
fn extract_bound(ob: &Bound<'py, PyAny>) -> PyResult<Self> {
#[allow(clippy::map_clone)] // due to MSRV
PyArray::extract(ob)
.map(Clone::clone)
.map(Bound::into_gil_ref)
}
}
impl<T, D> PyArray<T, D> {
/// Access an untyped representation of this array.
#[inline(always)]
pub fn as_untyped(&self) -> &PyUntypedArray {
unsafe { &*(self as *const Self as *const PyUntypedArray) }
}
/// Turn `&PyArray<T,D>` into `Py<PyArray<T,D>>`,
/// i.e. a pointer into Python's heap which is independent of the GIL lifetime.
///
/// This method can be used to avoid lifetime annotations of function arguments
/// or return values.
///
/// # Example
///
/// ```
/// use numpy::{PyArray1, PyArrayMethods};
/// use pyo3::{Py, Python};
///
/// let array: Py<PyArray1<f64>> = Python::with_gil(|py| {
/// PyArray1::zeros_bound(py, 5, false).unbind()
/// });
///
/// Python::with_gil(|py| {
/// assert_eq!(array.bind(py).readonly().as_slice().unwrap(), [0.0; 5]);
/// });
/// ```
#[deprecated(since = "0.21.0", note = "use Bound::unbind() instead")]
pub fn to_owned(&self) -> Py<Self> {
unsafe { Py::from_borrowed_ptr(self.py(), self.as_ptr()) }
}
/// Constructs a reference to a `PyArray` from a raw pointer to a Python object.
///
/// # Safety
///
/// This is a wrapper around [`pyo3::FromPyPointer::from_owned_ptr_or_opt`] and inherits its safety contract.
#[deprecated(since = "0.21.0", note = "use Bound::from_owned_ptr() instead")]
pub unsafe fn from_owned_ptr<'py>(py: Python<'py>, ptr: *mut ffi::PyObject) -> &'py Self {
#[allow(deprecated)]
py.from_owned_ptr(ptr)
}
/// Constructs a reference to a `PyArray` from a raw point to a Python object.
///
/// # Safety
///
/// This is a wrapper around [`pyo3::FromPyPointer::from_borrowed_ptr_or_opt`] and inherits its safety contract.
#[deprecated(since = "0.21.0", note = "use Bound::from_borrowed_ptr() instead")]
pub unsafe fn from_borrowed_ptr<'py>(py: Python<'py>, ptr: *mut ffi::PyObject) -> &'py Self {
#[allow(deprecated)]
py.from_borrowed_ptr(ptr)
}
/// Returns a pointer to the first element of the array.
#[inline(always)]
pub fn data(&self) -> *mut T {
unsafe { (*self.as_array_ptr()).data as *mut _ }
}
}
impl<T: Element, D: Dimension> PyArray<T, D> {
fn extract<'a, 'py, E>(ob: &'a Bound<'py, PyAny>) -> Result<&'a Bound<'py, Self>, E>
where
E: From<DowncastError<'a, 'py>> + From<DimensionalityError> + From<TypeError<'py>>,
{
// Check if the object is an array.
let array = unsafe {
if npyffi::PyArray_Check(ob.py(), ob.as_ptr()) == 0 {
return Err(DowncastError::new(ob, <Self as PyTypeInfo>::NAME).into());
}
ob.downcast_unchecked::<Self>()
};
// Check if the dimensionality matches `D`.
let src_ndim = array.ndim();
if let Some(dst_ndim) = D::NDIM {
if src_ndim != dst_ndim {
return Err(DimensionalityError::new(src_ndim, dst_ndim).into());
}
}
// Check if the element type matches `T`.
let src_dtype = array.dtype();
let dst_dtype = T::get_dtype_bound(ob.py());
if !src_dtype.is_equiv_to(&dst_dtype) {
return Err(TypeError::new(src_dtype, dst_dtype).into());
}
Ok(array)
}
/// Same as [`shape`][PyUntypedArray::shape], but returns `D` instead of `&[usize]`.
#[inline(always)]
pub fn dims(&self) -> D {
D::from_dimension(&Dim(self.shape())).expect(DIMENSIONALITY_MISMATCH_ERR)
}
/// Deprecated form of [`PyArray<T, D>::new_bound`]
///
/// # Safety
/// Same as [`PyArray<T, D>::new_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by `PyArray::new_bound` in the future"
)]
pub unsafe fn new<'py, ID>(py: Python<'py>, dims: ID, is_fortran: bool) -> &Self
where
ID: IntoDimension<Dim = D>,
{
Self::new_bound(py, dims, is_fortran).into_gil_ref()
}
/// Creates a new uninitialized NumPy array.
///
/// If `is_fortran` is true, then it has Fortran/column-major order,
/// otherwise it has C/row-major order.
///
/// # Safety
///
/// The returned array will always be safe to be dropped as the elements must either
/// be trivially copyable (as indicated by `<T as Element>::IS_COPY`) or be pointers
/// into Python's heap, which NumPy will automatically zero-initialize.
///
/// However, the elements themselves will not be valid and should be initialized manually
/// using raw pointers obtained via [`uget_raw`][Self::uget_raw]. Before that, all methods
/// which produce references to the elements invoke undefined behaviour. In particular,
/// zero-initialized pointers are _not_ valid instances of `PyObject`.
///
/// # Example
///
/// ```
/// use numpy::prelude::*;
/// use numpy::PyArray3;
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let arr = unsafe {
/// let arr = PyArray3::<i32>::new_bound(py, [4, 5, 6], false);
///
/// for i in 0..4 {
/// for j in 0..5 {
/// for k in 0..6 {
/// arr.uget_raw([i, j, k]).write((i * j * k) as i32);
/// }
/// }
/// }
///
/// arr
/// };
///
/// assert_eq!(arr.shape(), &[4, 5, 6]);
/// });
/// ```
pub unsafe fn new_bound<'py, ID>(
py: Python<'py>,
dims: ID,
is_fortran: bool,
) -> Bound<'py, Self>
where
ID: IntoDimension<Dim = D>,
{
let flags = c_int::from(is_fortran);
Self::new_uninit(py, dims, ptr::null_mut(), flags)
}
pub(crate) unsafe fn new_uninit<'py, ID>(
py: Python<'py>,
dims: ID,
strides: *const npy_intp,
flag: c_int,
) -> Bound<'py, Self>
where
ID: IntoDimension<Dim = D>,
{
let mut dims = dims.into_dimension();
let ptr = PY_ARRAY_API.PyArray_NewFromDescr(
py,
PY_ARRAY_API.get_type_object(py, npyffi::NpyTypes::PyArray_Type),
T::get_dtype_bound(py).into_dtype_ptr(),
dims.ndim_cint(),
dims.as_dims_ptr(),
strides as *mut npy_intp, // strides
ptr::null_mut(), // data
flag, // flag
ptr::null_mut(), // obj
);
Bound::from_owned_ptr(py, ptr).downcast_into_unchecked()
}
unsafe fn new_with_data<'py, ID>(
py: Python<'py>,
dims: ID,
strides: *const npy_intp,
data_ptr: *const T,
container: *mut PyAny,
) -> Bound<'py, Self>
where
ID: IntoDimension<Dim = D>,
{
let mut dims = dims.into_dimension();
let ptr = PY_ARRAY_API.PyArray_NewFromDescr(
py,
PY_ARRAY_API.get_type_object(py, npyffi::NpyTypes::PyArray_Type),
T::get_dtype_bound(py).into_dtype_ptr(),
dims.ndim_cint(),
dims.as_dims_ptr(),
strides as *mut npy_intp, // strides
data_ptr as *mut c_void, // data
npyffi::NPY_ARRAY_WRITEABLE, // flag
ptr::null_mut(), // obj
);
PY_ARRAY_API.PyArray_SetBaseObject(
py,
ptr as *mut npyffi::PyArrayObject,
container as *mut ffi::PyObject,
);
Bound::from_owned_ptr(py, ptr).downcast_into_unchecked()
}
pub(crate) unsafe fn from_raw_parts<'py>(
py: Python<'py>,
dims: D,
strides: *const npy_intp,
data_ptr: *const T,
container: PySliceContainer,
) -> Bound<'py, Self> {
let container = Bound::new(py, container)
.expect("Failed to create slice container")
.into_ptr();
Self::new_with_data(py, dims, strides, data_ptr, container.cast())
}
/// Deprecated form of [`PyArray<T, D>::borrow_from_array_bound`]
///
/// # Safety
/// Same as [`PyArray<T, D>::borrow_from_array_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by `PyArray::borrow_from_array_bound` in the future"
)]
pub unsafe fn borrow_from_array<'py, S>(
array: &ArrayBase<S, D>,
container: &'py PyAny,
) -> &'py Self
where
S: Data<Elem = T>,
{
Self::borrow_from_array_bound(array, (*container.as_borrowed()).clone()).into_gil_ref()
}
/// Creates a NumPy array backed by `array` and ties its ownership to the Python object `container`.
///
/// # Safety
///
/// `container` is set as a base object of the returned array which must not be dropped until `container` is dropped.
/// Furthermore, `array` must not be reallocated from the time this method is called and until `container` is dropped.
///
/// # Example
///
/// ```rust
/// # use pyo3::prelude::*;
/// # use numpy::{ndarray::Array1, PyArray1};
/// #
/// #[pyclass]
/// struct Owner {
/// array: Array1<f64>,
/// }
///
/// #[pymethods]
/// impl Owner {
/// #[getter]
/// fn array<'py>(this: Bound<'py, Self>) -> Bound<'py, PyArray1<f64>> {
/// let array = &this.borrow().array;
///
/// // SAFETY: The memory backing `array` will stay valid as long as this object is alive
/// // as we do not modify `array` in any way which would cause it to be reallocated.
/// unsafe { PyArray1::borrow_from_array_bound(array, this.into_any()) }
/// }
/// }
/// ```
pub unsafe fn borrow_from_array_bound<'py, S>(
array: &ArrayBase<S, D>,
container: Bound<'py, PyAny>,
) -> Bound<'py, Self>
where
S: Data<Elem = T>,
{
let (strides, dims) = (array.npy_strides(), array.raw_dim());
let data_ptr = array.as_ptr();
let py = container.py();
Self::new_with_data(
py,
dims,
strides.as_ptr(),
data_ptr,
container.into_ptr().cast(),
)
}
/// Deprecated form of [`PyArray<T, D>::zeros_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by `PyArray::zeros_bound` in the future"
)]
pub fn zeros<'py, ID>(py: Python<'py>, dims: ID, is_fortran: bool) -> &Self
where
ID: IntoDimension<Dim = D>,
{
Self::zeros_bound(py, dims, is_fortran).into_gil_ref()
}
/// Construct a new NumPy array filled with zeros.
///
/// If `is_fortran` is true, then it has Fortran/column-major order,
/// otherwise it has C/row-major order.
///
/// For arrays of Python objects, this will fill the array
/// with valid pointers to zero-valued Python integer objects.
///
/// See also [`numpy.zeros`][numpy-zeros] and [`PyArray_Zeros`][PyArray_Zeros].
///
/// # Example
///
/// ```
/// use numpy::{PyArray2, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray2::<usize>::zeros_bound(py, [2, 2], true);
///
/// assert_eq!(pyarray.readonly().as_slice().unwrap(), [0; 4]);
/// });
/// ```
///
/// [numpy-zeros]: https://numpy.org/doc/stable/reference/generated/numpy.zeros.html
/// [PyArray_Zeros]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_Zeros
pub fn zeros_bound<ID>(py: Python<'_>, dims: ID, is_fortran: bool) -> Bound<'_, Self>
where
ID: IntoDimension<Dim = D>,
{
let mut dims = dims.into_dimension();
unsafe {
let ptr = PY_ARRAY_API.PyArray_Zeros(
py,
dims.ndim_cint(),
dims.as_dims_ptr(),
T::get_dtype_bound(py).into_dtype_ptr(),
if is_fortran { -1 } else { 0 },
);
Bound::from_owned_ptr(py, ptr).downcast_into_unchecked()
}
}
/// Returns an immutable view of the internal data as a slice.
///
/// # Safety
///
/// Calling this method is undefined behaviour if the underlying array
/// is aliased mutably by other instances of `PyArray`
/// or concurrently modified by Python or other native code.
///
/// Please consider the safe alternative [`PyReadonlyArray::as_slice`].
pub unsafe fn as_slice(&self) -> Result<&[T], NotContiguousError> {
if self.is_contiguous() {
Ok(slice::from_raw_parts(self.data(), self.len()))
} else {
Err(NotContiguousError)
}
}
/// Returns a mutable view of the internal data as a slice.
///
/// # Safety
///
/// Calling this method is undefined behaviour if the underlying array
/// is aliased immutably or mutably by other instances of [`PyArray`]
/// or concurrently modified by Python or other native code.
///
/// Please consider the safe alternative [`PyReadwriteArray::as_slice_mut`].
pub unsafe fn as_slice_mut(&self) -> Result<&mut [T], NotContiguousError> {
if self.is_contiguous() {
Ok(slice::from_raw_parts_mut(self.data(), self.len()))
} else {
Err(NotContiguousError)
}
}
/// Deprecated form of [`PyArray<T, D>::from_owned_array_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by PyArray::from_owned_array_bound in the future"
)]
pub fn from_owned_array<'py>(py: Python<'py>, arr: Array<T, D>) -> &'py Self {
Self::from_owned_array_bound(py, arr).into_gil_ref()
}
/// Constructs a NumPy from an [`ndarray::Array`]
///
/// This method uses the internal [`Vec`] of the [`ndarray::Array`] as the base object of the NumPy array.
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use ndarray::array;
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::from_owned_array_bound(py, array![[1, 2], [3, 4]]);
///
/// assert_eq!(pyarray.readonly().as_array(), array![[1, 2], [3, 4]]);
/// });
/// ```
pub fn from_owned_array_bound(py: Python<'_>, mut arr: Array<T, D>) -> Bound<'_, Self> {
let (strides, dims) = (arr.npy_strides(), arr.raw_dim());
let data_ptr = arr.as_mut_ptr();
unsafe {
Self::from_raw_parts(
py,
dims,
strides.as_ptr(),
data_ptr,
PySliceContainer::from(arr),
)
}
}
/// Get a reference of the specified element if the given index is valid.
///
/// # Safety
///
/// Calling this method is undefined behaviour if the underlying array
/// is aliased mutably by other instances of `PyArray`
/// or concurrently modified by Python or other native code.
///
/// Consider using safe alternatives like [`PyReadonlyArray::get`].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0, 16, 1).reshape([2, 2, 4]).unwrap();
///
/// assert_eq!(unsafe { *pyarray.get([1, 0, 3]).unwrap() }, 11);
/// });
/// ```
#[inline(always)]
pub unsafe fn get(&self, index: impl NpyIndex<Dim = D>) -> Option<&T> {
let ptr = get_raw(&self.as_borrowed(), index)?;
Some(&*ptr)
}
/// Same as [`get`][Self::get], but returns `Option<&mut T>`.
///
/// # Safety
///
/// Calling this method is undefined behaviour if the underlying array
/// is aliased immutably or mutably by other instances of [`PyArray`]
/// or concurrently modified by Python or other native code.
///
/// Consider using safe alternatives like [`PyReadwriteArray::get_mut`].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0, 16, 1).reshape([2, 2, 4]).unwrap();
///
/// unsafe {
/// *pyarray.get_mut([1, 0, 3]).unwrap() = 42;
/// }
///
/// assert_eq!(unsafe { *pyarray.get([1, 0, 3]).unwrap() }, 42);
/// });
/// ```
#[inline(always)]
pub unsafe fn get_mut(&self, index: impl NpyIndex<Dim = D>) -> Option<&mut T> {
let ptr = get_raw(&self.as_borrowed(), index)?;
Some(&mut *ptr)
}
/// Get an immutable reference of the specified element,
/// without checking the given index.
///
/// See [`NpyIndex`] for what types can be used as the index.
///
/// # Safety
///
/// Passing an invalid index is undefined behavior.
/// The element must also have been initialized and
/// all other references to it is must also be shared.
///
/// See [`PyReadonlyArray::get`] for a safe alternative.
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0, 16, 1).reshape([2, 2, 4]).unwrap();
///
/// assert_eq!(unsafe { *pyarray.uget([1, 0, 3]) }, 11);
/// });
/// ```
#[inline(always)]
pub unsafe fn uget<Idx>(&self, index: Idx) -> &T
where
Idx: NpyIndex<Dim = D>,
{
&*self.uget_raw(index)
}
/// Same as [`uget`](Self::uget), but returns `&mut T`.
///
/// # Safety
///
/// Passing an invalid index is undefined behavior.
/// The element must also have been initialized and
/// other references to it must not exist.
///
/// See [`PyReadwriteArray::get_mut`] for a safe alternative.
#[inline(always)]
#[allow(clippy::mut_from_ref)]
pub unsafe fn uget_mut<Idx>(&self, index: Idx) -> &mut T
where
Idx: NpyIndex<Dim = D>,
{
&mut *self.uget_raw(index)
}
/// Same as [`uget`][Self::uget], but returns `*mut T`.
///
/// # Safety
///
/// Passing an invalid index is undefined behavior.
#[inline(always)]
pub unsafe fn uget_raw<Idx>(&self, index: Idx) -> *mut T
where
Idx: NpyIndex<Dim = D>,
{
self.as_borrowed().uget_raw(index)
}
/// Get a copy of the specified element in the array.
///
/// See [`NpyIndex`] for what types can be used as the index.
///
/// # Example
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0, 16, 1).reshape([2, 2, 4]).unwrap();
///
/// assert_eq!(pyarray.get_owned([1, 0, 3]), Some(11));
/// });
/// ```
pub fn get_owned<Idx>(&self, index: Idx) -> Option<T>
where
Idx: NpyIndex<Dim = D>,
{
self.as_borrowed().get_owned(index)
}
/// Turn an array with fixed dimensionality into one with dynamic dimensionality.
pub fn to_dyn(&self) -> &PyArray<T, IxDyn> {
self.as_borrowed().to_dyn().clone().into_gil_ref()
}
/// Returns a copy of the internal data of the array as a [`Vec`].
///
/// Fails if the internal array is not contiguous. See also [`as_slice`][Self::as_slice].
///
/// # Example
///
/// ```
/// use numpy::{PyArray2, PyArrayMethods};
/// use pyo3::{Python, types::PyAnyMethods};
///
/// Python::with_gil(|py| {
/// let pyarray= py
/// .eval_bound("__import__('numpy').array([[0, 1], [2, 3]], dtype='int64')", None, None)
/// .unwrap()
/// .downcast_into::<PyArray2<i64>>()
/// .unwrap();
///
/// assert_eq!(pyarray.to_vec().unwrap(), vec![0, 1, 2, 3]);
/// });
/// ```
pub fn to_vec(&self) -> Result<Vec<T>, NotContiguousError> {
self.as_borrowed().to_vec()
}
/// Deprecated form of [`PyArray<T, D>::from_array_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by PyArray::from_array_bound in the future"
)]
pub fn from_array<'py, S>(py: Python<'py>, arr: &ArrayBase<S, D>) -> &'py Self
where
S: Data<Elem = T>,
{
Self::from_array_bound(py, arr).into_gil_ref()
}
/// Construct a NumPy array from a [`ndarray::ArrayBase`].
///
/// This method allocates memory in Python's heap via the NumPy API,
/// and then copies all elements of the array there.
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use ndarray::array;
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::from_array_bound(py, &array![[1, 2], [3, 4]]);
///
/// assert_eq!(pyarray.readonly().as_array(), array![[1, 2], [3, 4]]);
/// });
/// ```
pub fn from_array_bound<'py, S>(py: Python<'py>, arr: &ArrayBase<S, D>) -> Bound<'py, Self>
where
S: Data<Elem = T>,
{
ToPyArray::to_pyarray_bound(arr, py)
}
/// Get an immutable borrow of the NumPy array
pub fn try_readonly(&self) -> Result<PyReadonlyArray<'_, T, D>, BorrowError> {
PyReadonlyArray::try_new(self.as_borrowed().to_owned())
}
/// Get an immutable borrow of the NumPy array
///
/// # Panics
///
/// Panics if the allocation backing the array is currently mutably borrowed.
///
/// For a non-panicking variant, use [`try_readonly`][Self::try_readonly].
pub fn readonly(&self) -> PyReadonlyArray<'_, T, D> {
self.try_readonly().unwrap()
}
/// Get a mutable borrow of the NumPy array
pub fn try_readwrite(&self) -> Result<PyReadwriteArray<'_, T, D>, BorrowError> {
PyReadwriteArray::try_new(self.as_borrowed().to_owned())
}
/// Get a mutable borrow of the NumPy array
///
/// # Panics
///
/// Panics if the allocation backing the array is currently borrowed or
/// if the array is [flagged as][flags] not writeable.
///
/// For a non-panicking variant, use [`try_readwrite`][Self::try_readwrite].
///
/// [flags]: https://numpy.org/doc/stable/reference/generated/numpy.ndarray.flags.html
pub fn readwrite(&self) -> PyReadwriteArray<'_, T, D> {
self.try_readwrite().unwrap()
}
/// Returns an [`ArrayView`] of the internal array.
///
/// See also [`PyReadonlyArray::as_array`].
///
/// # Safety
///
/// Calling this method invalidates all exclusive references to the internal data, e.g. `&mut [T]` or `ArrayViewMut`.
pub unsafe fn as_array(&self) -> ArrayView<'_, T, D> {
as_view(&self.as_borrowed(), |shape, ptr| {
ArrayView::from_shape_ptr(shape, ptr)
})
}
/// Returns an [`ArrayViewMut`] of the internal array.
///
/// See also [`PyReadwriteArray::as_array_mut`].
///
/// # Safety
///
/// Calling this method invalidates all other references to the internal data, e.g. `ArrayView` or `ArrayViewMut`.
pub unsafe fn as_array_mut(&self) -> ArrayViewMut<'_, T, D> {
as_view(&self.as_borrowed(), |shape, ptr| {
ArrayViewMut::from_shape_ptr(shape, ptr)
})
}
/// Returns the internal array as [`RawArrayView`] enabling element access via raw pointers
pub fn as_raw_array(&self) -> RawArrayView<T, D> {
self.as_borrowed().as_raw_array()
}
/// Returns the internal array as [`RawArrayViewMut`] enabling element access via raw pointers
pub fn as_raw_array_mut(&self) -> RawArrayViewMut<T, D> {
self.as_borrowed().as_raw_array_mut()
}
/// Get a copy of the array as an [`ndarray::Array`].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use ndarray::array;
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0, 4, 1).reshape([2, 2]).unwrap();
///
/// assert_eq!(
/// pyarray.to_owned_array(),
/// array![[0, 1], [2, 3]]
/// )
/// });
/// ```
pub fn to_owned_array(&self) -> Array<T, D> {
self.as_borrowed().to_owned_array()
}
}
#[cfg(feature = "nalgebra")]
impl<N, D> PyArray<N, D>
where
N: nalgebra::Scalar + Element,
D: Dimension,
{
/// Try to convert this array into a [`nalgebra::MatrixView`] using the given shape and strides.
///
/// See [`PyReadonlyArray::try_as_matrix`] for a discussion of the memory layout requirements.
///
/// # Safety
///
/// Calling this method invalidates all exclusive references to the internal data, e.g. `ArrayViewMut` or `MatrixSliceMut`.
#[doc(alias = "nalgebra")]
pub unsafe fn try_as_matrix<R, C, RStride, CStride>(
&self,
) -> Option<nalgebra::MatrixView<'_, N, R, C, RStride, CStride>>
where
R: nalgebra::Dim,
C: nalgebra::Dim,
RStride: nalgebra::Dim,
CStride: nalgebra::Dim,
{
let (shape, strides) = try_as_matrix_shape_strides(&self.as_borrowed())?;
let storage = nalgebra::ViewStorage::from_raw_parts(self.data(), shape, strides);
Some(nalgebra::Matrix::from_data(storage))
}
/// Try to convert this array into a [`nalgebra::MatrixViewMut`] using the given shape and strides.
///
/// See [`PyReadonlyArray::try_as_matrix`] for a discussion of the memory layout requirements.
///
/// # Safety
///
/// Calling this method invalidates all other references to the internal data, e.g. `ArrayView`, `MatrixSlice`, `ArrayViewMut` or `MatrixSliceMut`.
#[doc(alias = "nalgebra")]
pub unsafe fn try_as_matrix_mut<R, C, RStride, CStride>(
&self,
) -> Option<nalgebra::MatrixViewMut<'_, N, R, C, RStride, CStride>>
where
R: nalgebra::Dim,
C: nalgebra::Dim,
RStride: nalgebra::Dim,
CStride: nalgebra::Dim,
{
let (shape, strides) = try_as_matrix_shape_strides(&self.as_borrowed())?;
let storage = nalgebra::ViewStorageMut::from_raw_parts(self.data(), shape, strides);
Some(nalgebra::Matrix::from_data(storage))
}
}
impl<D: Dimension> PyArray<PyObject, D> {
/// Deprecated form of [`PyArray<T, D>::from_owned_object_array_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by PyArray::from_owned_object_array_bound in the future"
)]
pub fn from_owned_object_array<'py, T>(py: Python<'py>, arr: Array<Py<T>, D>) -> &'py Self {
Self::from_owned_object_array_bound(py, arr).into_gil_ref()
}
/// Construct a NumPy array containing objects stored in a [`ndarray::Array`]
///
/// This method uses the internal [`Vec`] of the [`ndarray::Array`] as the base object of the NumPy array.
///
/// # Example
///
/// ```
/// use ndarray::array;
/// use pyo3::{pyclass, Py, Python, types::PyAnyMethods};
/// use numpy::{PyArray, PyArrayMethods};
///
/// #[pyclass]
/// # #[allow(dead_code)]
/// struct CustomElement {
/// foo: i32,
/// bar: f64,
/// }
///
/// Python::with_gil(|py| {
/// let array = array![
/// Py::new(py, CustomElement {
/// foo: 1,
/// bar: 2.0,
/// }).unwrap(),
/// Py::new(py, CustomElement {
/// foo: 3,
/// bar: 4.0,
/// }).unwrap(),
/// ];
///
/// let pyarray = PyArray::from_owned_object_array_bound(py, array);
///
/// assert!(pyarray.readonly().as_array().get(0).unwrap().bind(py).is_instance_of::<CustomElement>());
/// });
/// ```
pub fn from_owned_object_array_bound<T>(
py: Python<'_>,
mut arr: Array<Py<T>, D>,
) -> Bound<'_, Self> {
let (strides, dims) = (arr.npy_strides(), arr.raw_dim());
let data_ptr = arr.as_mut_ptr() as *const PyObject;
unsafe {
Self::from_raw_parts(
py,
dims,
strides.as_ptr(),
data_ptr,
PySliceContainer::from(arr),
)
}
}
}
impl<T: Copy + Element> PyArray<T, Ix0> {
/// Get the single element of a zero-dimensional array.
///
/// See [`inner`][crate::inner] for an example.
pub fn item(&self) -> T {
self.as_borrowed().item()
}
}
impl<T: Element> PyArray<T, Ix1> {
/// Deprecated form of [`PyArray<T, Ix1>::from_slice_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by `PyArray::from_slice_bound` in the future"
)]
pub fn from_slice<'py>(py: Python<'py>, slice: &[T]) -> &'py Self {
Self::from_slice_bound(py, slice).into_gil_ref()
}
/// Construct a one-dimensional array from a [mod@slice].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let slice = &[1, 2, 3, 4, 5];
/// let pyarray = PyArray::from_slice_bound(py, slice);
/// assert_eq!(pyarray.readonly().as_slice().unwrap(), &[1, 2, 3, 4, 5]);
/// });
/// ```
pub fn from_slice_bound<'py>(py: Python<'py>, slice: &[T]) -> Bound<'py, Self> {
unsafe {
let array = PyArray::new_bound(py, [slice.len()], false);
let mut data_ptr = array.data();
clone_elements(slice, &mut data_ptr);
array
}
}
/// Deprecated form of [`PyArray<T, Ix1>::from_vec_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by `PyArray::from_vec_bound` in the future"
)]
#[inline(always)]
pub fn from_vec<'py>(py: Python<'py>, vec: Vec<T>) -> &'py Self {
Self::from_vec_bound(py, vec).into_gil_ref()
}
/// Construct a one-dimensional array from a [`Vec<T>`][Vec].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let vec = vec![1, 2, 3, 4, 5];
/// let pyarray = PyArray::from_vec_bound(py, vec);
/// assert_eq!(pyarray.readonly().as_slice().unwrap(), &[1, 2, 3, 4, 5]);
/// });
/// ```
#[inline(always)]
pub fn from_vec_bound<'py>(py: Python<'py>, vec: Vec<T>) -> Bound<'py, Self> {
vec.into_pyarray_bound(py)
}
/// Deprecated form of [`PyArray<T, Ix1>::from_iter_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by PyArray::from_iter_bound in the future"
)]
pub fn from_iter<'py, I>(py: Python<'py>, iter: I) -> &'py Self
where
I: IntoIterator<Item = T>,
{
Self::from_iter_bound(py, iter).into_gil_ref()
}
/// Construct a one-dimensional array from an [`Iterator`].
///
/// If no reliable [`size_hint`][Iterator::size_hint] is available,
/// this method can allocate memory multiple times, which can hurt performance.
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::from_iter_bound(py, "abcde".chars().map(u32::from));
/// assert_eq!(pyarray.readonly().as_slice().unwrap(), &[97, 98, 99, 100, 101]);
/// });
/// ```
pub fn from_iter_bound<I>(py: Python<'_>, iter: I) -> Bound<'_, Self>
where
I: IntoIterator<Item = T>,
{
let data = iter.into_iter().collect::<Vec<_>>();
data.into_pyarray_bound(py)
}
}
impl<T: Element> PyArray<T, Ix2> {
/// Deprecated form of [`PyArray<T, Ix2>::from_vec2_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by `PyArray::from_vec2_bound` in the future"
)]
pub fn from_vec2<'py>(py: Python<'py>, v: &[Vec<T>]) -> Result<&'py Self, FromVecError> {
Self::from_vec2_bound(py, v).map(Bound::into_gil_ref)
}
/// Construct a two-dimension array from a [`Vec<Vec<T>>`][Vec].
///
/// This function checks all dimensions of the inner vectors and returns
/// an error if they are not all equal.
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
/// use ndarray::array;
///
/// Python::with_gil(|py| {
/// let vec2 = vec![vec![11, 12], vec![21, 22]];
/// let pyarray = PyArray::from_vec2_bound(py, &vec2).unwrap();
/// assert_eq!(pyarray.readonly().as_array(), array![[11, 12], [21, 22]]);
///
/// let ragged_vec2 = vec![vec![11, 12], vec![21]];
/// assert!(PyArray::from_vec2_bound(py, &ragged_vec2).is_err());
/// });
/// ```
pub fn from_vec2_bound<'py>(
py: Python<'py>,
v: &[Vec<T>],
) -> Result<Bound<'py, Self>, FromVecError> {
let len2 = v.first().map_or(0, |v| v.len());
let dims = [v.len(), len2];
// SAFETY: The result of `Self::new` is always safe to drop.
unsafe {
let array = Self::new_bound(py, dims, false);
let mut data_ptr = array.data();
for v in v {
if v.len() != len2 {
cold();
return Err(FromVecError::new(v.len(), len2));
}
clone_elements(v, &mut data_ptr);
}
Ok(array)
}
}
}
impl<T: Element> PyArray<T, Ix3> {
/// Deprecated form of [`PyArray<T, Ix3>::from_vec3_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by `PyArray::from_vec3_bound` in the future"
)]
pub fn from_vec3<'py>(py: Python<'py>, v: &[Vec<Vec<T>>]) -> Result<&'py Self, FromVecError> {
Self::from_vec3_bound(py, v).map(Bound::into_gil_ref)
}
/// Construct a three-dimensional array from a [`Vec<Vec<Vec<T>>>`][Vec].
///
/// This function checks all dimensions of the inner vectors and returns
/// an error if they are not all equal.
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
/// use ndarray::array;
///
/// Python::with_gil(|py| {
/// let vec3 = vec![
/// vec![vec![111, 112], vec![121, 122]],
/// vec![vec![211, 212], vec![221, 222]],
/// ];
/// let pyarray = PyArray::from_vec3_bound(py, &vec3).unwrap();
/// assert_eq!(
/// pyarray.readonly().as_array(),
/// array![[[111, 112], [121, 122]], [[211, 212], [221, 222]]]
/// );
///
/// let ragged_vec3 = vec![
/// vec![vec![111, 112], vec![121, 122]],
/// vec![vec![211], vec![221, 222]],
/// ];
/// assert!(PyArray::from_vec3_bound(py, &ragged_vec3).is_err());
/// });
/// ```
pub fn from_vec3_bound<'py>(
py: Python<'py>,
v: &[Vec<Vec<T>>],
) -> Result<Bound<'py, Self>, FromVecError> {
let len2 = v.first().map_or(0, |v| v.len());
let len3 = v.first().map_or(0, |v| v.first().map_or(0, |v| v.len()));
let dims = [v.len(), len2, len3];
// SAFETY: The result of `Self::new` is always safe to drop.
unsafe {
let array = Self::new_bound(py, dims, false);
let mut data_ptr = array.data();
for v in v {
if v.len() != len2 {
cold();
return Err(FromVecError::new(v.len(), len2));
}
for v in v {
if v.len() != len3 {
cold();
return Err(FromVecError::new(v.len(), len3));
}
clone_elements(v, &mut data_ptr);
}
}
Ok(array)
}
}
}
impl<T: Element, D> PyArray<T, D> {
/// Copies `self` into `other`, performing a data type conversion if necessary.
///
/// See also [`PyArray_CopyInto`][PyArray_CopyInto].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray_f = PyArray::arange_bound(py, 2.0, 5.0, 1.0);
/// let pyarray_i = unsafe { PyArray::<i64, _>::new_bound(py, [3], false) };
///
/// assert!(pyarray_f.copy_to(&pyarray_i).is_ok());
///
/// assert_eq!(pyarray_i.readonly().as_slice().unwrap(), &[2, 3, 4]);
/// });
/// ```
///
/// [PyArray_CopyInto]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_CopyInto
pub fn copy_to<U: Element>(&self, other: &PyArray<U, D>) -> PyResult<()> {
self.as_borrowed().copy_to(&other.as_borrowed())
}
/// Cast the `PyArray<T>` to `PyArray<U>`, by allocating a new array.
///
/// See also [`PyArray_CastToType`][PyArray_CastToType].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray_f = PyArray::arange_bound(py, 2.0, 5.0, 1.0);
///
/// let pyarray_i = pyarray_f.cast::<i32>(false).unwrap();
///
/// assert_eq!(pyarray_i.readonly().as_slice().unwrap(), &[2, 3, 4]);
/// });
/// ```
///
/// [PyArray_CastToType]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_CastToType
pub fn cast<'py, U: Element>(&'py self, is_fortran: bool) -> PyResult<&'py PyArray<U, D>> {
self.as_borrowed().cast(is_fortran).map(Bound::into_gil_ref)
}
/// A view of `self` with a different order of axes determined by `axes`.
///
/// If `axes` is `None`, the order of axes is reversed which corresponds to the standard matrix transpose.
///
/// See also [`numpy.transpose`][numpy-transpose] and [`PyArray_Transpose`][PyArray_Transpose].
///
/// # Example
///
/// ```
/// use numpy::prelude::*;
/// use numpy::PyArray;
/// use pyo3::Python;
/// use ndarray::array;
///
/// Python::with_gil(|py| {
/// let array = array![[0, 1, 2], [3, 4, 5]].into_pyarray(py);
///
/// let array = array.permute(Some([1, 0])).unwrap();
///
/// assert_eq!(array.readonly().as_array(), array![[0, 3], [1, 4], [2, 5]]);
/// });
/// ```
///
/// [numpy-transpose]: https://numpy.org/doc/stable/reference/generated/numpy.transpose.html
/// [PyArray_Transpose]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_Transpose
pub fn permute<'py, ID: IntoDimension>(
&'py self,
axes: Option<ID>,
) -> PyResult<&'py PyArray<T, D>> {
self.as_borrowed().permute(axes).map(Bound::into_gil_ref)
}
/// Special case of [`permute`][Self::permute] which reverses the order the axes.
pub fn transpose<'py>(&'py self) -> PyResult<&'py PyArray<T, D>> {
self.as_borrowed().transpose().map(Bound::into_gil_ref)
}
/// Construct a new array which has same values as self,
/// but has different dimensions specified by `shape`
/// and a possibly different memory order specified by `order`.
///
/// See also [`numpy.reshape`][numpy-reshape] and [`PyArray_Newshape`][PyArray_Newshape].
///
/// # Example
///
/// ```
/// use numpy::prelude::*;
/// use numpy::{npyffi::NPY_ORDER, PyArray};
/// use pyo3::Python;
/// use ndarray::array;
///
/// Python::with_gil(|py| {
/// let array =
/// PyArray::from_iter_bound(py, 0..9).reshape_with_order([3, 3], NPY_ORDER::NPY_FORTRANORDER).unwrap();
///
/// assert_eq!(array.readonly().as_array(), array![[0, 3, 6], [1, 4, 7], [2, 5, 8]]);
/// assert!(array.is_fortran_contiguous());
///
/// assert!(array.reshape([5]).is_err());
/// });
/// ```
///
/// [numpy-reshape]: https://numpy.org/doc/stable/reference/generated/numpy.reshape.html
/// [PyArray_Newshape]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_Newshape
pub fn reshape_with_order<'py, ID: IntoDimension>(
&'py self,
shape: ID,
order: NPY_ORDER,
) -> PyResult<&'py PyArray<T, ID::Dim>> {
self.as_borrowed()
.reshape_with_order(shape, order)
.map(Bound::into_gil_ref)
}
/// Special case of [`reshape_with_order`][Self::reshape_with_order] which keeps the memory order the same.
#[inline(always)]
pub fn reshape<'py, ID: IntoDimension>(
&'py self,
shape: ID,
) -> PyResult<&'py PyArray<T, ID::Dim>> {
self.as_borrowed().reshape(shape).map(Bound::into_gil_ref)
}
/// Extends or truncates the dimensions of an array.
///
/// This method works only on [contiguous][PyUntypedArray::is_contiguous] arrays.
/// Missing elements will be initialized as if calling [`zeros`][Self::zeros].
///
/// See also [`ndarray.resize`][ndarray-resize] and [`PyArray_Resize`][PyArray_Resize].
///
/// # Safety
///
/// There should be no outstanding references (shared or exclusive) into the array
/// as this method might re-allocate it and thereby invalidate all pointers into it.
///
/// # Example
///
/// ```
/// use numpy::prelude::*;
/// use numpy::PyArray;
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::<f64, _>::zeros_bound(py, (10, 10), false);
/// assert_eq!(pyarray.shape(), [10, 10]);
///
/// unsafe {
/// pyarray.resize((100, 100)).unwrap();
/// }
/// assert_eq!(pyarray.shape(), [100, 100]);
/// });
/// ```
///
/// [ndarray-resize]: https://numpy.org/doc/stable/reference/generated/numpy.ndarray.resize.html
/// [PyArray_Resize]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_Resize
pub unsafe fn resize<ID: IntoDimension>(&self, newshape: ID) -> PyResult<()> {
self.as_borrowed().resize(newshape)
}
}
impl<T: Element + AsPrimitive<f64>> PyArray<T, Ix1> {
/// Deprecated form of [`PyArray<T, Ix1>::arange_bound`]
#[deprecated(
since = "0.21.0",
note = "will be replaced by PyArray::arange_bound in the future"
)]
pub fn arange<'py>(py: Python<'py>, start: T, stop: T, step: T) -> &Self {
Self::arange_bound(py, start, stop, step).into_gil_ref()
}
/// Return evenly spaced values within a given interval.
///
/// See [numpy.arange][numpy.arange] for the Python API and [PyArray_Arange][PyArray_Arange] for the C API.
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 2.0, 4.0, 0.5);
/// assert_eq!(pyarray.readonly().as_slice().unwrap(), &[2.0, 2.5, 3.0, 3.5]);
///
/// let pyarray = PyArray::arange_bound(py, -2, 4, 3);
/// assert_eq!(pyarray.readonly().as_slice().unwrap(), &[-2, 1]);
/// });
/// ```
///
/// [numpy.arange]: https://numpy.org/doc/stable/reference/generated/numpy.arange.html
/// [PyArray_Arange]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_Arange
pub fn arange_bound<'py>(py: Python<'py>, start: T, stop: T, step: T) -> Bound<'py, Self> {
unsafe {
let ptr = PY_ARRAY_API.PyArray_Arange(
py,
start.as_(),
stop.as_(),
step.as_(),
T::get_dtype_bound(py).num(),
);
Bound::from_owned_ptr(py, ptr).downcast_into_unchecked()
}
}
}
unsafe fn clone_elements<T: Element>(elems: &[T], data_ptr: &mut *mut T) {
if T::IS_COPY {
ptr::copy_nonoverlapping(elems.as_ptr(), *data_ptr, elems.len());
*data_ptr = data_ptr.add(elems.len());
} else {
for elem in elems {
data_ptr.write(elem.clone());
*data_ptr = data_ptr.add(1);
}
}
}
/// Implementation of functionality for [`PyArray<T, D>`].
#[doc(alias = "PyArray")]
pub trait PyArrayMethods<'py, T, D>: PyUntypedArrayMethods<'py> {
/// Access an untyped representation of this array.
fn as_untyped(&self) -> &Bound<'py, PyUntypedArray>;
/// Returns a pointer to the first element of the array.
fn data(&self) -> *mut T;
/// Same as [`shape`][PyUntypedArray::shape], but returns `D` instead of `&[usize]`.
#[inline(always)]
fn dims(&self) -> D
where
D: Dimension,
{
D::from_dimension(&Dim(self.shape())).expect(DIMENSIONALITY_MISMATCH_ERR)
}
/// Returns an immutable view of the internal data as a slice.
///
/// # Safety
///
/// Calling this method is undefined behaviour if the underlying array
/// is aliased mutably by other instances of `PyArray`
/// or concurrently modified by Python or other native code.
///
/// Please consider the safe alternative [`PyReadonlyArray::as_slice`].
unsafe fn as_slice(&self) -> Result<&[T], NotContiguousError>
where
T: Element,
D: Dimension,
{
if self.is_contiguous() {
Ok(slice::from_raw_parts(self.data(), self.len()))
} else {
Err(NotContiguousError)
}
}
/// Returns a mutable view of the internal data as a slice.
///
/// # Safety
///
/// Calling this method is undefined behaviour if the underlying array
/// is aliased immutably or mutably by other instances of [`PyArray`]
/// or concurrently modified by Python or other native code.
///
/// Please consider the safe alternative [`PyReadwriteArray::as_slice_mut`].
unsafe fn as_slice_mut(&self) -> Result<&mut [T], NotContiguousError>
where
T: Element,
D: Dimension,
{
if self.is_contiguous() {
Ok(slice::from_raw_parts_mut(self.data(), self.len()))
} else {
Err(NotContiguousError)
}
}
/// Get a reference of the specified element if the given index is valid.
///
/// # Safety
///
/// Calling this method is undefined behaviour if the underlying array
/// is aliased mutably by other instances of `PyArray`
/// or concurrently modified by Python or other native code.
///
/// Consider using safe alternatives like [`PyReadonlyArray::get`].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0, 16, 1).reshape([2, 2, 4]).unwrap();
///
/// assert_eq!(unsafe { *pyarray.get([1, 0, 3]).unwrap() }, 11);
/// });
/// ```
unsafe fn get(&self, index: impl NpyIndex<Dim = D>) -> Option<&T>
where
T: Element,
D: Dimension;
/// Same as [`get`][Self::get], but returns `Option<&mut T>`.
///
/// # Safety
///
/// Calling this method is undefined behaviour if the underlying array
/// is aliased immutably or mutably by other instances of [`PyArray`]
/// or concurrently modified by Python or other native code.
///
/// Consider using safe alternatives like [`PyReadwriteArray::get_mut`].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0, 16, 1).reshape([2, 2, 4]).unwrap();
///
/// unsafe {
/// *pyarray.get_mut([1, 0, 3]).unwrap() = 42;
/// }
///
/// assert_eq!(unsafe { *pyarray.get([1, 0, 3]).unwrap() }, 42);
/// });
/// ```
unsafe fn get_mut(&self, index: impl NpyIndex<Dim = D>) -> Option<&mut T>
where
T: Element,
D: Dimension;
/// Get an immutable reference of the specified element,
/// without checking the given index.
///
/// See [`NpyIndex`] for what types can be used as the index.
///
/// # Safety
///
/// Passing an invalid index is undefined behavior.
/// The element must also have been initialized and
/// all other references to it is must also be shared.
///
/// See [`PyReadonlyArray::get`] for a safe alternative.
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0, 16, 1).reshape([2, 2, 4]).unwrap();
///
/// assert_eq!(unsafe { *pyarray.uget([1, 0, 3]) }, 11);
/// });
/// ```
#[inline(always)]
unsafe fn uget<Idx>(&self, index: Idx) -> &T
where
T: Element,
D: Dimension,
Idx: NpyIndex<Dim = D>,
{
&*self.uget_raw(index)
}
/// Same as [`uget`](Self::uget), but returns `&mut T`.
///
/// # Safety
///
/// Passing an invalid index is undefined behavior.
/// The element must also have been initialized and
/// other references to it must not exist.
///
/// See [`PyReadwriteArray::get_mut`] for a safe alternative.
#[inline(always)]
#[allow(clippy::mut_from_ref)]
unsafe fn uget_mut<Idx>(&self, index: Idx) -> &mut T
where
T: Element,
D: Dimension,
Idx: NpyIndex<Dim = D>,
{
&mut *self.uget_raw(index)
}
/// Same as [`uget`][Self::uget], but returns `*mut T`.
///
/// # Safety
///
/// Passing an invalid index is undefined behavior.
#[inline(always)]
unsafe fn uget_raw<Idx>(&self, index: Idx) -> *mut T
where
T: Element,
D: Dimension,
Idx: NpyIndex<Dim = D>,
{
let offset = index.get_unchecked::<T>(self.strides());
self.data().offset(offset) as *mut _
}
/// Get a copy of the specified element in the array.
///
/// See [`NpyIndex`] for what types can be used as the index.
///
/// # Example
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0, 16, 1).reshape([2, 2, 4]).unwrap();
///
/// assert_eq!(pyarray.get_owned([1, 0, 3]), Some(11));
/// });
/// ```
fn get_owned<Idx>(&self, index: Idx) -> Option<T>
where
T: Element,
D: Dimension,
Idx: NpyIndex<Dim = D>,
{
unsafe { self.get(index) }.cloned()
}
/// Turn an array with fixed dimensionality into one with dynamic dimensionality.
fn to_dyn(&self) -> &Bound<'py, PyArray<T, IxDyn>>
where
T: Element,
D: Dimension;
/// Returns a copy of the internal data of the array as a [`Vec`].
///
/// Fails if the internal array is not contiguous. See also [`as_slice`][Self::as_slice].
///
/// # Example
///
/// ```
/// use numpy::{PyArray2, PyArrayMethods};
/// use pyo3::{Python, types::PyAnyMethods};
///
/// Python::with_gil(|py| {
/// let pyarray= py
/// .eval_bound("__import__('numpy').array([[0, 1], [2, 3]], dtype='int64')", None, None)
/// .unwrap()
/// .downcast_into::<PyArray2<i64>>()
/// .unwrap();
///
/// assert_eq!(pyarray.to_vec().unwrap(), vec![0, 1, 2, 3]);
/// });
/// ```
fn to_vec(&self) -> Result<Vec<T>, NotContiguousError>
where
T: Element,
D: Dimension,
{
unsafe { self.as_slice() }.map(ToOwned::to_owned)
}
/// Get an immutable borrow of the NumPy array
fn try_readonly(&self) -> Result<PyReadonlyArray<'py, T, D>, BorrowError>
where
T: Element,
D: Dimension;
/// Get an immutable borrow of the NumPy array
///
/// # Panics
///
/// Panics if the allocation backing the array is currently mutably borrowed.
///
/// For a non-panicking variant, use [`try_readonly`][Self::try_readonly].
fn readonly(&self) -> PyReadonlyArray<'py, T, D>
where
T: Element,
D: Dimension,
{
self.try_readonly().unwrap()
}
/// Get a mutable borrow of the NumPy array
fn try_readwrite(&self) -> Result<PyReadwriteArray<'py, T, D>, BorrowError>
where
T: Element,
D: Dimension;
/// Get a mutable borrow of the NumPy array
///
/// # Panics
///
/// Panics if the allocation backing the array is currently borrowed or
/// if the array is [flagged as][flags] not writeable.
///
/// For a non-panicking variant, use [`try_readwrite`][Self::try_readwrite].
///
/// [flags]: https://numpy.org/doc/stable/reference/generated/numpy.ndarray.flags.html
fn readwrite(&self) -> PyReadwriteArray<'py, T, D>
where
T: Element,
D: Dimension,
{
self.try_readwrite().unwrap()
}
/// Returns an [`ArrayView`] of the internal array.
///
/// See also [`PyReadonlyArray::as_array`].
///
/// # Safety
///
/// Calling this method invalidates all exclusive references to the internal data, e.g. `&mut [T]` or `ArrayViewMut`.
unsafe fn as_array(&self) -> ArrayView<'_, T, D>
where
T: Element,
D: Dimension;
/// Returns an [`ArrayViewMut`] of the internal array.
///
/// See also [`PyReadwriteArray::as_array_mut`].
///
/// # Safety
///
/// Calling this method invalidates all other references to the internal data, e.g. `ArrayView` or `ArrayViewMut`.
unsafe fn as_array_mut(&self) -> ArrayViewMut<'_, T, D>
where
T: Element,
D: Dimension;
/// Returns the internal array as [`RawArrayView`] enabling element access via raw pointers
fn as_raw_array(&self) -> RawArrayView<T, D>
where
T: Element,
D: Dimension;
/// Returns the internal array as [`RawArrayViewMut`] enabling element access via raw pointers
fn as_raw_array_mut(&self) -> RawArrayViewMut<T, D>
where
T: Element,
D: Dimension;
/// Get a copy of the array as an [`ndarray::Array`].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use ndarray::array;
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::arange_bound(py, 0, 4, 1).reshape([2, 2]).unwrap();
///
/// assert_eq!(
/// pyarray.to_owned_array(),
/// array![[0, 1], [2, 3]]
/// )
/// });
/// ```
fn to_owned_array(&self) -> Array<T, D>
where
T: Element,
D: Dimension,
{
unsafe { self.as_array() }.to_owned()
}
/// Copies `self` into `other`, performing a data type conversion if necessary.
///
/// See also [`PyArray_CopyInto`][PyArray_CopyInto].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray_f = PyArray::arange_bound(py, 2.0, 5.0, 1.0);
/// let pyarray_i = unsafe { PyArray::<i64, _>::new_bound(py, [3], false) };
///
/// assert!(pyarray_f.copy_to(&pyarray_i).is_ok());
///
/// assert_eq!(pyarray_i.readonly().as_slice().unwrap(), &[2, 3, 4]);
/// });
/// ```
///
/// [PyArray_CopyInto]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_CopyInto
fn copy_to<U: Element>(&self, other: &Bound<'py, PyArray<U, D>>) -> PyResult<()>
where
T: Element;
/// Cast the `PyArray<T>` to `PyArray<U>`, by allocating a new array.
///
/// See also [`PyArray_CastToType`][PyArray_CastToType].
///
/// # Example
///
/// ```
/// use numpy::{PyArray, PyArrayMethods};
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray_f = PyArray::arange_bound(py, 2.0, 5.0, 1.0);
///
/// let pyarray_i = pyarray_f.cast::<i32>(false).unwrap();
///
/// assert_eq!(pyarray_i.readonly().as_slice().unwrap(), &[2, 3, 4]);
/// });
/// ```
///
/// [PyArray_CastToType]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_CastToType
fn cast<U: Element>(&self, is_fortran: bool) -> PyResult<Bound<'py, PyArray<U, D>>>
where
T: Element;
/// A view of `self` with a different order of axes determined by `axes`.
///
/// If `axes` is `None`, the order of axes is reversed which corresponds to the standard matrix transpose.
///
/// See also [`numpy.transpose`][numpy-transpose] and [`PyArray_Transpose`][PyArray_Transpose].
///
/// # Example
///
/// ```
/// use numpy::prelude::*;
/// use numpy::PyArray;
/// use pyo3::Python;
/// use ndarray::array;
///
/// Python::with_gil(|py| {
/// let array = array![[0, 1, 2], [3, 4, 5]].into_pyarray_bound(py);
///
/// let array = array.permute(Some([1, 0])).unwrap();
///
/// assert_eq!(array.readonly().as_array(), array![[0, 3], [1, 4], [2, 5]]);
/// });
/// ```
///
/// [numpy-transpose]: https://numpy.org/doc/stable/reference/generated/numpy.transpose.html
/// [PyArray_Transpose]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_Transpose
fn permute<ID: IntoDimension>(&self, axes: Option<ID>) -> PyResult<Bound<'py, PyArray<T, D>>>
where
T: Element;
/// Special case of [`permute`][Self::permute] which reverses the order the axes.
fn transpose(&self) -> PyResult<Bound<'py, PyArray<T, D>>>
where
T: Element,
{
self.permute::<()>(None)
}
/// Construct a new array which has same values as `self`,
/// but has different dimensions specified by `shape`
/// and a possibly different memory order specified by `order`.
///
/// See also [`numpy.reshape`][numpy-reshape] and [`PyArray_Newshape`][PyArray_Newshape].
///
/// # Example
///
/// ```
/// use numpy::prelude::*;
/// use numpy::{npyffi::NPY_ORDER, PyArray};
/// use pyo3::Python;
/// use ndarray::array;
///
/// Python::with_gil(|py| {
/// let array =
/// PyArray::from_iter_bound(py, 0..9).reshape_with_order([3, 3], NPY_ORDER::NPY_FORTRANORDER).unwrap();
///
/// assert_eq!(array.readonly().as_array(), array![[0, 3, 6], [1, 4, 7], [2, 5, 8]]);
/// assert!(array.is_fortran_contiguous());
///
/// assert!(array.reshape([5]).is_err());
/// });
/// ```
///
/// [numpy-reshape]: https://numpy.org/doc/stable/reference/generated/numpy.reshape.html
/// [PyArray_Newshape]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_Newshape
fn reshape_with_order<ID: IntoDimension>(
&self,
shape: ID,
order: NPY_ORDER,
) -> PyResult<Bound<'py, PyArray<T, ID::Dim>>>
where
T: Element;
/// Special case of [`reshape_with_order`][Self::reshape_with_order] which keeps the memory order the same.
#[inline(always)]
fn reshape<ID: IntoDimension>(&self, shape: ID) -> PyResult<Bound<'py, PyArray<T, ID::Dim>>>
where
T: Element,
{
self.reshape_with_order(shape, NPY_ORDER::NPY_ANYORDER)
}
/// Extends or truncates the dimensions of an array.
///
/// This method works only on [contiguous][PyUntypedArrayMethods::is_contiguous] arrays.
/// Missing elements will be initialized as if calling [`zeros`][PyArray::zeros_bound].
///
/// See also [`ndarray.resize`][ndarray-resize] and [`PyArray_Resize`][PyArray_Resize].
///
/// # Safety
///
/// There should be no outstanding references (shared or exclusive) into the array
/// as this method might re-allocate it and thereby invalidate all pointers into it.
///
/// # Example
///
/// ```
/// use numpy::prelude::*;
/// use numpy::PyArray;
/// use pyo3::Python;
///
/// Python::with_gil(|py| {
/// let pyarray = PyArray::<f64, _>::zeros_bound(py, (10, 10), false);
/// assert_eq!(pyarray.shape(), [10, 10]);
///
/// unsafe {
/// pyarray.resize((100, 100)).unwrap();
/// }
/// assert_eq!(pyarray.shape(), [100, 100]);
/// });
/// ```
///
/// [ndarray-resize]: https://numpy.org/doc/stable/reference/generated/numpy.ndarray.resize.html
/// [PyArray_Resize]: https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_Resize
unsafe fn resize<ID: IntoDimension>(&self, newshape: ID) -> PyResult<()>
where
T: Element;
/// Try to convert this array into a [`nalgebra::MatrixView`] using the given shape and strides.
///
/// # Safety
///
/// Calling this method invalidates all exclusive references to the internal data, e.g. `ArrayViewMut` or `MatrixSliceMut`.
#[doc(alias = "nalgebra")]
#[cfg(feature = "nalgebra")]
unsafe fn try_as_matrix<R, C, RStride, CStride>(
&self,
) -> Option<nalgebra::MatrixView<'_, T, R, C, RStride, CStride>>
where
T: nalgebra::Scalar + Element,
D: Dimension,
R: nalgebra::Dim,
C: nalgebra::Dim,
RStride: nalgebra::Dim,
CStride: nalgebra::Dim;
/// Try to convert this array into a [`nalgebra::MatrixViewMut`] using the given shape and strides.
///
/// # Safety
///
/// Calling this method invalidates all other references to the internal data, e.g. `ArrayView`, `MatrixSlice`, `ArrayViewMut` or `MatrixSliceMut`.
#[doc(alias = "nalgebra")]
#[cfg(feature = "nalgebra")]
unsafe fn try_as_matrix_mut<R, C, RStride, CStride>(
&self,
) -> Option<nalgebra::MatrixViewMut<'_, T, R, C, RStride, CStride>>
where
T: nalgebra::Scalar + Element,
D: Dimension,
R: nalgebra::Dim,
C: nalgebra::Dim,
RStride: nalgebra::Dim,
CStride: nalgebra::Dim;
}
/// Implementation of functionality for [`PyArray0<T>`].
#[doc(alias = "PyArray", alias = "PyArray0")]
pub trait PyArray0Methods<'py, T>: PyArrayMethods<'py, T, Ix0> {
/// Get the single element of a zero-dimensional array.
///
/// See [`inner`][crate::inner] for an example.
fn item(&self) -> T
where
T: Element + Copy,
{
unsafe { *self.data() }
}
}
#[inline(always)]
fn get_raw<T, D, Idx>(slf: &Bound<'_, PyArray<T, D>>, index: Idx) -> Option<*mut T>
where
T: Element,
D: Dimension,
Idx: NpyIndex<Dim = D>,
{
let offset = index.get_checked::<T>(slf.shape(), slf.strides())?;
Some(unsafe { slf.data().offset(offset) })
}
fn as_view<T, D, S, F>(slf: &Bound<'_, PyArray<T, D>>, from_shape_ptr: F) -> ArrayBase<S, D>
where
T: Element,
D: Dimension,
S: RawData,
F: FnOnce(StrideShape<D>, *mut T) -> ArrayBase<S, D>,
{
fn inner<D: Dimension>(
shape: &[usize],
strides: &[isize],
itemsize: usize,
mut data_ptr: *mut u8,
) -> (StrideShape<D>, u32, *mut u8) {
let shape = D::from_dimension(&Dim(shape)).expect(DIMENSIONALITY_MISMATCH_ERR);
assert!(strides.len() <= 32, "{}", MAX_DIMENSIONALITY_ERR);
let mut new_strides = D::zeros(strides.len());
let mut inverted_axes = 0_u32;
for i in 0..strides.len() {
// FIXME(kngwyu): Replace this hacky negative strides support with
// a proper constructor, when it's implemented.
// See https://github.com/rust-ndarray/ndarray/issues/842 for more.
if strides[i] >= 0 {
new_strides[i] = strides[i] as usize / itemsize;
} else {
// Move the pointer to the start position.
data_ptr = unsafe { data_ptr.offset(strides[i] * (shape[i] as isize - 1)) };
new_strides[i] = (-strides[i]) as usize / itemsize;
inverted_axes |= 1 << i;
}
}
(shape.strides(new_strides), inverted_axes, data_ptr)
}
let (shape, mut inverted_axes, data_ptr) = inner(
slf.shape(),
slf.strides(),
mem::size_of::<T>(),
slf.data() as _,
);
let mut array = from_shape_ptr(shape, data_ptr as _);
while inverted_axes != 0 {
let axis = inverted_axes.trailing_zeros() as usize;
inverted_axes &= !(1 << axis);
array.invert_axis(Axis(axis));
}
array
}
#[cfg(feature = "nalgebra")]
fn try_as_matrix_shape_strides<N, D, R, C, RStride, CStride>(
slf: &Bound<'_, PyArray<N, D>>,
) -> Option<((R, C), (RStride, CStride))>
where
N: nalgebra::Scalar + Element,
D: Dimension,
R: nalgebra::Dim,
C: nalgebra::Dim,
RStride: nalgebra::Dim,
CStride: nalgebra::Dim,
{
let ndim = slf.ndim();
let shape = slf.shape();
let strides = slf.strides();
if ndim != 1 && ndim != 2 {
return None;
}
if strides.iter().any(|strides| *strides < 0) {
return None;
}
let rows = shape[0];
let cols = *shape.get(1).unwrap_or(&1);
if R::try_to_usize().map(|expected| rows == expected) == Some(false) {
return None;
}
if C::try_to_usize().map(|expected| cols == expected) == Some(false) {
return None;
}
let row_stride = strides[0] as usize / mem::size_of::<N>();
let col_stride = strides
.get(1)
.map_or(rows, |stride| *stride as usize / mem::size_of::<N>());
if RStride::try_to_usize().map(|expected| row_stride == expected) == Some(false) {
return None;
}
if CStride::try_to_usize().map(|expected| col_stride == expected) == Some(false) {
return None;
}
let shape = (R::from_usize(rows), C::from_usize(cols));
let strides = (
RStride::from_usize(row_stride),
CStride::from_usize(col_stride),
);
Some((shape, strides))
}
impl<'py, T, D> PyArrayMethods<'py, T, D> for Bound<'py, PyArray<T, D>> {
#[inline(always)]
fn as_untyped(&self) -> &Bound<'py, PyUntypedArray> {
unsafe { self.downcast_unchecked() }
}
#[inline(always)]
fn data(&self) -> *mut T {
unsafe { (*self.as_array_ptr()).data.cast() }
}
#[inline(always)]
unsafe fn get(&self, index: impl NpyIndex<Dim = D>) -> Option<&T>
where
T: Element,
D: Dimension,
{
let ptr = get_raw(self, index)?;
Some(&*ptr)
}
#[inline(always)]
unsafe fn get_mut(&self, index: impl NpyIndex<Dim = D>) -> Option<&mut T>
where
T: Element,
D: Dimension,
{
let ptr = get_raw(self, index)?;
Some(&mut *ptr)
}
fn to_dyn(&self) -> &Bound<'py, PyArray<T, IxDyn>> {
unsafe { self.downcast_unchecked() }
}
fn try_readonly(&self) -> Result<PyReadonlyArray<'py, T, D>, BorrowError>
where
T: Element,
D: Dimension,
{
PyReadonlyArray::try_new(self.clone())
}
fn try_readwrite(&self) -> Result<PyReadwriteArray<'py, T, D>, BorrowError>
where
T: Element,
D: Dimension,
{
PyReadwriteArray::try_new(self.clone())
}
unsafe fn as_array(&self) -> ArrayView<'_, T, D>
where
T: Element,
D: Dimension,
{
as_view(self, |shape, ptr| ArrayView::from_shape_ptr(shape, ptr))
}
unsafe fn as_array_mut(&self) -> ArrayViewMut<'_, T, D>
where
T: Element,
D: Dimension,
{
as_view(self, |shape, ptr| ArrayViewMut::from_shape_ptr(shape, ptr))
}
fn as_raw_array(&self) -> RawArrayView<T, D>
where
T: Element,
D: Dimension,
{
as_view(self, |shape, ptr| unsafe {
RawArrayView::from_shape_ptr(shape, ptr)
})
}
fn as_raw_array_mut(&self) -> RawArrayViewMut<T, D>
where
T: Element,
D: Dimension,
{
as_view(self, |shape, ptr| unsafe {
RawArrayViewMut::from_shape_ptr(shape, ptr)
})
}
fn copy_to<U: Element>(&self, other: &Bound<'py, PyArray<U, D>>) -> PyResult<()>
where
T: Element,
{
let self_ptr = self.as_array_ptr();
let other_ptr = other.as_array_ptr();
let result = unsafe { PY_ARRAY_API.PyArray_CopyInto(self.py(), other_ptr, self_ptr) };
if result != -1 {
Ok(())
} else {
Err(PyErr::fetch(self.py()))
}
}
fn cast<U: Element>(&self, is_fortran: bool) -> PyResult<Bound<'py, PyArray<U, D>>>
where
T: Element,
{
let ptr = unsafe {
PY_ARRAY_API.PyArray_CastToType(
self.py(),
self.as_array_ptr(),
U::get_dtype_bound(self.py()).into_dtype_ptr(),
if is_fortran { -1 } else { 0 },
)
};
unsafe {
Bound::from_owned_ptr_or_err(self.py(), ptr).map(|ob| ob.downcast_into_unchecked())
}
}
fn permute<ID: IntoDimension>(&self, axes: Option<ID>) -> PyResult<Bound<'py, PyArray<T, D>>> {
let mut axes = axes.map(|axes| axes.into_dimension());
let mut axes = axes.as_mut().map(|axes| axes.to_npy_dims());
let axes = axes
.as_mut()
.map_or_else(ptr::null_mut, |axes| axes as *mut npyffi::PyArray_Dims);
let py = self.py();
let ptr = unsafe { PY_ARRAY_API.PyArray_Transpose(py, self.as_array_ptr(), axes) };
unsafe { Bound::from_owned_ptr_or_err(py, ptr).map(|ob| ob.downcast_into_unchecked()) }
}
fn reshape_with_order<ID: IntoDimension>(
&self,
shape: ID,
order: NPY_ORDER,
) -> PyResult<Bound<'py, PyArray<T, ID::Dim>>>
where
T: Element,
{
let mut shape = shape.into_dimension();
let mut shape = shape.to_npy_dims();
let py = self.py();
let ptr = unsafe {
PY_ARRAY_API.PyArray_Newshape(
py,
self.as_array_ptr(),
&mut shape as *mut npyffi::PyArray_Dims,
order,
)
};
unsafe { Bound::from_owned_ptr_or_err(py, ptr).map(|ob| ob.downcast_into_unchecked()) }
}
unsafe fn resize<ID: IntoDimension>(&self, newshape: ID) -> PyResult<()>
where
T: Element,
{
let mut newshape = newshape.into_dimension();
let mut newshape = newshape.to_npy_dims();
let py = self.py();
let res = PY_ARRAY_API.PyArray_Resize(
py,
self.as_array_ptr(),
&mut newshape as *mut npyffi::PyArray_Dims,
1,
NPY_ORDER::NPY_ANYORDER,
);
if !res.is_null() {
Ok(())
} else {
Err(PyErr::fetch(py))
}
}
#[cfg(feature = "nalgebra")]
unsafe fn try_as_matrix<R, C, RStride, CStride>(
&self,
) -> Option<nalgebra::MatrixView<'_, T, R, C, RStride, CStride>>
where
T: nalgebra::Scalar + Element,
D: Dimension,
R: nalgebra::Dim,
C: nalgebra::Dim,
RStride: nalgebra::Dim,
CStride: nalgebra::Dim,
{
let (shape, strides) = try_as_matrix_shape_strides(self)?;
let storage = nalgebra::ViewStorage::from_raw_parts(self.data(), shape, strides);
Some(nalgebra::Matrix::from_data(storage))
}
#[cfg(feature = "nalgebra")]
unsafe fn try_as_matrix_mut<R, C, RStride, CStride>(
&self,
) -> Option<nalgebra::MatrixViewMut<'_, T, R, C, RStride, CStride>>
where
T: nalgebra::Scalar + Element,
D: Dimension,
R: nalgebra::Dim,
C: nalgebra::Dim,
RStride: nalgebra::Dim,
CStride: nalgebra::Dim,
{
let (shape, strides) = try_as_matrix_shape_strides(self)?;
let storage = nalgebra::ViewStorageMut::from_raw_parts(self.data(), shape, strides);
Some(nalgebra::Matrix::from_data(storage))
}
}
impl<'py, T> PyArray0Methods<'py, T> for Bound<'py, PyArray0<T>> {}
#[cfg(test)]
mod tests {
use super::*;
use ndarray::array;
use pyo3::{py_run, types::PyList};
#[test]
fn test_dyn_to_owned_array() {
Python::with_gil(|py| {
let array = PyArray::from_vec2_bound(py, &[vec![1, 2], vec![3, 4]])
.unwrap()
.to_dyn()
.to_owned_array();
assert_eq!(array, array![[1, 2], [3, 4]].into_dyn());
});
}
#[test]
fn test_hasobject_flag() {
Python::with_gil(|py| {
let array: Bound<'_, PyArray<PyObject, _>> =
PyArray1::from_slice_bound(py, &[PyList::empty_bound(py).into()]);
py_run!(py, array, "assert array.dtype.hasobject");
});
}
}