/usr/share/doc/libarmadillo4/docs.html is in libarmadillo4 1:4.200.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type">
<title>Armadillo: API Reference</title>
<link rel="icon" href="armadillo_icon.png" type="image/png">
<style type="text/css">
<!--
body
{
font-family: "Trebuchet MS", "Droid Sans", sans-serif;
color: #000000;
background-color: #FFFFFF;
/* font-size: 10pt; */
/* line-height: 120%; */
height: 110%;
}
pre
{
font-family: "DejaVu Sans Mono", "Liberation Mono", "Andale Mono", "Bitstream Vera Sans Mono", "Luxi Mono", monospace;
font-size: smaller;
color: #666666;
}
a
{
text-decoration: none;
color: #498c05;
}
a:hover
{
text-decoration: underline;
color: #498c05;
}
a.menu
{
text-decoration: none;
color: #CCCCCC;
}
a.menu:hover
{
text-decoration: none;
color: #498c05;
}
a.hidden, a.hidden:hover, a.hidden:active, a.hidden:link, a.hidden:visited
{
text-decoration: none;
border-bottom: 0px
}
table
{
/* border: 1px solid #000; */
/* display: block; */
border-collapse: collapse;
}
td.line
{
border-left: 2px solid rgb(204, 204, 204);
}
.footertext
{
position: relative;
bottom: 0px;
}
hr.greyline
{
color: rgb(204, 204, 204);
/* background-color: rgb(204, 204, 204); */
}
#nobreak
{
white-space: nowrap;
}
.noindent
{
text-indent: 0px;
margin-left: 1ex;
margin-right: 0ex;
margin-top: 0ex;
margin-bottom: 0ex;
padding-left: 1ex;
padding-right: 0ex;
padding-top: 0ex;
padding-bottom: 0ex;
list-style: disc;
}
-->
</style>
</head>
<body>
<a name="top"></a>
<a style="display:scroll; position:fixed; bottom:5px; right:5px;" href="#top"><font size=-1>[top]</font></a>
<center>
<table style="text-align: left; width: 80%; margin-left: auto; margin-right: auto;" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td style="vertical-align: top;">
<table style="text-align: left; width: 100%;" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td style="text-align: left; vertical-align: top;">
<font size=+2><b>Reference for Armadillo 4.200</b></font>
<br>
</td>
<td style="text-align: right; vertical-align: top;">
<b><a href="http://arma.sourceforge.net">to Armadillo home page</a></b>
<br>
<b><a href="http://nicta.com.au">to NICTA home page</a></b>
<br>
</td>
</tr>
</tbody>
</table>
<hr>
<br>
<br>
<!-- BEGIN CONTENT -->
<b>Preamble</b>
<br>
<br>
<table border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td style="text-align: left; vertical-align: top; width: 50%;">
<ul>
<li>
To aid the conversion of Matlab/Octave programs,
see the <a href="#syntax">syntax conversion table</a>
</li>
<br>
<li>
First time users may want to have a look at a short <a href="#example_prog">example program</a>
</li>
<br>
<li>
If you discover any bugs or regressions, please <a href="http://arma.sourceforge.net/faq.html">report them</a>
</li>
<br>
<li>
Notes on <a href="#api_additions">API additions</a>
</li>
</ul>
</td>
<td>
</td>
<td class="line" style="vertical-align: top;">
<br>
</td>
<td style="text-align: left; vertical-align: top; width: 45%;">
<ul>
<li>
Please cite the following tech report if you use Armadillo in your research and/or software.
Citations are useful for the continued development and maintenance of the library.
<br>
<br>
<font size=-1>
Conrad Sanderson.
<br>
<i><a href="armadillo_nicta_2010.pdf">Armadillo: An Open Source C++ Linear Algebra Library for Fast Prototyping and Computationally Intensive Experiments</a></i>.
<br>
Technical Report, NICTA, 2010.
</font>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<br>
<br>
<b>Matrix, Vector, Cube and Field Classes</b>
<ul>
<a href="#Mat">Mat<<i>type</i>>, mat and cx_mat</a> ·
<a href="#Col">Col<<i>type</i>>, colvec and vec</a> ·
<a href="#Row">Row<<i>type</i>>, rowvec</a> ·
<a href="#Cube">Cube<<i>type</i>>, cube</a> ·
<a href="#field">field<<i>object type</i>></a> ·
<a href="#SpMat">SpMat<<i>type</i>>, sp_mat and sp_cx_mat</a>
</ul>
<br>
<b>Member Functions & Variables</b>
<ul>
<a href="#attributes">attributes</a> ·
<a href="#colptr">colptr</a> ·
<a href="#copy_size">copy_size</a> ·
<a href="#diag">diag</a> ·
<a href="#each_colrow">each_col/each_row</a> ·
<a href="#element_access">element access</a> ·
<a href="#element_initialisation">element initialisation</a> ·
<a href="#eval_member">eval</a> ·
<a href="#eye_member">eye</a> ·
<a href="#fill">fill</a> ·
<a href="#i_member">i (inverse)</a> ·
<a href="#imbue">imbue</a> ·
<a href="#insert">insert_rows/cols/slices</a> ·
<a href="#in_range">in_range</a> ·
<a href="#is_empty">is_empty</a> ·
<a href="#is_finite">is_finite</a> ·
<a href="#is_square">is_square</a> ·
<a href="#is_vec">is_vec</a> ·
<a href="#iterators_mat">iterators (matrices)</a> ·
<a href="#iterators_cube">iterators (cubes)</a> ·
<a href="#memptr">memptr</a> ·
<a href="#min_and_max_member">min/max</a> ·
<a href="#ones_member">ones</a> ·
<a href="#operators">operators</a> ·
<a href="#print">print</a> ·
<a href="#raw_print">raw_print</a> ·
<a href="#randi">randi</a> ·
<a href="#randu_randn_member">randu/randn</a> ·
<a href="#reset">reset</a> ·
<a href="#reshape_member">reshape</a> ·
<a href="#resize_member">resize</a> ·
<a href="#save_load_mat">save/load (matrices & cubes)</a> ·
<a href="#save_load_field">save/load (fields)</a> ·
<a href="#set_imag">set_imag/real</a> ·
<a href="#set_size">set_size</a> ·
<a href="#shed">shed_rows/cols/slices</a> ·
<a href="#stl_container_fns">STL container functions</a> ·
<a href="#submat">submatrix views</a> ·
<a href="#subcube">subcube views</a> ·
<a href="#subfield">subfield views</a> ·
<a href="#swap">swap</a> ·
<a href="#swap_rows">swap_rows/cols</a> ·
<a href="#t_st_members">t/st (transpose)</a> ·
<a href="#transform">transform</a> ·
<a href="#zeros_member">zeros</a>
</ul>
<br>
<b>Other Classes</b>
<ul>
<a href="#running_stat">running_stat<<i>type</i>></a> ·
<a href="#running_stat_vec">running_stat_vec<<i>vec_type</i>></a> ·
<a href="#wall_clock">wall_clock</a>
</ul>
<br>
<b>Generated Vectors/Matrices/Cubes</b>
<ul>
<a href="#eye_standalone">eye</a> ·
<a href="#linspace">linspace</a> ·
<a href="#ones_standalone">ones</a> ·
<a href="#randu_randn_standalone">randu/randn</a> ·
<a href="#repmat">repmat</a> ·
<a href="#speye">speye</a> ·
<a href="#spones">spones</a> ·
<a href="#sprandu_sprandn">sprandu/sprandn</a> ·
<a href="#toeplitz">toeplitz/circ_toeplitz</a> ·
<a href="#zeros_standalone">zeros</a>
</ul>
<br>
<b>Functions Individually Applied to Each Element of a Matrix/Cube</b>
<ul>
<a href="#abs">abs</a> ·
<a href="#conj">conj</a> ·
<a href="#conv_to">conv_to</a> ·
<a href="#eps">eps</a> ·
<a href="#imag_real">imag/real</a> ·
<a href="#misc_fns">misc functions (exp, log, pow, sqrt, round, sign, ...)</a> ·
<a href="#trig_fns">trigonometric functions (cos, sin, ...)</a>
</ul>
<br>
<b>Scalar Valued Functions of Vectors/Matrices/Cubes</b>
<ul>
<a href="#accu">accu</a> ·
<a href="#as_scalar">as_scalar</a> ·
<a href="#cond">cond</a> ·
<a href="#det">det</a> ·
<a href="#dot">dot/cdot/norm_dot</a> ·
<a href="#log_det">log_det</a> ·
<a href="#norm">norm</a> ·
<a href="#rank">rank</a> ·
<a href="#trace">trace</a>
</ul>
<br>
<b>Scalar/Vector Valued Functions of Vectors/Matrices</b>
<ul>
<a href="#all">all</a> ·
<a href="#any">any</a> ·
<a href="#diagvec">diagvec</a> ·
<a href="#min_and_max">min/max</a> ·
<a href="#prod">prod</a> ·
<a href="#sum">sum</a> ·
<a href="#stats_fns">statistics (mean, median, stddev, var)</a>
</ul>
<br>
<b>Vector/Matrix/Cube Valued Functions of Vectors/Matrices/Cubes</b>
<ul>
<a href="#conv">conv</a> ·
<a href="#cor">cor</a> ·
<a href="#cov">cov</a> ·
<a href="#cross">cross</a> ·
<a href="#cumsum">cumsum</a> ·
<a href="#diagmat">diagmat</a> ·
<a href="#find">find</a> ·
<a href="#flip">fliplr/flipud</a> ·
<a href="#hist">hist</a> ·
<a href="#histc">histc</a> ·
<a href="#inplace_strans">inplace_strans</a> ·
<a href="#inplace_trans">inplace_trans</a> ·
<a href="#join">join_rows/cols/slices</a> ·
<a href="#kron">kron</a> ·
<a href="#normalise">normalise</a> ·
<a href="#reshape">reshape</a> ·
<a href="#resize">resize</a> ·
<a href="#shuffle">shuffle</a> ·
<a href="#sort">sort</a> ·
<a href="#sort_index">sort_index</a> ·
<a href="#symmat">symmatu/symmatl</a> ·
<a href="#strans">strans</a> ·
<a href="#trans">trans</a> ·
<a href="#trimat">trimatu/trimatl</a> ·
<a href="#unique">unique</a> ·
<a href="#vectorise">vectorise</a>
</ul>
<br>
<b>Decompositions, Factorisations, Inverses and Equation Solvers</b>
<ul>
<a href="#chol">chol</a> ·
<a href="#eig_sym">eig_sym</a> ·
<a href="#eig_gen">eig_gen</a> ·
<a href="#eig_pair">eig_pair</a> ·
<a href="#eigs_sym">eigs_sym</a> ·
<a href="#eigs_gen">eigs_gen</a> ·
<a href="#fft">fft/ifft</a> ·
<a href="#fft2">fft2/ifft2</a> ·
<a href="#inv">inv</a> ·
<a href="#inv_sympd">inv_sympd</a> ·
<a href="#lu">lu</a> ·
<a href="#pinv">pinv</a> ·
<a href="#princomp">princomp</a> ·
<a href="#qr">qr</a> ·
<a href="#qr_econ">qr_econ</a> ·
<a href="#solve">solve</a> ·
<a href="#svd">svd</a> ·
<a href="#svd_econ">svd_econ</a> ·
<a href="#syl">syl</a>
</ul>
<br>
<b>Miscellaneous</b>
<ul>
<a href="#is_finite_standalone">is_finite()</a> ·
<a href="#logging">logging of errors/warnings</a> ·
<a href="#constants">pre-defined constants (pi, inf, speed of light, ...)</a> ·
<!--<a href="#log_add">log_add</a> ·-->
<a href="#uword">uword/sword</a> ·
<a href="#cx_double">cx_double/cx_float</a> ·
<a href="#syntax">Matlab/Armadillo syntax differences</a> ·
<a href="#example_prog">example program</a> ·
<!--<a href="#catching_exceptions">catching exceptions</a> ·-->
<a href="#config_hpp">config.hpp</a> ·
<a href="#api_additions">API additions</a>
</ul>
<br>
<br>
<br>
<hr class="greyline">
<hr class="greyline">
<br>
<br>
<font size=+1><b>Matrix, Vector, Cube and Field Classes</b></font>
<br>
<br>
<hr class="greyline">
<br>
<a name="Mat"></a><b>Mat<</b><i>type</i><b>></b>
<br><b>mat</b>
<br><b>cx_mat</b>
<ul>
<li>
The root matrix class is <b>Mat<</b><i>type</i><b>></b>, where <i>type</i> is one of:
<ul>
<li>
<i>float</i>, <i>double</i>, <i>std::complex<float></i>, <i>std::complex<double></i>,
<i>char</i>, <i>short</i>, <i>int</i>, <i>long</i> and unsigned versions of <i>char</i>, <i>short</i>, <i>int</i>, <i>long</i>
</li>
</ul>
</li>
<br>
<li>
For convenience the following typedefs have been defined:
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
mat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Mat<double>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
fmat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Mat<float>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
cx_mat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Mat<<a href="#cx_double">cx_double</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
cx_fmat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Mat<<a href="#cx_double">cx_float</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
umat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Mat<<a href="#uword">uword</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
imat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Mat<<a href="#uword">sword</a>>
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
In this documentation the <i>mat</i> type is used for convenience;
it is possible to use other types instead, eg. <i>fmat</i>
</li>
<br>
<li>
Functions which use LAPACK or ATLAS (generally matrix decompositions) are only valid for the following types:
<i>mat</i>, <i>fmat</i>, <i>cx_mat</i>, <i>cx_fmat</i>
</li>
<br>
<li>
Elements are stored with <a href="https://en.wikipedia.org/wiki/Column_major">column-major ordering</a> (ie. column by column)
</li>
<br>
<a name="constructors_mat"></a>
<li>
Constructors:
<ul>
<li>mat()</li>
<li>mat(n_rows, n_cols)</li>
<li>mat(n_rows, n_cols, fill_type)</li>
<li>mat(mat)</li>
<li>mat(vec)</li>
<li>mat(rowvec)</li>
<li>mat(string)</li>
<li>mat(std::vector) (treated as a column vector)</li>
<li>mat(initialiser_list) (C++11 only)</li>
<li>cx_mat(mat,mat) (for constructing a complex matrix out of two real matrices)</li>
</ul>
</li>
<br>
<li>
When specifying the size with <i>n_rows</i> and <i>n_cols</i>, by default the memory is uninitialised;
memory can be initialised by specifying the <i>fill_type</i>,
which is one of:
<i>fill::zeros</i>,
<i>fill::ones</i>,
<i>fill::eye</i>,
<i>fill::randu</i>,
<i>fill::randn</i>,
<i>fill::none</i>,
with the following meanings:
<ul>
<table>
<tbody>
<tr><td>fill::zeros</td><td> = </td><td>set all elements to 0</td></tr>
<tr><td>fill::ones</td><td> = </td><td>set all elements to 1</td></tr>
<tr><td>fill::eye</td><td> = </td><td>set the elements along the main diagonal to 1 and off-diagonal elements to 0</td></tr>
<tr><td>fill::randu</td><td> = </td><td>set each element to a random value from a uniform distribution in the [0,1] interval</td></tr>
<tr><td>fill::randn</td><td> = </td><td>set each element to a random value from a normal/Gaussian distribution with zero mean and unit variance</td></tr>
<tr><td>fill::none</td><td> = </td><td>do not modify the elements</td></tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
The string format for the constructor is elements separated by spaces, and rows denoted by semicolons.
For example, the 2x2 identity matrix can be created using the format string <code>"1 0; 0 1"</code>.
While string based initialisation is compact,
it is considerably faster to directly <a href="#element_access">set the elements</a>,
use <a href="#element_initialisation">element initialisation</a>,
or use C++11 initialiser lists.
</li>
<br>
<a name="adv_constructors_mat"></a>
<li>
Advanced constructors:
<br>
<br>
<ul>
<li>mat(aux_mem*, n_rows, n_cols, copy_aux_mem = true, strict = true)
<br>
<br>
<ul>
Create a matrix using data from writable auxiliary memory.
By default the matrix allocates its own memory and copies data from the auxiliary memory (for safety).
However, if <i>copy_aux_mem</i> is set to <i>false</i>,
the matrix will instead directly use the auxiliary memory (ie. no copying).
This is faster, but can be dangerous unless you know what you're doing!
<br>
<br>
The <i>strict</i> variable comes into effect only if <i>copy_aux_mem</i> is set to <i>false</i>
(ie. the matrix is directly using auxiliary memory).
If <i>strict</i> is set to <i>true</i>,
the matrix will be bound to the auxiliary memory for its lifetime;
the number of elements in the matrix can't be changed (directly or indirectly).
If <i>strict</i> is set to <i>false</i>, the matrix will not be bound to the auxiliary memory for its lifetime,
ie., the size of the matrix can be changed.
If the requested number of elements is different to the size of the auxiliary memory,
new memory will be allocated and the auxiliary memory will no longer be used.
</ul>
</li>
<br>
<li>mat(const aux_mem*, n_rows, n_cols)
<br>
<br>
<ul>
Create a matrix by copying data from read-only auxiliary memory.
</ul>
</li>
<a name="adv_constructors_mat_fixed"></a>
<br>
<li>mat::fixed<n_rows, n_cols>
<br>
<br>
<ul>
Create a fixed size matrix, with the size specified via template arguments.
Memory for the matrix is allocated at compile time.
This is generally faster than dynamic memory allocation, but the size of the matrix can't be changed afterwards (directly or indirectly).
<br>
<br>
For convenience, there are several pre-defined typedefs for each matrix type
(where the types are: <i>umat</i>, <i>imat</i>, <i>fmat</i>, <i>mat</i>, <i>cx_fmat</i>, <i>cx_mat</i>).
The typedefs specify a square matrix size, ranging from 2x2 to 9x9.
The typedefs were defined by simply appending a two digit form of the size to the matrix type
-- for example, <i>mat33</i> is equivalent to <i>mat::fixed<3,3></i>,
while <i>cx_mat44</i> is equivalent to <i>cx_mat::fixed<4,4></i>.
</ul>
</li>
<br>
<li>mat::fixed<n_rows, n_cols>(const aux_mem*)
<br>
<br>
<ul>
Create a fixed size matrix, with the size specified via template arguments,
and copying data from auxiliary memory.
</ul>
</li>
</ul>
</li>
<br>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
double x = A(1,2);
mat B = A + A;
mat C = A * B;
mat D = A % B;
cx_mat X(A,B);
B.zeros();
B.set_size(10,10);
B.ones(5,6);
mat E(4,5, fill::zeros);
//
// fixed size matrices:
mat::fixed<5,6> F;
F.ones();
mat44 G;
G.randn();
cout << mat22().randu() << endl;
//
// constructing matrices from
// auxiliary (external) memory:
double aux_mem[24];
mat H(aux_mem, 4, 6, false);
</pre>
</ul>
</li>
<br>
<li><b>Caveat:</b>
For mathematical correctness, scalars are treated as 1x1 matrices during initialisation.
As such, the code below <b>will not</b> generate a 5x5 matrix with every element equal to 123.0:
<ul>
<pre>
mat A(5,5); A = 123.0;
</pre>
</ul>
Use the following code instead:
<ul>
<pre>
mat A(5,5); A.fill(123.0);
</pre>
</ul>
<br>
<li>
See also:
<ul>
<li><a href="#attributes">matrix attributes</a></li>
<li><a href="#element_access">accessing elements</a></li>
<li><a href="#element_initialisation">initialising elements</a></li>
<li><a href="#operators">math & relational operators</a></li>
<li><a href="#submat">submatrix views</a></li>
<li><a href="#save_load_mat">saving & loading matrices</a></li>
<li><a href="#print">printing matrices</a></li>
<li><a href="#iterators_mat">STL-style element iterators</a></li>
<li><a href="#eval_member">.eval()</a></li>
<li><a href="#conv_to">conv_to()</a> (convert between matrix types)</li>
<li><a href="http://www.cplusplus.com/doc/tutorial/other_data_types/">explanation of <i>typedef</i></a> (cplusplus.com)
<li><a href="#Col">Col class</a></li>
<li><a href="#Row">Row class</a></li>
<li><a href="#Cube">Cube class</a></li>
<li><a href="#SpMat">SpMat class</a> (sparse matrix)</li>
<li><a href="#config_hpp">config.hpp</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="Col"></a><b>Col<</b><i>type</i><b>></b>
<br><b>vec</b>
<br><b>cx_vec</b>
<ul>
<li>
Classes for column vectors (matrices with one column)
</li>
<br>
<li>The <b>Col<</b><i>type</i><b>></b> class is derived from the <b>Mat<</b><i>type</i><b>></b> class
and inherits most of the member functions
</li>
<br>
<li>
For convenience the following typedefs have been defined:
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
vec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
colvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Col<double>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
fvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
fcolvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Col<float>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
cx_vec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
cx_colvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Col<<a href="#cx_double">cx_double</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
cx_fvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
cx_fcolvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Col<<a href="#cx_double">cx_float</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
uvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
ucolvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Col<<a href="#uword">uword</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ivec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
icolvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Col<<a href="#uword">sword</a>>
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
In this documentation, the <b><i>vec</i></b> and <b><i>colvec</i></b> types have the <b>same meaning</b> and are used <b>interchangeably</b>
</li>
<br>
<li>
In this documentation, the types <i>vec</i> or <i>colvec</i> are used for convenience; it is possible to use other types instead, eg. <i>fvec</i>, <i>fcolvec</i>
</li>
<br>
<li>
Functions which take <i>Mat</i> as input can generally also take <i>Col</i> as input.
Main exceptions are functions which require square matrices
</li>
<br>
<li>
Constructors
<ul>
<li>vec()</li>
<li>vec(n_elem)</li>
<li>vec(n_elem, fill_type)</li>
<li>vec(vec)</li>
<li>vec(mat) (a <i>std::logic_error</i> exception is thrown if the given matrix has more than one column)</li>
<li>vec(string) (elements separated by spaces)</li>
<li>vec(std::vector)</li>
<li>vec(initialiser_list) (C++11 only)</li>
</ul>
</li>
<br>
<li>
When specifying the size with <i>n_elem</i>, by default the memory is uninitialised;
memory can be initialised by specifying the <i>fill_type</i>,
as per the <a href="#Mat">Mat class</a>
</li>
<br>
<a name="adv_constructors_col"></a>
<li>
Advanced constructors:
<br>
<br>
<ul>
<li>vec(aux_mem*, number_of_elements, copy_aux_mem = true, strict = true)
<br>
<br>
<ul>
Create a column vector using data from writable auxiliary memory.
By default the vector allocates its own memory and copies data from the auxiliary memory (for safety).
However, if <i>copy_aux_mem</i> is set to <i>false</i>,
the vector will instead directly use the auxiliary memory (ie. no copying).
This is faster, but can be dangerous unless you know what you're doing!
<br>
<br>
The <i>strict</i> variable comes into effect only if <i>copy_aux_mem</i> is set to <i>false</i>
(ie. the vector is directly using auxiliary memory).
If <i>strict</i> is set to <i>true</i>,
the vector will be bound to the auxiliary memory for its lifetime;
the number of elements in the vector can't be changed (directly or indirectly).
If <i>strict</i> is set to <i>false</i>, the vector will not be bound to the auxiliary memory for its lifetime,
ie., the vector's size can be changed.
If the requested number of elements is different to the size of the auxiliary memory,
new memory will be allocated and the auxiliary memory will no longer be used.
</ul>
</li>
<br>
<li>vec(const aux_mem*, number_of_elements)
<br>
<br>
<ul>
Create a column vector by copying data from read-only auxiliary memory.
</ul>
</li>
<a name="adv_constructors_col_fixed"></a>
<br>
<li>vec::fixed<number_of_elements>
<br>
<br>
<ul>
Create a fixed size column vector, with the size specified via the template argument.
Memory for the vector is allocated at compile time.
This is generally faster than dynamic memory allocation, but the size of the vector can't be changed afterwards (directly or indirectly).
<br>
<br>
For convenience, there are several pre-defined typedefs for each vector type
(where the types are: <i>uvec</i>, <i>ivec</i>, <i>fvec</i>, <i>vec</i>, <i>cx_fvec</i>, <i>cx_vec</i> as well as the corresponding <i>colvec</i> versions).
The pre-defined typedefs specify vector sizes ranging from 2 to 9.
The typedefs were defined by simply appending a single digit form of the size to the vector type
-- for example, <i>vec3</i> is equivalent to <i>vec::fixed<3></i>,
while <i>cx_vec4</i> is equivalent to <i>cx_vec::fixed<4></i>.
</ul>
</li>
<br>
<li>vec::fixed<number_of_elements>(const aux_mem*)
<br>
<br>
<ul>
Create a fixed size column vector, with the size specified via the template argument,
and copying data from auxiliary memory.
</ul>
</li>
</ul>
</li>
<br>
<br>
<li>
Examples:
<ul>
<pre>
vec x(10);
vec y = zeros<vec>(10);
mat A = randu<mat>(10,10);
vec z = A.col(5); // extract a column vector
</pre>
</ul>
</li>
<br>
<li><b>Caveat:</b>
For mathematical correctness, scalars are treated as 1x1 matrices during initialisation.
As such, the code below <b>will not</b> generate a column vector with every element equal to 123.0:
<ul>
<pre>
vec a(5); a = 123.0;
</pre>
</ul>
Use the following code instead:
<ul>
<pre>
vec a(5); a.fill(123.0);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#element_initialisation">element initialisation</a></li>
<li><a href="#Mat">Mat class</a></li>
<li><a href="#Row">Row class</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="Row"></a>
<b>Row<</b><i>type</i><b>></b>
<br><b>rowvec</b>
<br><b>cx_rowvec</b>
<ul>
<li>
Classes for row vectors (matrices with one row)
</li>
<br>
<li>The template <b>Row<</b><i>type</i><b>></b> class is derived from the <b>Mat<</b><i>type</i><b>></b> class
and inherits most of the member functions
</li>
<br>
<li>
For convenience the following typedefs have been defined:
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
rowvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Row<double>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
frowvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Row<float>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
cx_rowvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Row<<a href="#cx_double">cx_double</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
cx_frowvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Row<<a href="#cx_double">cx_float</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
urowvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Row<<a href="#uword">uword</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
irowvec
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Row<<a href="#uword">sword</a>>
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
In this documentation, the <i>rowvec</i> type is used for convenience;
it is possible to use other types instead, eg. <i>frowvec</i>
</li>
<br>
<li>
Functions which take <i>Mat</i> as input can generally also take <i>Row</i> as input.
Main exceptions are functions which require square matrices
</li>
<br>
<li>
Constructors
<ul>
<li>rowvec()</li>
<li>rowvec(n_elem)</li>
<li>rowvec(n_elem, fill_type)</li>
<li>rowvec(rowvec)</li>
<li>rowvec(mat) (a <i>std::logic_error</i> exception is thrown if the given matrix has more than one row)</li>
<li>rowvec(string) (elements separated by spaces)</li>
<li>rowvec(std::vector)</li>
<li>rowvec(initialiser_list) (C++11 only)</li>
</ul>
</li>
<br>
<li>
When specifying the size with <i>n_elem</i>, by default the memory is uninitialised;
memory can be initialised by specifying the <i>fill_type</i>,
as per the <a href="#Mat">Mat class</a>
</li>
<br>
<a name="adv_constructors_row"></a>
<li>
Advanced constructors:
<br>
<br>
<ul>
<li>rowvec(aux_mem*, number_of_elements, copy_aux_mem = true, strict = true)
<br>
<br>
<ul>
Create a row vector using data from writable auxiliary memory.
By default the vector allocates its own memory and copies data from the auxiliary memory (for safety).
However, if <i>copy_aux_mem</i> is set to <i>false</i>,
the vector will instead directly use the auxiliary memory (ie. no copying).
This is faster, but can be dangerous unless you know what you're doing!
<br>
<br>
The <i>strict</i> variable comes into effect only if <i>copy_aux_mem</i> is set to <i>false</i>
(ie. the vector is directly using auxiliary memory).
If <i>strict</i> is set to <i>true</i>,
the vector will be bound to the auxiliary memory for its lifetime;
the number of elements in the vector can't be changed (directly or indirectly).
If <i>strict</i> is set to <i>false</i>, the vector will not be bound to the auxiliary memory for its lifetime,
ie., the vector's size can be changed.
If the requested number of elements is different to the size of the auxiliary memory,
new memory will be allocated and the auxiliary memory will no longer be used.
</ul>
</li>
<br>
<li>rowvec(const aux_mem*, number_of_elements)
<br>
<br>
<ul>
Create a row vector by copying data from read-only auxiliary memory.
</ul>
</li>
<br>
<li>rowvec::fixed<number_of_elements>
<br>
<br>
<ul>
Create a fixed size row vector, with the size specified via the template argument.
Memory for the vector is allocated at compile time.
This is generally faster than dynamic memory allocation, but the size of the vector can't be changed afterwards (directly or indirectly).
<br>
<br>
For convenience, there are several pre-defined typedefs for each vector type
(where the types are: <i>urowvec</i>, <i>irowvec</i>, <i>frowvec</i>, <i>rowvec</i>, <i>cx_frowvec</i>, <i>cx_rowvec</i>).
The pre-defined typedefs specify vector sizes ranging from 2 to 9.
The typedefs were defined by simply appending a single digit form of the size to the vector type
-- for example, <i>rowvec3</i> is equivalent to <i>rowvec::fixed<3></i>,
while <i>cx_rowvec4</i> is equivalent to <i>cx_rowvec::fixed<4></i>.
</ul>
</li>
<br>
<li>rowvec::fixed<number_of_elements>(const aux_mem*)
<br>
<br>
<ul>
Create a fixed size row vector, with the size specified via the template argument,
and copying data from auxiliary memory.
</ul>
</li>
</ul>
</li>
<br>
<br>
<li>
Examples:
<ul>
<pre>
rowvec x(10);
rowvec y = zeros<rowvec>(10);
mat A = randu<mat>(10,10);
rowvec z = A.row(5); // extract a row vector
</pre>
</ul>
</li>
<br>
<li>
<b>Caveat:</b>
For mathematical correctness, scalars are treated as 1x1 matrices during initialisation.
As such, the code below <b>will not</b> generate a row vector with every element equal to 123.0:
<ul>
<pre>
rowvec r(5); r = 123.0;
</pre>
</ul>
Use the following code instead:
<ul>
<pre>
rowvec r(5); r.fill(123.0);
</pre>
</ul>
<br>
<li>See also:
<ul>
<li><a href="#element_initialisation">element initialisation</a></li>
<li><a href="#Mat">Mat class</a></li>
<li><a href="#Col">Col class</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="Cube"></a>
<b>Cube<</b><i>type</i><b>></b>
<br><b>cube</b>
<br><b>cx_cube</b>
<ul>
<li>
Classes for cubes, also known as "3D matrices" or 3rd order tensors
</li>
<br>
<li>
The cube class is <b>Cube<</b><i>type</i><b>></b>, where <i>type</i> is one of:
<ul>
<li>
<i>float</i>, <i>double</i>, <i>std::complex<float></i>, <i>std::complex<double></i>,
<i>char</i>, <i>short</i>, <i>int</i>, <i>long</i> and unsigned versions of <i>char</i>, <i>short</i>, <i>int</i>, <i>long</i>
</li>
</ul>
</li>
<br>
<li>
For convenience the following typedefs have been defined:
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
cube
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Cube<double>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
fcube
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Cube<float>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
cx_cube
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Cube<<a href="#cx_double">cx_double</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
cx_fcube
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Cube<<a href="#cx_double">cx_float</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ucube
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Cube<<a href="#uword">uword</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
icube
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
Cube<<a href="#uword">sword</a>>
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
In this documentation the <i>cube</i> type is used for convenience;
it is possible to use other types instead, eg. <i>fcube</i>
</li>
<br>
<li>
Cube data is stored as a set of slices (matrices) stored contiguously within memory.
Within each slice, elements are stored with column-major ordering (ie. column by column)
</li>
<br>
<li>
Each slice can be interpreted as a matrix, hence functions which take <i>Mat</i> as input can generally also take cube slices as input
</li>
<br>
<a name="constructors_cube"></a>
<li>
Constructors:
<ul>
<li>cube()</li>
<li>cube(n_rows, n_cols, n_slices)</li>
<li>cube(n_rows, n_cols, n_slices, fill_type)</li>
<li>cube(cube)</li>
<li>cx_cube(cube, cube) (for constructing a complex cube out of two real cubes)</li>
</ul>
</li>
<br>
<li>
When specifying the cube size with <i>n_rows</i>, <i>n_cols</i> and <i>n_slices</i>, by default the memory is uninitialised;
memory can be initialised by specifying the <i>fill_type</i>,
as per the <a href="#Mat">Mat class</a> (except for <i>fill::eye</i>)
</li>
<br>
<a name="adv_constructors_cube"></a>
<li>
Advanced constructors:
<br>
<br>
<ul>
<li>
cube::fixed<n_rows, n_cols, n_slices>
<br>
<br>
<ul>
Create a fixed size cube, with the size specified via template arguments.
Memory for the cube is allocated at compile time.
This is generally faster than dynamic memory allocation, but the size of the cube can't be changed afterwards (directly or indirectly).
</ul>
</li>
<br>
<li>cube(aux_mem*, n_rows, n_cols, n_slices, copy_aux_mem = true, strict = true)
<br>
<br>
<ul>
Create a cube using data from writable auxiliary memory.
By default the cube allocates its own memory and copies data from the auxiliary memory (for safety).
However, if <i>copy_aux_mem</i> is set to <i>false</i>,
the cube will instead directly use the auxiliary memory (ie. no copying).
This is faster, but can be dangerous unless you know what you're doing!
<br>
<br>
The <i>strict</i> variable comes into effect only if <i>copy_aux_mem</i> is set to <i>false</i>
(ie. the cube is directly using auxiliary memory).
If <i>strict</i> is set to <i>true</i>,
the cube will be bound to the auxiliary memory for its lifetime;
the number of elements in the cube can't be changed (directly or indirectly).
If <i>strict</i> is set to <i>false</i>, the cube will not be bound to the auxiliary memory for its lifetime,
ie., the size of the cube can be changed.
If the requested number of elements is different to the size of the auxiliary memory,
new memory will be allocated and the auxiliary memory will no longer be used.
</ul>
</li>
<br>
<li>cube(const aux_mem*, n_rows, n_cols, n_slices)
<br>
<br>
<ul>
Create a cube by copying data from read-only auxiliary memory.
</ul>
</li>
</ul>
</li>
<br>
<br>
<li>
Examples:
<ul>
<pre>
cube x(1,2,3);
cube y = randu<cube>(4,5,6);
mat A = y.slice(1); // extract a slice from the cube
// (each slice is a matrix)
mat B = randu<mat>(4,5);
y.slice(2) = B; // set a slice in the cube
cube q = y + y; // cube addition
cube r = y % y; // element-wise cube multiplication
cube::fixed<4,5,6> f;
f.ones();
</pre>
</ul>
</li>
<br>
<li>
<b>Caveats</b>
<br>
<br>
<ul>
<li>
The size of individual slices can't be changed.
For example, the following <b>will not</b> work:
<ul>
<pre>
cube c(5,6,7);
c.slice(0) = randu<mat>(10,20); // wrong size
</pre>
</ul>
</li>
<li>
For mathematical correctness, scalars are treated as 1x1x1 cubes during initialisation.
As such, the code below <b>will not</b> generate a cube with every element equal to 123.0:
<ul>
<pre>
cube c(5,6,7); c = 123.0;
</pre>
</ul>
Use the following code instead:
<ul>
<pre>
cube c(5,6,7); c.fill(123.0);
</pre>
</ul>
<br>
</ul>
<li>
See also:
<ul>
<li><a href="#attributes">cube attributes</a></li>
<li><a href="#element_access">accessing elements</a></li>
<li><a href="#operators">math & relational operators</a></li>
<li><a href="#subcube">subcube views and slices</a></li>
<li><a href="#save_load_mat">saving & loading cubes</a></li>
<li><a href="#iterators_cube">STL-style element iterators</a></li>
<li><a href="#field">field class</a></li>
<li><a href="#Mat">Mat class</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="field"></a>
<b>field<</b><i>object type</i><b>></b>
<ul>
<li>
Class for storing arbitrary objects in matrix-like or cube-like layouts
</li>
<br>
<li>
Somewhat similar to a matrix or cube, but instead of each element being a scalar,
each element can be a vector (resulting in a field of vectors), or matrix, or cube
</li>
<br>
<li>
Each element can have an arbitrary size
</li>
<br>
<li>
Constructors (where <i>object type</i> is another class, eg. <i>vec</i>, <i>mat</i>, <i>std::string</i>, etc):
<ul>
<li>field<<i>object type</i>>()</li>
<li>field<<i>object type</i>>(n_elem)</li>
<li>field<<i>object type</i>>(n_rows, n_cols)</li>
<li>field<<i>object type</i>>(n_rows, n_cols, n_slices)</li>
<li>field<<i>object type</i>>(field<<i>object type</i>>)</li>
</ul>
</li>
<br>
<li>
<b>Caveat</b>: if you want to store a set of matrices of the same size, the <a href="#Cube">Cube</a> class is more efficient
</li>
<br>
<li>
Examples:
<ul>
<pre>
// create a field containing vectors
field<vec> F(3,2);
// each vector in the field can have an arbitrary size
F(0,0) = vec(5);
F(1,1) = randu<vec>(6);
F(2,0).set_size(7);
// access element 1 of vector stored at 2,0
double x = F(2,0)(1);
// copy a row of vectors
F.row(0) = F.row(2);
// extract a row of vectors from F
field<vec> G = F.row(1);
// print the field to the standard output
G.print("G =");
// save the field to a binary file
G.save("vec_field");
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#attributes">field attributes</a></li>
<li><a href="#subfield">subfield views</a></li>
<li><a href="#save_load_field">saving/loading fields</a></li>
<li><a href="#Cube">Cube class</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="SpMat"></a><b>SpMat<</b><i>type</i><b>></b>
<br><b>sp_mat</b>
<br><b>sp_cx_mat</b>
<ul>
<li>
The root sparse matrix class is <b>SpMat<</b><i>type</i><b>></b>, where <i>type</i> is one of:
<ul>
<li>
<i>float</i>, <i>double</i>, <i>std::complex<float></i>, <i>std::complex<double></i>,
<i>char</i>, <i>short</i>, <i>int</i>, <i>long</i> and unsigned versions of <i>char</i>, <i>short</i>, <i>int</i>, <i>long</i>
</li>
</ul>
</li>
<br>
<li>
For convenience the following typedefs have been defined:
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
sp_mat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
SpMat<double>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
sp_fmat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
SpMat<float>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
sp_cx_mat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
SpMat<<a href="#cx_double">cx_double</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
sp_cx_fmat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
SpMat<<a href="#cx_double">cx_float</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
sp_umat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
SpMat<<a href="#uword">uword</a>>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
sp_imat
</td>
<td style="vertical-align: top;">
=
</td>
<td style="vertical-align: top;">
SpMat<<a href="#uword">sword</a>>
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
In this documentation the <i>sp_mat</i> type is used for convenience;
it is possible to use other types instead, eg. <i>sp_fmat</i>
</li>
<br>
<a name="constructors_sp_mat"></a>
<li>
Constructors:
<ul>
<li>sp_mat()</li>
<li>sp_mat(<i>n_rows</i>, <i>n_cols</i>)</li>
<li>sp_mat(sp_mat)</li>
<li>sp_mat(string)</li>
<li>sp_cx_mat(sp_mat,sp_mat) (for constructing a complex matrix out of two real matrices)</li>
</ul>
<br>
<li>
Elements are stored in the <a href="http://en.wikipedia.org/wiki/Sparse_matrix">compressed sparse column (CSC) format</a>
</li>
<br>
<li>
All elements are treated as zero by default (ie. the matrix is initialised to contain zeros)
</li>
<br>
<li>
This class behaves in a similar manner to the <a href="#Mat">Mat</a> class,
however, member functions which set all elements to non-zero values (and hence do not make sense for sparse matrices) have been deliberately omitted;
examples of omitted functions: <a href="#fill">.fill()</a>, <a href="#ones_member">.ones()</a>, += scalar, etc.
</li>
<br>
<li>
<a name="batch_constructors_sp_mat"></a>
Batch insertion constructors:
<ul>
<li>form 1: sp_mat(<i>locations</i>, <i>values</i>, <i>sort_locations = true</i>)</li>
<li>form 2: sp_mat(<i>locations</i>, <i>values</i>, <i>n_rows</i>, <i>n_cols</i>, <i>sort_locations = true</i>)</li>
<li>form 3: sp_mat(<i>rowind</i>, <i>colptr</i>, <i>values</i>, <i>n_rows</i>, <i>n_cols</i>)</li>
<br>
<ul>
<li>
Using batch insertion constructors is generally much faster than consecutively inserting values using <a href="#element_access">element access operators</a>
</li>
<br>
<li>
For forms 1 and 2, <i>locations</i> is a dense matrix of type <i>umat</i>, with a size of <i>2</i> x <i>N</i>, where <i>N</i> is the number of values to be inserted;
the location of the <i>i</i>-th element is specified by the contents of the <i>i</i>-th column of the <i>locations</i> matrix,
where the row is in <i>locations(0,i)</i>, and the column is in <i>locations(1,i)</i>
</li>
<br>
<li>
For all forms, <i>values</i> is a dense column vector containing the values to be inserted;
it must have the same element type as the sparse matrix.
For forms 1 and 2, the value in <i>values[i]</i> will be inserted at the location specified by the <i>i</i>-th column of the <i>locations</i> matrix.
</li>
<br>
<li>
For form 3,
<i>rowind</i> is a dense column vector of type <i>umat</i> or <i>uvec</i> containing the row indices of the values to be inserted,
and
<i>colptr</i> is a dense column vector of type <i>umat</i> or <i>uvec</i> containing indices of <i>values</i> corresponding to the start of new columns;
the vectors correspond to the arrays used by the <a href="http://en.wikipedia.org/wiki/Sparse_matrix">compressed sparse column format</a>
</li>
<br>
<li>
The size of the constructed matrix is either automatically determined from the maximal locations in the <i>locations</i> matrix (form 1),
or manually specified via <i>n_rows</i> and <i>n_cols</i> (forms 2 and 3)
</li>
<br>
<li>
If <i>sort_locations</i> is set to <i>false</i>, the <i>locations</i> matrix is assumed to contain locations that are already sorted according to column-major ordering
</li>
</ul>
</ul>
<br>
<li>
<b>Caveat:</b>
support for sparse matrices in this version is <b>preliminary</b>;
it is not yet fully optimised, and sparse matrix decompositions/factorisations are not yet fully implemented;
the following subset of operations currently works with sparse matrices:
<ul>
<li>element access</li>
<li>fundamental arithmetic operations (such as addition and multiplication)</li>
<li>submatrix views</li>
<li>saving and loading (in <i>arma_binary</i> format)</li>
<li>element-wise functions: <a href="#abs">abs()</a>, <a href="#misc_fns">sqrt()</a>, <a href="#misc_fns">square()</a></li>
<li>scalar functions of matrices: <a href="#accu">accu()</a>, <a href="#as_scalar">as_scalar()</a>, <a href="#dot">dot()</a>, <a href="#norm">norm()</a>, <a href="#trace">trace()</a></li>
<li>vector valued functions of matrices: <a href="#min_and_max">min()</a>, <a href="#min_and_max">max()</a>, <a href="#sum">sum()</a>, <a href="#stats_fns">mean()</a>, <a href="#stats_fns">var()</a></li>
<li>matrix values functions of matrices: <a href="#t_st_members">.t()</a>, <a href="#trans">trans()</a></li>
<li>generated matrices: <a href="#speye">speye()</a>, <a href="#spones">spones()</a>, <a href="#sprandu_sprandn">sprandu()/sprandn()</a></li>
<li>eigen decomposition: <a href="#eigs_sym">eigs_sym()</a>, <a href="#eigs_gen">eigs_gen()</a></li>
<!-- <li>solution of sparse linear systems: <a href="#solve">solve()</a> -->
<li>miscellaneous: <a href="#print">print()</a></li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
sp_mat A(5,6);
sp_mat B(6,5);
A(0,0) = 1;
A(1,0) = 2;
B(0,0) = 3;
B(0,1) = 4;
sp_mat C = 2*B;
sp_mat D = A*C;
// batch insertion of two values at (5, 6) and (9, 9)
umat locations;
locations << 5 << 9 << endr
<< 6 << 9 << endr;
vec values;
values << 1.5 << 3.2 << endr;
sp_mat X(locations, values);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#element_access">accessing elements</a></li>
<li><a href="#print">printing matrices</a></li>
<!--
<li><a href="#SpCol">SpCol class</a> (TODO: add to documentation)</li>
<li><a href="#SpRow">SpRow class</a> (TODO: add to documentation)</li>
-->
<li><a href="http://en.wikipedia.org/wiki/Sparse_matrix">Sparse Matrix in Wikipedia</a></li>
<li><a href="#Mat">Mat class</a> (dense matrix)</li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<hr class="greyline">
<br>
<br>
<font size=+1><b>Member Functions & Variables</b></font>
<br>
<br>
<hr class="greyline">
<br>
<a name="attributes"></a>
<b>attributes</b>
<ul>
<table style="text-align: left;" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td>
<b>.n_rows</b>
</td>
<td> </td>
<td>
number of rows; present in <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>Cube</i>, <i>field</i> and <i>SpMat</i>
</td>
</tr>
<tr>
<td>
<b>.n_cols</b>
</td>
<td> </td>
<td>
number of columns; present in <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>Cube</i>, <i>field</i> and <i>SpMat</i>
</td>
</tr>
<tr>
<td>
<b>.n_elem</b>
</td>
<td> </td>
<td>
total number of elements; present in <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>Cube</i>, <i>field</i> and <i>SpMat</i>
</td>
</tr>
<tr>
<td>
<b>.n_slices</b>
</td>
<td> </td>
<td>
number of slices; present in <i>Cube</i>
</td>
</tr>
<tr>
<td>
<b>.n_nonzero</b>
</td>
<td> </td>
<td>
number of non-zero elements; present in <i>SpMat</i>
</td>
</tr>
</tbody>
</table>
</ul>
<ul>
<li>
Member variables which are read-only;
to change the size, use
<a href="#set_size">.set_size()</a>,
<a href="#copy_size">.copy_size()</a>,
<a href="#zeros_member">.zeros()</a>,
<a href="#ones_member">.ones()</a>,
or
<a href="#reset">.reset()</a>
</li>
<br>
<li>
For the <i>Col</i> and <i>Row</i> classes, <i>n_elem</i> also indicates vector length</li>
<br>
<li>The variables are of type <a href="#uword">uword</a></li>
<br>
<li>
Examples:
<ul>
<pre>
mat X(4,5);
cout << "X has " << X.n_cols << " columns" << endl;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#set_size">.set_size()</a></li>
<li><a href="#copy_size">.copy_size()</a></li>
<li><a href="#zeros_member">.zeros()</a></li>
<li><a href="#ones_member">.ones()</a></li>
<li><a href="#reset">.reset()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="colptr"></a>
<b>.colptr( col_number )</b>
<ul>
<li>
Member function of <i>Mat</i>
</li>
<br>
<li>
Obtain a raw pointer to the memory used by the specified column
</li>
<br>
<li>
As soon as the size of the matrix is changed, the pointer is no longer valid
</li>
<br>
<li>This function is not recommended for use unless you know what you're doing
-- you may wish to use <a href="#submat">submatrix views</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
double* mem = A.colptr(2);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#memptr">.memptr()</a></li>
<li><a href="#submat">submatrix views</a></li>
<li><a href="#element_access">element access</a></li>
<li><a href="#iterators_mat">iterators (matrices)</a></li>
<li><a href="#adv_constructors_mat">advanced constructors (matrices)</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="copy_size"></a>
<b>.copy_size( A )</b>
<ul>
<li>
Set the size to be the same as object <i>A</i>
</li>
<br>
<li>
Object <i>A</i> must be of the same root type as the object being modified
(eg. you can't set the size of a matrix by providing a cube)
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,6);
mat B;
B.copy_size(A);
cout << B.n_rows << endl;
cout << B.n_cols << endl;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#reset">.reset()</a></li>
<li><a href="#set_size">.set_size()</a></li>
<li><a href="#reshape_member">.reshape()</a></li>
<li><a href="#resize_member">.resize()</a></li>
<li><a href="#zeros_member">.zeros()</a></li>
<li><a href="#repmat">repmat()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="diag"></a>
<b>.diag()</b>
<br><b>.diag( k )</b>
<ul>
<li>
Member function of <i>Mat</i>
</li>
<br>
<li>
Read/write access to a diagonal in a matrix
</li>
<br>
<li>The argument <i>k</i> is optional; by default the main diagonal is accessed (<i>k=0</i>)</li>
<br>
<li>For <i>k > 0</i>, the <i>k</i>-th super-diagonal is accessed (top-right corner)</li>
<br>
<li>For <i>k < 0</i>, the <i>k</i>-th sub-diagonal is accessed (bottom-left corner)</li>
<br>
<li>
The diagonal is interpreted as a column vector within expressions
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(5,5);
vec a = X.diag();
vec b = X.diag(1);
vec c = X.diag(-2);
X.diag() = randu<vec>(5);
X.diag() += 6;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#eye_member">.eye()</a></li>
<li><a href="#diagvec">diagvec()</a></li>
<li><a href="#diagmat">diagmat()</a></li>
<li><a href="#submat">submatrix views</a></li>
<li><a href="#each_colrow">.each_col() & .each_row()</a></li>
<li><a href="#trace">trace()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="each_colrow"></a>
<b>.each_col()</b>
<br>
<b>.each_row()</b>
<br>
<br>
<b>.each_col( vector_of_indices )</b>
<br>
<b>.each_row( vector_of_indices )</b>
<ul>
<li>
Member functions of <i>Mat</i>
</li>
<br>
<li>
Write access to each column or row of a matrix/submatrix,
allowing a vector operation to be repeated on each column or row
</li>
<br>
<li>
The operation can be in-place vector addition, subtraction, element-wise multiplication, element-wise division, or simply vector copy
</li>
<br>
<li>The argument <i>vector_of_indices</i> is optional -- by default all columns or rows are accessed</li>
<br>
<li>
If the argument <i>vector_of_indices</i> is used, it must evaluate to be a vector of type <i><a href="#Col">uvec</a></i>;
the vector contains a list of indices of the columns or rows to be accessed
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = ones<mat>(6,5);
vec v = linspace<vec>(10,15,6);
// add v to each column in X
X.each_col() += v;
// subtract v from columns 0 through to 3 in X
X.cols(0,3).each_col() -= v;
uvec indices(2);
indices(0) = 2;
indices(1) = 4;
// copy v to columns 2 and 4 in X
X.each_col(indices) = v;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#diag">diagonal views</a></li>
<li><a href="#submat">submatrix views</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="element_access"></a>
<b>element/object access via (), [] and .at()</b>
<ul>
<li>
Provide access to individual elements or objects stored in a container object
(ie., <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>Cube</i>, <i>field</i>)<br>
<br>
<ul>
<table style="text-align: left; width: 100%;"
border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<code>(n)</code>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
For <i>vec</i> and <i>rowvec</i>, access the <i>n</i>-th element.
For <i>mat</i>, <i>cube</i> and <i>field</i>, access the <i>n</i>-th element/object under the assumption of a flat layout,
with column-major ordering of data (ie. column by column).
A <i>std::logic_error</i> exception is thrown if the requested element is out of bounds.
The bounds check can be <a href="#element_access_bounds_check_note">optionally disabled</a> at compile-time to get more speed.
</td>
</tr>
<tr>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td style="vertical-align: top;">
<code>.at(n)</code> or <code>[n]</code>
</td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
As for <i>(n)</i>, but without a bounds check.
Not recommended for use unless your code has been thoroughly debugged.
</td>
</tr>
<tr>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td style="vertical-align: top;">
<code>(i,j)</code>
</td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
For <i>mat</i> and <i>field</i> classes, access the element/object stored at the <i>i</i>-th row and <i>j</i>-th column.
A <i>std::logic_error</i> exception is thrown if the requested element is out of bounds.
The bounds check can be <a href="#element_access_bounds_check_note">optionally disabled</a> at compile-time to get more speed.
</td>
</tr>
<tr>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td style="vertical-align: top;">
<code>.at(i,j)</code>
</td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
As for <i>(i,j)</i>, but without a bounds check.
Not recommended for use unless your code has been thoroughly debugged.
</td>
<td style="vertical-align: top;"><br>
</td>
</tr>
<tr>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td style="vertical-align: top;">
<code>(i,j,k)</code>
</td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
Cube only: access the element stored at the <i>i</i>-th row, <i>j</i>-th column and <i>k</i>-th slice.
A <i>std::logic_error</i> exception is thrown if the requested element is out of bounds.
The bounds check can be <a href="#element_access_bounds_check_note">optionally disabled</a> at compile-time to get more speed.
</td>
</tr>
<tr>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td style="vertical-align: top;">
<code>.at(i,j,k)</code>
</td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
As for <i>(i,j,k)</i>, but without a bounds check.
Not recommended for use unless your code has been thoroughly debugged.</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<a name="element_access_bounds_check_note"></a>
<li>
The bounds checks used by the <i>(n)</i>, <i>(i,j)</i> and <i>(i,j,k)</i> access forms
can be disabled by defining the <a href="#config_hpp_arma_no_debug">ARMA_NO_DEBUG</a> macro
before including the <i>armadillo</i> header file (eg. <i>#define ARMA_NO_DEBUG</i>).
Disabling the bounds checks is not recommended until your code has been thoroughly debugged
-- it's better to write correct code first, and then maximise its speed.
</li>
<br>
<li>
<b>Note</b>: for <a href="#SpMat">sparse matrices</a>, using element access operators to insert values via loops can be inefficient;
you may wish to use <a href="#batch_constructors_sp_mat">batch insertion constructors</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(10,10);
A(9,9) = 123.0;
double x = A.at(9,9);
double y = A[99];
vec p = randu<vec>(10,1);
p(9) = 123.0;
double z = p[9];
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#in_range">.in_range()</a></li>
<li><a href="#element_initialisation">element initialisation</a></li>
<li><a href="#submat">submatrix views</a></li>
<li><a href="#memptr">.memptr()</a></li>
<li><a href="#iterators_mat">iterators (matrices)</a></li>
<li><a href="#iterators_cube">iterators (cubes)</a></li>
<li><a href="#config_hpp">config.hpp</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="element_initialisation"></a>
<b>element initialisation</b>
<ul>
<li>
Instances of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>field</i> classes can be initialised via the << operator
</li>
<br>
<li>
Special element <i>endr</i> indicates "end of row" (conceptually similar to <i>std::endl</i>)
</li>
<br>
<li>
Setting elements via << is a bit slower than directly <a href="#element_access">accessing</a> the elements,
but code using << is generally more readable and easier to write
</li>
<br>
<li>
When using a C++11 compiler, matrices and vectors can use initialiser lists instead; for example: { 1, 2, 3, 4 }
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A;
A << 1 << 2 << 3 << endr
<< 4 << 5 << 6 << endr;
mat B = { 1, 2, 3, 4, 5, 6 }; // C++11 only
B.reshape(2,3);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#element_access">element access</a></li>
<li><a href="#reshape_member">.reshape()</a></li>
<li><a href="#print">.print()</a></li>
<li><a href="#save_load_mat">saving & loading matrices</a></li>
<li><a href="#adv_constructors_mat">advanced constructors (matrices)</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="eval_member"></a>
<b>.eval()</b>
<br>
<ul>
<li>
Member function of any matrix or vector expression
</li>
<br>
<li>
Explicitly forces the evaluation of a delayed expression and outputs a matrix
</li>
<br>
<li>
This function should be used sparingly and only in cases where it is absolutely necessary; indiscriminate use can cause slow downs
</li>
<br>
<li>
Examples:
<ul>
<pre>
cx_mat A( randu<mat>(4,4), randu<mat>(4,4) );
real(A).eval().save("A_real.dat", raw_ascii);
imag(A).eval().save("A_imag.dat", raw_ascii);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#Mat">Mat class</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="eye_member"></a>
<b>.eye()</b>
<br>
<b>.eye( n_rows, n_cols )</b>
<ul>
<li>
Member functions of <i>Mat</i> and <i>SpMat</i>
</li>
<br>
<li>
Set the elements along the main diagonal to one and off-diagonal elements to zero,
optionally first resizing to specified dimensions
</li>
<br>
<li>
An identity matrix is generated when <i>n_rows</i> = <i>n_cols</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A(5,5);
A.eye();
mat B;
B.eye(5,5);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#ones_member">.ones()</a></li>
<li><a href="#diag">.diag()</a></li>
<li><a href="#diagmat">diagmat()</a></li>
<li><a href="#diagvec">diagvec()</a></li>
<li><a href="#eye_standalone">eye()</a> (standalone function)</li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="fill"></a>
<b>.fill( value )</b>
<ul>
<li>
Member function of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>Cube</i>
</li>
<br>
<li>Sets the elements to a specified value</li>
<br>
<li>the type of value must match the type of elements used by the container object (eg. for <i>mat</i> the type is double)
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A(5,5);
A.fill(123.0);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#imbue">.imbue()</a></li>
<li><a href="#ones_member">.ones()</a></li>
<li><a href="#zeros_member">.zeros()</a></li>
<li><a href="#randu_randn_member">.randu() & .randn()</a></li>
<li><a href="#constants">pre-defined constants (pi, nan, inf, ...)</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="i_member"></a>
<b>.i()</b>
<br><b>.i( method )</b>
<ul>
<li>
Member functions of any matrix expression
</li>
<br>
<li>
Provides an inverse of the matrix expression
</li>
<br>
<li>
If the matrix expression is not square, a <i>std::logic_error</i> exception is thrown
</li>
<br>
<li>
If the matrix expression appears to be singular, the output matrix is reset and a <i>std::runtime_error</i> exception is thrown
</li>
<br>
<li>The <i>method</i> argument is optional.
For matrix sizes ≤ 4x4, a fast algorithm is used.
In rare instances, the fast algorithm might be less precise than the standard algorithm.
To force the use of the standard algorithm, set the <i>method</i> argument to "std".
For matrix sizes greater than 4x4, the standard algorithm is always used
</li>
<br>
<li>
<b>Caveat:</b> if matrix <i>A</i> is know to be symmetric positive definite, it's faster to use <a href="#inv_sympd">inv_sympd()</a> instead
</li>
<br>
<li>
<b>Caveat:</b>
if you want to solve a system of linear equations, such as <i>Z = inv(X)*Y</i>,
it is faster and more accurate to use <a href="#solve">solve()</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,4);
mat B = randu<mat>(4,1);
mat X = A.i();
mat Y = (A+A).i();
</pre>
</ul>
</li>
<li>
See also:
<ul>
<li><a href="#inv">inv()</a></li>
<li><a href="#cond">cond()</a></li>
<li><a href="#pinv">pinv()</a></li>
<li><a href="#solve">solve()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="in_range"></a>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>.in_range(</b> i <b>)</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>Cube</i> and <i>field</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.in_range( span(</b>start<b>,</b> end<b>) )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>Cube</i> and <i>field</i>)
</td>
</tr>
<tr>
<td>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.in_range(</b> row<b>,</b> col <b>)</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>field</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.in_range( <font size=-1>span(</b>start_row<b>,</b> end_row<b>), span(</b>start_col<b>,</b> end_col<b>)</font> )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>field</i>)
</td>
</tr>
<tr>
<td>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.in_range(</b> row<b>,</b> col<b>,</b> slice <b>)</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member of <i>Cube</i> and <i>field</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.in_range( <font size=-1>span(</b>start_row<b>,</b> end_row<b>), span(</b>start_col<b>,</b> end_col<b>), span(</b>start_slice<b>,</b> end_slice<b>)</font> )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member of <i>Cube</i> and <i>field</i>)
</td>
</tr>
<tr>
<td>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.in_range(</b> first_row<b>,</b> first_col<b>, size(</b>X<b>) )</b> <i>(X is a mat or field)</i></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>field</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.in_range(</b> first_row<b>,</b> first_col<b>, size(</b>n_rows<b>,</b> n_cols<b>) )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>field</i>)
</td>
</tr>
<tr>
<td>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.in_range(</b> first_row<b>,</b> first_col<b>, </b> first_slice<b>, size(</b>Q<b>) )</b> <i>(Q is a cube or field)</i></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member of <i>Cube</i> and <i>field</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.in_range(</b> first_row<b>,</b> first_col<b>, </b> first_slice<b>, size(</b>n_rows<b>,</b> n_cols<b></b> n_slices<b>) )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member of <i>Cube</i> and <i>field</i>)
</td>
</tr>
</tbody>
</table>
<br>
<ul>
<li>Returns <i>true</i> if the given location or span is currently valid
</li>
<br>
<li>Returns <i>false</i> if the object is empty, the location is out of bounds, or the span is out of bounds
</li>
<br>
<li>
Instances of <i>span(a,b)</i> can be replaced by:
<ul>
<li><i>span()</i> or <i>span::all</i>, to indicate the entire range</li>
<li><i>span(a)</i>, to indicate a particular row, column or slice</li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
cout << A.in_range(0,0) << endl; // true
cout << A.in_range(3,4) << endl; // true
cout << A.in_range(4,5) << endl; // false
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#element_access">element access</a></li>
<li><a href="#submat">submatrix views</a></li>
<li><a href="#subcube">subcube views</a></li>
<li><a href="#subfield">subfield views</a></li>
<li><a href="#set_size">.set_size()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="is_empty"></a>
<b>.is_empty()</b>
<ul>
<li>Returns <i>true</i> if the object has no elements
</li>
<br>
<li>Returns <i>false</i> if the object has one or more elements
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
cout << A.is_empty() << endl;
A.reset();
cout << A.is_empty() << endl;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#is_square">.is_square()</a></li>
<li><a href="#is_vec">.is_vec()</a></li>
<li><a href="#is_finite">.is_finite()</a></li>
<li><a href="#reset">.reset()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="is_finite"></a>
<b>.is_finite()</b>
<ul>
<li>
Member function of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>Cube</i>, <i>SpMat</i>
</li>
<br>
<li>Returns <i>true</i> if all elements of the object are finite
</li>
<br>
<li>Returns <i>false</i> if at least one of the elements of the object is non-finite (±infinity or NaN)
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = randu<mat>(5,5);
B(1,1) = datum::nan;
cout << A.is_finite() << endl;
cout << B.is_finite() << endl;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#constants">pre-defined constants (pi, nan, inf, ...)</a></li>
<li><a href="#is_finite_standalone">is_finite()</a> (standalone function)</li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="is_square"></a>
<b>.is_square()</b>
<ul>
<li>
Member function of <i>Mat</i> and <i>SpMat</i>
</li>
<br>
<li>Returns <i>true</i> if the matrix is square, ie., number of rows is equal to the number of columns
</li>
<br>
<li>Returns <i>false</i> if the matrix is not square
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = randu<mat>(6,7);
cout << A.is_square() << endl;
cout << B.is_square() << endl;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#is_empty">.is_empty()</a></li>
<li><a href="#is_vec">.is_vec()</a></li>
<li><a href="#is_finite">.is_finite()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="is_vec"></a>
<b>.is_vec()</b>
<br><b>.is_colvec()</b>
<br><b>.is_rowvec()</b>
<ul>
<li>
Member functions of <i>Mat</i> and <i>SpMat</i>
</li>
<br>
<li>.is_vec():
<ul>
<li>Returns <i>true</i> if the matrix can be interpreted as a vector (either column or row vector)
</li>
<li>Returns <i>false</i> if the matrix does not have exactly one column or one row
</li>
</ul>
</li>
<br>
<li>.is_colvec():
<ul>
<li>Returns <i>true</i> if the matrix can be interpreted as a column vector
</li>
<li>Returns <i>false</i> if the matrix does not have exactly one column
</li>
</ul>
</li>
<br>
<li>.is_rowvec():
<ul>
<li>Returns <i>true</i> if the matrix can be interpreted as a row vector
</li>
<li>Returns <i>false</i> if the matrix does not have exactly one row
</li>
</ul>
</li>
<br>
<li><b>Caveat:</b> do not assume that the vector has elements if these functions return <i>true</i>; it is possible to have an empty vector (eg. 0x1)
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(1,5);
mat B = randu<mat>(5,1);
mat C = randu<mat>(5,5);
cout << A.is_vec() << endl;
cout << B.is_vec() << endl;
cout << C.is_vec() << endl;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#is_empty">.is_empty()</a></li>
<li><a href="#is_square">.is_square()</a></li>
<li><a href="#is_finite">.is_finite()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="imbue"></a>
<b>.imbue( </b>functor<b> )</b>
<br>
<b>.imbue( </b>lambda_function<b> )</b> <i>(C++11 only)</i>
<br>
<ul>
<li>
Member functions of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>Cube</i>
</li>
<br>
<li>
Imbue (fill) with values provided by a functor or lambda function
</li>
<br>
<li>
For matrices, filling is done column-by-column (ie. column 0 is filled, then column 1, ...)
</li>
<br>
<li>
For cubes, filling is done slice-by-slice; each slice is filled column-by-column
</li>
<br>
<li>
Examples:
<ul>
<pre>
// C++11 only example
// need to include <random>
std::mt19937 engine; // Mersenne twister random number engine
std::uniform_real_distribution<double> distr(0.0, 1.0);
mat A(4,5);
A.imbue( [&]() { return distr(engine); } );
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#fill">.fill()</a></li>
<li><a href="#transform">.transform()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Function_object">function object</a> at Wikipedia</li>
<li><a href="http://en.wikipedia.org/wiki/C%2B%2B11#Lambda_functions_and_expressions">C++11 lambda functions</a> at Wikipedia</li>
<li><a href="http://www.cprogramming.com/c++11/c++11-lambda-closures.html">lambda function</a> at cprogramming.com</li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="insert"></a>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>.insert_rows( </b>row_number, X<b> )</b>
<br>
<b>.insert_rows( </b>row_number, number_of_rows <b>)</b>
<br>
<b>.insert_rows( </b>row_number, number_of_rows, set_to_zero <b>)</b>
</td>
<td> </td>
<td style="vertical-align: top;">(member functions of <i>Mat</i> and <i>Col</i>)
</td>
</tr>
<tr>
<td> </td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.insert_cols( </b>col_number<b>,</b> X<b> )</b>
<br>
<b>.insert_cols( </b>col_number<b>,</b> number_of_cols <b>)</b>
<br>
<b>.insert_cols( </b>col_number<b>,</b> number_of_cols<b>,</b> set_to_zero <b>)</b>
</td>
<td> </td>
<td style="vertical-align: top;">(member functions of <i>Mat</i> and <i>Row</i>)
</td>
</tr>
<tr>
<td> </td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.insert_slices( </b>slice_number<b>,</b> X<b> )</b>
<br>
<b>.insert_slices( </b>slice_number<b>,</b> number_of_slices <b>)</b>
<br>
<b>.insert_slices( </b>slice_number<b>,</b> number_of_slices<b>,</b> set_to_zero <b>)</b>
</td>
<td> </td>
<td style="vertical-align: top;">(member functions of <i>Cube</i>)
</td>
</tr>
</tbody>
</table>
<br>
<ul>
<li>
Functions with the <i>X</i> argument: insert a copy of <i>X</i> at the specified row/column/slice
<ul>
<li>if inserting rows, <i>X</i> must have the same number of columns as the recipient object</li>
<li>if inserting columns, <i>X</i> must have the same number of rows as the recipient object</li>
<li>if inserting slices, <i>X</i> must have the same number of rows and columns as the recipient object (ie. all slices must have the same size)</li>
</ul>
</li>
<br>
<li>
Functions with the <i>number_of_...</i> argument: expand the object by creating new rows/columns/slices.
By default, the new rows/columns/slices are set to zero.
If <i>set_to_zero</i> is <i>false</i>, the memory used by the new rows/columns/slices will not be initialised.
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,10);
mat B = ones<mat>(5,2);
// at column 2, insert a copy of B;
// A will now have 12 columns
A.insert_cols(2, B);
// at column 1, insert 5 zeroed columns;
// B will now have 7 columns
B.insert_cols(1, 5);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#shed">shed_rows/columns/slices</a></li>
<li><a href="#join">join_rows/columns/slices</a></li>
<li><a href="#resize_member">.resize()</a></li>
<li><a href="#submat">submatrix views</a></li>
<li><a href="#subcube">subcube views</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="iterators_mat"></a>
<b>iterators (matrices & vectors)</b>
<ul>
<li>
STL-style iterators and associated member functions of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>SpMat</i>
</li>
<br>
<li>
Member functions:
<br>
<br>
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>.begin()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
iterator referring to the first element
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.end()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
iterator referring to the <i>past-the-end</i> element
</td>
</tr>
<tr>
<td>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.begin_row( row_number )</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
iterator referring to the first element of the specified row
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.end_row( row_number )</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
iterator referring to the <i>past-the-end</i> element of the specified row
</td>
</tr>
<tr>
<td>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.begin_col( col_number )</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
iterator referring to the first element of the specified column
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.end_col( col_number )</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
iterator referring to the <i>past-the-end</i> element of the specified column
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
Iterator types:
<br>
<br>
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>mat::iterator</b>
<br>
<b>vec::iterator</b>
<br>
<b>rowvec::iterator</b>
<br>
<b>sp_mat::iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
random access iterators, for read/write access to elements
(which are stored column by column)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>mat::const_iterator</b>
<br>
<b>vec::const_iterator</b>
<br>
<b>rowvec::const_iterator</b>
<br>
<b>sp_mat::const_iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
random access iterators, for read-only access to elements
(which are stored column by column)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>mat::col_iterator</b>
<br>
<b>vec::col_iterator</b>
<br>
<b>rowvec::col_iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
random access iterators, for read/write access to the elements of a specific column
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>mat::const_col_iterator</b>
<br>
<b>vec::const_col_iterator</b>
<br>
<b>rowvec::const_col_iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
random access iterators, for read-only access to the elements of a specific column
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>mat::row_iterator</b>
<br>
<b>sp_mat::row_iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
rudimentary forward iterator, for read/write access to the elements of a specific row
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>mat::const_row_iterator</b>
<br>
<b>sp_mat::const_row_iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
rudimentary forward iterator, for read-only access to the elements of a specific row
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>vec::row_iterator</b>
<br>
<b>rowvec::row_iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
random access iterators, for read/write access to the elements of a specific row
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>vec::const_row_iterator</b>
<br>
<b>rowvec::const_row_iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
random access iterators, for read-only access to the elements of a specific row
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(5,5);
mat::iterator a = X.begin();
mat::iterator b = X.end();
for(mat::iterator i=a; i!=b; ++i)
{
cout << *i << endl;
}
mat::col_iterator c = X.begin_col(1); // start of column 1
mat::col_iterator d = X.end_col(3); // end of column 3
for(mat::col_iterator i=c; i!=d; ++i)
{
cout << *i << endl;
(*i) = 123.0;
}
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#stl_container_fns">STL-style container functions</a></li>
<li><a href="http://cplusplus.com/reference/std/iterator/">iterator at cplusplus.com</a></li>
<li><a href="#element_access">element access</a></li>
<li><a href="#memptr">.memptr()</a></li>
<li><a href="#colptr">.colptr()</a></li>
<li><a href="#submat">submatrix views</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="iterators_cube"></a>
<b>iterators (cubes)</b>
<ul>
<li>
STL-style iterators and associated member functions of <i>Cube</i>
</li>
<br>
<li>
Member functions:
<br>
<br>
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>.begin()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
iterator referring to the first element
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.end()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
iterator referring to the <i>past-the-end</i> element
</td>
</tr>
<tr>
<td>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.begin_slice( slice_number )</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
iterator referring to the first element of the specified slice
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.end_slice( slice_number )</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
iterator referring to the <i>past-the-end</i> element of the specified slice
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
Iterator types:
<br>
<br>
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>cube::iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
random access iterator, for read/write access to elements;
the elements are ordered slice by slice;
the elements within each slice are ordered column by column
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>cube::const_iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
random access iterators, for read-only access to elements
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>cube::slice_iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
random access iterator, for read/write access to the elements of a particular slice;
the elements are ordered column by column
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>cube::const_slice_iterator</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
random access iterators, for read-only access to the elements of a particular slice
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
cube X = randu<cube>(2,3,4);
cube::iterator a = X.begin();
cube::iterator b = X.end();
for(cube::iterator i=a; i!=b; ++i)
{
cout << *i << endl;
}
cube::slice_iterator c = X.begin_slice(1); // start of slice 1
cube::slice_iterator d = X.end_slice(2); // end of slice 2
for(cube::slice_iterator i=c; i!=d; ++i)
{
cout << *i << endl;
(*i) = 123.0;
}
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="http://cplusplus.com/reference/std/iterator/">iterator at cplusplus.com</a></li>
<li><a href="#element_access">element access</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="memptr"></a>
<b>.memptr()</b>
<ul>
<li>
Member function of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>Cube</i>
</li>
<br>
<li>
Obtain a raw pointer to the memory used for storing elements. Not recommended for use unless you know what you're doing!
</li>
<br>
<li>
The function can be used for interfacing with libraries such as <a href="http://www.fftw.org/">FFTW</a>
</li>
<br>
<li>
As soon as the size of the matrix/vector/cube is changed, the pointer is no longer valid
</li>
<br>
<li>
Data for matrices is stored in a column-by-column order
</li>
<br>
<li>
Data for cubes is stored in a slice-by-slice (matrix-by-matrix) order
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
const mat B = randu<mat>(5,5);
double* A_mem = A.memptr();
const double* B_mem = B.memptr();
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#colptr">.colptr()</a></li>
<li><a href="#element_access">element_access</a></li>
<li><a href="#iterators_mat">iterators (matrices)</a></li>
<li><a href="#iterators_cube">iterators (cubes)</a></li>
<li><a href="#adv_constructors_mat">advanced constructors (matrices)</a></li>
<li><a href="#adv_constructors_cube">advanced constructors (cubes)</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="min_and_max_member"></a>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>.min()</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member functions of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>SpMat</i>, <i>Cube</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.max()</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;"> </td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.min(</b> index_of_min_val <b>)</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member functions of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>SpMat</i>, <i>Cube</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.max(</b> index_of_max_val <b>)</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;"> </td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.min(</b> row_of_min_val<b>,</b> col_of_min_val <b>)</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member functions of <i>Mat</i> and <i>SpMat</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.max(</b> row_of_max_val<b>,</b> col_of_max_val <b>)</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;"> </td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.min(</b> row_of_min_val<b>,</b> col_of_min_val<b>,</b> slice_of_min_val <b>)</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member functions of <i>Cube</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.max(</b> row_of_max_val<b>,</b> col_of_max_val<b>,</b> slice_of_max_val <b>)</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">
</td>
</tr>
</tbody>
</table>
<ul>
<br>
<li>
Without arguments: return the extremum value of an object
</li>
<br>
<li>
With one or more arguments: return the extremum value of an object and store the location of the extremum value in the provided variable(s)
</li>
<br>
<li>
The provided variables must be of type <a href="#uword">uword</a>.
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec v = randu<vec>(10);
cout << "min value is " << v.min() << endl;
uword index;
double min_val = v.min(index);
cout << "index of min value is " << index << endl;
mat A = randu<mat>(5,5);
uword row;
uword col;
double min_val2 = A.max(row,col);
cout << "max value is at " << row << ',' << col << endl;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#min_and_max">min() & max()</a> (standalone functions)</li>
<li><a href="#running_stat">running_stat</a></li>
<li><a href="#running_stat_vec">running_stat_vec</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="ones_member"></a>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>.ones()</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>Cube</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.ones( n_elem )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Col</i> and <i>Row</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.ones( n_rows, n_cols )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.ones( n_rows, n_cols, n_slices )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Cube</i>)
</td>
</tr>
</tbody>
</table>
<ul>
<li>
Set all the elements of an object to one, optionally first resizing to specified dimensions
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,10);
A.ones(); // sets all elements to one
A.ones(10,20); // sets the size to 10 rows and 20 columns
// followed by setting all elements to one
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#ones_standalone">ones()</a> (standalone function)</li>
<li><a href="#eye_member">.eye()</a></li>
<li><a href="#zeros_member">.zeros()</a></li>
<li><a href="#fill">.fill()</a></li>
<li><a href="#imbue">.imbue()</a></li>
<li><a href="#randu_randn_member">.randu()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="operators"></a>
<b>operators: + - * / % == != <= >= < ></b>
<ul>
<li>
Overloaded operators for <i>mat</i>, <i>vec</i>, <i>rowvec</i> and <i>cube</i> classes
</li>
<br>
<li>
Meanings:
<br>
<br>
<ul>
<table style="text-align: left; width: 100%;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>+</b></td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">Addition of two objects</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>-</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">Subtraction of one object from another or negation of an object</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>/</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">Element-wise division of an object by another object or a scalar</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>*</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">Matrix multiplication of two objects; not applicable to the <i>cube</i> class unless multiplying a cube by a scalar</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>%</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;"><a name="schur_product"></a>Schur product: element-wise multiplication of two objects</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>==</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">Element-wise equality evaluation of two objects; generates a matrix of type <i>umat</i> with entries that indicate whether at a given position the two elements from the two objects are equal (1) or not equal (0)</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>!=</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">Element-wise non-equality evaluation of two objects</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>>=</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">As for ==, but the check is for "greater than or equal to"</td>
</tr>
<tr>
<td style="vertical-align: top;"><b><=</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">As for ==, but the check is for "less than or equal to"</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>></b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">As for ==, but the check is for "greater than"</td>
</tr>
<tr>
<td style="vertical-align: top;"><b><</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">As for ==, but the check is for "less than"</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
A <i>std::logic_error</i> exception is thrown if incompatible object sizes are used
</li>
<br>
<li>
If the +, - and % operators are chained, Armadillo will try to avoid the generation of temporaries;
no temporaries are generated if all given objects are of the same type and size
</li>
<br>
<li>
If the * operator is chained, Armadillo will try to find an efficient ordering of the matrix multiplications
</li>
<br>
<li>
<b>Caveat:</b> operators involving an equality comparison (ie., ==, !=, >=, <=)
may not work as expected for floating point element types (ie., <i>float</i>, <i>double</i>)
due to the necessarily limited precision of these types;
in other words, these operators are (in general) not recommended for matrices of type <i>mat</i> or <i>fmat</i>
</li>
<br>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,10);
mat B = randu<mat>(5,10);
mat C = randu<mat>(10,5);
mat P = A + B;
mat Q = A - B;
mat R = -B;
mat S = A / 123.0;
mat T = A % B;
mat U = A * C;
// V is constructed without temporaries
mat V = A + B + A + B;
imat AA = "1 2 3; 4 5 6; 7 8 9;";
imat BB = "3 2 1; 6 5 4; 9 8 7;";
// compare elements
umat ZZ = (AA >= BB);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#accu">accu()</a></li>
<li><a href="#as_scalar">as_scalar()</a></li>
<li><a href="#find">find()</a></li>
<li><a href="#transform">.transform()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="print"></a>
<b>.print()</b>
<br><b>.print( header )</b>
<br>
<br><b>.print( stream )</b>
<br><b>.print( stream, header )</b>
<ul>
<li>
Member functions of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>SpMat</i>, <i>Cube</i> and <i>field</i>
</li>
<br>
<li>
Print the contents of an object to the <i>std::cout</i> stream (default),
or a user specified stream, with an optional header string
</li>
<br>
<li>
Objects can also be printed using the << stream operator
</li>
<br>
<li>
Elements of a field can only be printed if there is an associated <i>operator<<</i> function defined
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = randu<mat>(6,6);
A.print();
// print a transposed version of A
A.t().print();
// "B:" is the optional header line
B.print("B:");
cout << A << endl;
cout << "B:" << endl;
cout << B << endl;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#raw_print">.raw_print()</a></li>
<li><a href="#save_load_mat">saving & loading matrices</a></li>
<li><a href="#element_initialisation">initialising elements</a></li>
<li><a href="#logging">logging of errors and warnings</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="raw_print"></a>
<b>.raw_print()</b>
<br><b>.raw_print( header )</b>
<br>
<br><b>.raw_print( stream )</b>
<br><b>.raw_print( stream, header )</b>
<ul>
<li>
Member functions of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>SpMat</i> and <i>Cube</i>
</li>
<br>
<li>
Similar to the <a href="#print">.print()</a> member function,
with the difference that no formatting of the output is done -- ie. the user can set the stream's parameters such as precision, cell width, etc.
</li>
<br>
<li>
If the cell width is set to zero, a space is printed between the elements
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
cout.precision(11);
cout.setf(ios::fixed);
A.raw_print(cout, "A =");
</pre>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="randu_randn_member"></a>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>.randu()</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>Cube</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.randu( n_elem )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Col</i> and <i>Row</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.randu( n_rows, n_cols )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.randu( n_rows, n_cols, n_slices )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Cube</i>)
</td>
</tr>
</tbody>
</table>
<br>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>.randn()</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>Cube</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.randn( n_elem )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Col</i> and <i>Row</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.randn( n_rows, n_cols )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.randn( n_rows, n_cols, n_slices )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Cube</i>)
</td>
</tr>
</tbody>
</table>
<ul>
<li>
Set all the elements to random values, optionally first resizing to specified dimensions
</li>
<br>
<li><i>.randu()</i> uses a uniform distribution in the [0,1] interval
</li>
<br>
<li><i>.randn()</i> uses a normal/Gaussian distribution with zero mean and unit variance
</li>
<br>
<li>
To change the RNG seed, use <i>arma_rng::set_seed(value)</i> or <i>arma_rng::set_seed_random()</i> functions
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A(4,5);
A.randu();
mat B;
B.randu(6,7);
arma_rng::set_seed_random(); // set the seed to a random value
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#randu_randn_standalone">randu() & randn()</a> (standalone functions)</li>
<li><a href="#fill">.fill()</a></li>
<li><a href="#imbue">.imbue()</a></li>
<li><a href="#ones_member">.ones()</a></li>
<li><a href="#zeros_member">.zeros()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Uniform_distribution_(continuous)">uniform distribution in Wikipedia</a></li>
<li><a href="http://en.wikipedia.org/wiki/Normal_distribution">normal distribution in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="reset"></a>
<b>
.reset()
</b>
<ul>
<li>
Causes an object to have no elements
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5, 5);
A.reset();
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#set_size">.set_size()</a></li>
<li><a href="#is_empty">.is_empty()</a></li>
<li><a href="#zeros_member">.zeros()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="reshape_member"></a>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>.reshape( n_rows, n_cols )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.reshape( n_rows, n_cols, n_slices )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Cube</i>)
</td>
</tr>
</tbody>
</table>
<br>
<ul>
<li>
Recreate the object according to given size specifications,
with the elements taken from the previous version of the object in a column-wise manner;
the elements in the generated object are placed column-wise (ie. the first column is filled up before filling the second column)
</li>
<br>
<li>
The layout of the elements in the recreated object will be different to the layout in the previous version of the object
</li>
<br>
<li>
The new total number of elements (according to the specified size) doesn't have to be the same as the previous total number of elements in the object
</li>
<br>
<li>
If the total number of elements in the previous version of the object is less than the specified size,
the extra elements in the recreated object are set to zero
</li>
<br>
<li>
If the total number of elements in the previous version of the object is greater than the specified size,
only a subset of the elements is taken
</li>
<br>
<li>
<b>Caveat:</b>
do not use <i>.reshape()</i> if you simply want to change the size without preserving data;
use <a href="#set_size">.set_size()</a> instead, which is much faster
</li>
<br>
<li>
<b>Caveat:</b>
if you wish to grow/shrink the object while preserving the elements <b>as well as</b> the layout of the elements,
use <a href="#resize_member">.resize()</a> instead
</li>
<br>
<li>
<b>Caveat:</b>
if you want to create a vector representation of a matrix (ie. concatenate all the columns or rows),
use <a href="#vectorise">vectorise()</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
A.reshape(5,4);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#resize_member">.resize()</a></li>
<li><a href="#set_size">.set_size()</a></li>
<li><a href="#copy_size">.copy_size()</a></li>
<li><a href="#zeros_member">.zeros()</a></li>
<li><a href="#reset">.reset()</a></li>
<li><a href="#reshape">reshape()</a> (standalone function)</li>
<li><a href="#vectorise">vectorise()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="resize_member"></a>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>.resize( n_elem )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Col</i>, <i>Row</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.resize( n_rows, n_cols )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.resize( n_rows, n_cols, n_slices )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Cube</i>)
</td>
</tr>
</tbody>
</table>
<br>
<ul>
<li>
Recreate the object according to given size specifications, while preserving the elements as well as the layout of the elements
</li>
<br>
<li>
Can be used for growing or shrinking an object (ie. adding/removing rows, and/or columns, and/or slices)
</li>
<br>
<li>
<b>Caveat:</b>
do not use <i>.resize()</i> if you simply want to change the size without preserving data;
use <a href="#set_size">.set_size()</a> instead, which is much faster
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
A.resize(7,6);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#reshape_member">.reshape()</a></li>
<li><a href="#set_size">.set_size()</a></li>
<li><a href="#copy_size">.copy_size()</a></li>
<li><a href="#zeros_member">.zeros()</a></li>
<li><a href="#reset">.reset()</a></li>
<li><a href="#insert">insert rows/cols/slices</a></li>
<li><a href="#shed">shed rows/cols/slices</a></li>
<li><a href="#resize">resize()</a> (standalone function)</li>
<li><a href="#vectorise">vectorise()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="save_load_mat"></a>
<b>
.save( name )
<br>.save( name, file_type )
<br>
<br>.save( stream )
<br>.save( stream, file_type )
<br>
<br>.load( name )
<br>.load( name, file_type )
<br>
<br>.load( stream )
<br>.load( stream, file_type )
<br>
<br>.quiet_save( name )
<br>.quiet_save( name, file_type )
<br>
<br>.quiet_save( stream )
<br>.quiet_save( stream, file_type )
<br>
<br>.quiet_load( name )
<br>.quiet_load( name, file_type )
<br>
<br>.quiet_load( stream )
<br>.quiet_load( stream, file_type )
</b>
<ul>
<li>Member functions of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>Cube</i></li>
<br>
<li>Store/retrieve data in files or streams</li>
<br>
<li>
The default <i>file_type</i> for <i>.save()</i> and <i>.quiet_save()</i> is <i>arma_binary</i> (see below)
</li>
<br>
<li>
The default <i>file_type</i> for <i>.load()</i> and <i>.quiet_load()</i> is <i>auto_detect</i> (see below)
</li>
<br>
<li>On success, <i>save()</i>, <i>load()</i>, <i>quiet_save()</i>, and <i>quite_load()</i> will return a <i>bool</i> set to <i>true</i></li>
<br>
<li><i>save()</i> and <i>quiet_save()</i> will return a <i>bool</i> set to <i>false</i> if the saving process fails</li>
<br>
<li>
<i>load()</i> and <i>quiet_load()</i> will return a <i>bool</i> set to <i>false</i> if the loading process fails;
additionally, the object will be reset so it has no elements
</li>
<br>
<li><i>load()</i> and <i>save()</i> will print warning messages if any problems are encountered</li>
<br>
<li><i>quiet_load()</i> and <i>quiet_save()</i> do not print any error messages</li>
<br>
<li>
<i>file_type</i> can be one of the following:
<br>
<br>
<ul>
<table style="text-align: left; width: 100%;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>auto_detect</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
Used by <i>load()</i> and <i>quiet_load()</i> only:
try to automatically detect the file type as one of the formats described below.
This is the default operation.
<br>
<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>raw_ascii</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
Numerical data stored in raw ASCII format, without a header.
The numbers are separated by whitespace.
The number of columns must be the same in each row.
Cubes are loaded as one slice.
Data which was saved in Matlab/Octave using the <i>-ascii</i> option can be read in Armadillo, except for complex numbers.
Complex numbers are stored in standard C++ notation, which is a tuple surrounded by brackets: eg. (1.23,4.56) indicates 1.24 + 4.56i.
<br>
<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>raw_binary</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
Numerical data stored in machine dependent raw binary format, without a header.
Matrices are loaded to have one column,
while cubes are loaded to have one slice with one column.
The <a href="#reshape_member">.reshape()</a> function can be used to alter the size of the loaded matrix/cube without losing data.
<br>
<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>arma_ascii</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
Numerical data stored in human readable text format, with a simple header to speed up loading.
The header indicates the type of matrix as well as the number of rows and columns.
For cubes, the header additionally specifies the number of slices.
<br>
<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>arma_binary</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
Numerical data stored in machine dependent binary format, with a simple header to speed up loading.
The header indicates the type of matrix as well as the number of rows and columns.
For cubes, the header additionally specifies the number of slices.
<i>arma_binary</i> is the default <i>file_type</i> for <i>.save()</i> and <i>.quiet_save()</i>
<br>
<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>csv_ascii</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
Numerical data stored in comma separated value (CSV) text format, without a header.
Applicable to <i>Mat</i> only.
<br>
<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>hdf5_binary</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
Numerical data stored in portable HDF5 binary format.
<br>
<b>Caveat</b>:
support for HDF5 must be enabled within Armadillo's <a href="#config_hpp">configuration</a>;
the <i>hdf5.h</i> header file must be available on your system and you will need to link with the hdf5 library (eg. -lhdf5)
<br>
<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>pgm_binary</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
Image data stored in Portable Gray Map (PGM) format.
Applicable to <i>Mat</i> only.
Saving <i>int</i>, <i>float</i> or <i>double</i> matrices is a lossy operation, as each element is copied and converted to an 8 bit representation.
As such the matrix should have values in the [0,255] interval, otherwise the resulting image may not display correctly.
<br>
<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>ppm_binary</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
Image data stored in Portable Pixel Map (PPM) format.
Applicable to <i>Cube</i> only.
Saving <i>int</i>, <i>float</i> or <i>double</i> matrices is a lossy operation, as each element is copied and converted to an 8 bit representation.
As such the cube/field should have values in the [0,255] interval, otherwise the resulting image may not display correctly.
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
A.save("A1.mat"); // default save format is arma_binary
A.save("A2.mat", arma_ascii);
mat B;
// automatically detect format type
B.load("A1.mat");
mat C;
// force loading in the arma_ascii format
C.load("A2.mat", arma_ascii);
// example of saving/loading using a stream
std::stringstream s;
A.save(s);
mat D;
D.load(s);
// example of testing for success
mat E;
bool status = E.load("A2.mat");
if(status == true)
{
cout << "loaded okay" << endl;
}
else
{
cout << "problem with loading" << endl;
}
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#save_load_field">saving/loading fields</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="save_load_field"></a>
<b>
.save( name,</b> file_type = arma_binary <b>)
<br>
.save( stream,</b> file_type = arma_binary <b>)
<br>
<br>
.load( name,</b> file_type = auto_detect <b>)
<br>
.load( stream,</b> file_type = auto_detect <b>)
<br>
<br>
.quiet_save( name,</b> file_type = arma_binary <b>)
<br>
.quiet_save( stream,</b> file_type = arma_binary <b>)
<br>
<br>
.quiet_load( name,</b> file_type = auto_detect <b>)
<br>
.quiet_load( stream,</b> file_type = auto_detect <b>)
</b>
<ul>
<li>Member functions of <i>field</i></li>
<br>
<li>Store/retrieve fields in files or stream</li>
<br>
<li>On success, <i>save()</i>, <i>load()</i>, <i>quiet_save()</i>, and <i>quite_load()</i> will return a <i>bool</i> set to <i>true</i></li>
<br>
<li><i>save()</i> and <i>quiet_save()</i> will return a <i>bool</i> set to <i>false</i> if the saving process fails</li>
<br>
<li>
<i>load()</i> and <i>quiet_load()</i> will return a <i>bool</i> set to <i>false</i> if the loading process fails;
additionally, the field will be reset so it has no elements
</li>
<br>
<li><i>load()</i> and <i>save()</i> will print warning messages if any problems are encountered</li>
<br>
<li><i>quiet_load()</i> and <i>quiet_save()</i> do not print any error messages</li>
<br>
<li>
Fields with objects of type <i>std::string</i> are saved and loaded as raw text files.
The text files do not have a header.
Each string is separated by a whitespace.
<i>load()</i> and <i>quiet_load()</i> will only accept text files that have the same number of strings on each line.
The strings can have variable lengths.
</li>
<br>
<li>
Other than storing string fields as text files, the following file formats are supported:
<br>
<br>
<ul>
<table style="text-align: left; width: 100%;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>auto_detect</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
<br>
<li>
load(): try to automatically detect the field format type as one of the formats described below;
this is the default operation.
</li>
<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>arma_binary</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
<br>
<li>
Objects are stored in machine dependent binary format
<li>
Default type for fields of type <i>Mat</i>, <i>Col</i>, <i>Row</i> or <i>Cube</i>
</li>
<li>
Only applicable to fields of type <i>Mat</i>, <i>Col</i>, <i>Row</i> or <i>Cube</i>
</li>
<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>ppm_binary</b></td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
<br>
<li>
Image data stored in Portable Pixmap Map (PPM) format.
</li>
<li>
Only applicable to fields of type <i>Mat</i>, <i>Col</i> or <i>Row</i>
</li>
<li>
<i>.load()</i>: loads the specified image and stores the red, green and blue components as three separate matrices;
the resulting field is comprised of the three matrices,
with the red, green and blue components in the first, second and third matrix, respectively
</li>
<li>
<i>.save()</i>: saves a field with exactly three matrices of equal size as an image;
it is assumed that the red, green and blue components are stored in the first, second and third matrix, respectively;
saving <i>int</i>, <i>float</i> or <i>double</i> matrices is a lossy operation,
as each matrix element is copied and converted to an 8 bit representation
</li>
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#save_load_mat">saving/loading matrices and cubes</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="set_imag"></a>
<b>.set_imag( X )</b>
<br>
<b>.set_real( X )</b>
<br>
<ul>
<li>Member functions of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>Cube</i></li>
<br>
<li>
Set the imaginary/real part of an object
</li>
<br>
<li>
<i>X</i> must have the same size as the recipient object
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
mat B = randu<mat>(4,5);
cx_mat C = zeros<cx_mat>(4,5);
C.set_real(A);
C.set_imag(B);
</pre>
</ul>
</li>
<br>
<li>
<b>Caveat:</b>
if you want to directly construct a complex matrix out of two real matrices,
the following code is faster:
<ul>
<pre>
mat A = randu<mat>(4,5);
mat B = randu<mat>(4,5);
cx_mat C = cx_mat(A,B);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#constructors_mat">matrix constructors</a></li>
<li><a href="#constructors_cube">cube constructors</a></li>
<li><a href="#imag_real">imag() / real()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="set_size"></a>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>.set_size( n_elem )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Col</i>, <i>Row</i>, and <i>field</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.set_size( n_rows, n_cols )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i>, <i>SpMat</i> and <i>field</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.set_size( n_rows, n_cols, n_slices )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Cube</i>)
</td>
</tr>
</tbody>
</table>
<br>
<ul>
<li>Changes the size of an object</li>
<br>
<li>
If the requested number of elements is <b>equal</b> to the old number of elements, existing memory is reused (not applicable to <i>SpMat</i>)
</li>
<br>
<li>
If the requested number of elements is <b>not equal</b> to the old number of elements, old memory is freed and new memory is allocated;
the memory is uninitialised; if you need to initialise the memory, use <a href="#zeros_member">.zeros()</a> instead
</li>
<br>
<li>
If you need to explicitly preserve data while changing the size, use <a href="#reshape_member">.reshape()</a> or <a href="#resize_member">.resize()</a> instead;
<b>caveat</b>: <i>.reshape()</i> and <i>.resize()</i> are considerably slower than <i>.set_size()</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A;
A.set_size(5,10);
vec q;
q.set_size(100);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#reset">.reset()</a></li>
<li><a href="#copy_size">.copy_size()</a></li>
<li><a href="#reshape_member">.reshape()</a></li>
<li><a href="#resize_member">.resize()</a></li>
<li><a href="#zeros_member">.zeros()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="shed"></a>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>.shed_row( </b>row_number<b> )</b>
<br>
<b>.shed_rows( </b>first_row, last_row<b> )</b>
</td>
<td> </td>
<td style="vertical-align: top;">(member functions of <i>Mat</i>, <i>Col</i> and <i>SpMat</i>)
</td>
</tr>
<tr>
<td> </td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.shed_col( </b>column_number<b> )</b>
<br>
<b>.shed_cols( </b>first_column, last_column<b> )</b>
</td>
<td> </td>
<td style="vertical-align: top;">(member functions of <i>Mat</i>, <i>Row</i> and <i>SpMat</i>)
</td>
</tr>
<tr>
<td> </td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.shed_slice( </b>slice_number<b> )</b>
<br>
<b>.shed_slices( </b>first_slice, last_slice<b> )</b>
</td>
<td> </td>
<td style="vertical-align: top;">(member functions of <i>Cube</i>)
</td>
</tr>
</tbody>
</table>
<br>
<ul>
<li>
Single argument functions:
remove the specified row/column/slice
</li>
<br>
<li>
Two argument functions:
remove the specified range of rows/columns/slices
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,10);
A.shed_row(2);
A.shed_cols(2,4);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#insert">insert_rows/columns/slices</a></li>
<li><a href="#join">join_rows/columns/slices</a></li>
<li><a href="#resize_member">.resize()</a></li>
<li><a href="#submat">submatrix views</a></li>
<li><a href="#subcube">subcube views</a></li>
<li><a href="http://thesaurus.com/browse/shed"><i>shed</i> in thesaurus.com</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="stl_container_fns"></a>
<b>STL-style container functions</b>
<ul>
<li>Member functions that mimic the containers in the C++ Standard Template Library:<br>
<br>
<table style="text-align: left; width: 100%;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>.clear()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
causes an object to have no elements
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.empty()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
returns <i>true</i> if the object has no elements; returns <i>false</i> if the object has one or more elements
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>.size()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
returns the total number of elements
</td>
</tr>
</tbody>
</table>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
cout << A.size() << endl;
A.clear();
cout << A.empty() << endl;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#iterators_mat">iterators (matrices)</a></li>
<li><a href="#attributes">matrix and vector attributes</a></li>
<li><a href="#is_empty">.is_empty()</a></li>
<li><a href="#reset">.reset()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="submat"></a>
<b>submatrix views</b>
<ul>
<li>A collection of member functions of <i>Mat</i>, <i>Col</i> and <i>Row</i> classes that provide read/write access to submatrix views<br>
<br>
<li>For a matrix or vector <i>X</i>, the subviews are accessed as:</li>
<br>
<ul>
<li>contiguous views:
<ul>
<br>
X.<b>col( </b>col_number<b> )</b><br>
X.<b>row( </b>row_number<b> )</b><br>
<br>
X.<b>cols( </b>first_col<b>,</b> last_col<b> )</b><br>
X.<b>rows( </b>first_row<b>,</b> last_row<b> )</b><br>
<br>
X.<b>submat( </b>first_row<b>,</b> first_col<b>,</b> last_row<b>,</b> last_col<b> )</b><br>
<br>
X<b>( span(</b>first_row<b>,</b> last_row<b>), span(</b>first_col<b>,</b> last_col<b>) )</b><br>
<br>
X<b>( </b>first_row<b>,</b> first_col<b>, size(</b>n_rows<b>, </b>n_cols<b>) )</b><br>
X<b>( </b>first_row<b>,</b> first_col<b>, size(</b>Y<b>) )</b> <i>(Y is a mat)</i><br>
<br>
X<b>(</b> <b>span::all,</b> col_number <b>)</b><br>
X<b>(</b> <b>span(</b>first_row<b>,</b> last_row<b>),</b> col_number <b>)</b><br>
<br>
X<b>(</b> row_number<b>,</b> <b>span::all</b> <b>)</b><br>
X<b>(</b> row_number<b>,</b> <b>span(</b>first_col<b>,</b> last_col<b>) )</b><br>
<br>
X.<b>unsafe_col( </b>col_number<b> )</b><br>
<br>
V<b>( span(</b>first_index<b>,</b> last_index<b>) )</b> <i>(for vectors only)</i><br>
V.<b>subvec( </b>first_index<b>,</b> last_index<b> )</b> <i>(for vectors only)</i><br>
</ul>
</li>
<br>
<li>non-contiguous views:
<ul>
<br>
X.<b>elem(</b> vector_of_indices <b>)</b><br>
X<b>(</b> vector_of_indices <b>)</b><br>
<br>
X.<b>cols( </b>vector_of_column_indices<b> )</b><br>
X.<b>rows( </b>vector_of_row_indices<b> )</b><br>
<br>
X.<b>submat(</b> vector_of_row_indices<b>,</b> vector_of_column_indices <b>)</b><br>
X<b>(</b> vector_of_row_indices<b>,</b> vector_of_column_indices <b>)</b><br>
<!--X.<b>elem(</b> vector_of_row_indices<b>,</b> vector_of_column_indices <b>)</b><br>-->
</ul>
</li>
<br>
<li>related views (documented separately)
<ul>
<br>
X.<a href="#diag">diag()</a><br>
X.<a href="#each_colrow">each_row()</a><br>
X.<a href="#each_colrow">each_col()</a><br>
</ul>
</li>
</ul>
<br>
<li>
Instances of <i>span::all</i>, to indicate an entire range, can be replaced by <i>span()</i>, where no number is specified
</li>
<br>
<li>
For functions requiring one or more vector of indices,
eg. <i>X.submat(vector_of_row_indices,vector_of_column_indices)</i>,
each vector of indices must be of type <i><a href="#Col">uvec</a></i>.
</li>
<br>
<li>
In the function <i>X.elem(vector_of_indices)</i>,
elements specified in <i>vector_of_indices</i> are accessed.
<i>X</i> is interpreted as one long vector,
with column-by-column ordering of the elements of <i>X</i>.
The <i>vector_of_indices</i> must evaluate to be a vector of type <i><a href="#Col">uvec</a></i>
(eg., generated by <i><a href="#find">find()</a></i>).
The aggregate set of the specified elements is treated as a column vector
(ie., the output of <i>X.elem()</i> is always a column vector).
</li>
<br>
<li>
The function <i>.unsafe_col()</i> is provided for speed reasons and should be used only if you know what you're doing.
The function creates a seemingly independent <i>Col</i> vector object (eg. <i>vec</i>),
but the vector actually uses memory from the existing matrix object.
As such, the created <i>Col</i> vector is currently not alias safe
and does not take into account that the parent matrix object could be deleted.
If deleted memory is accessed through the created <i>Col</i> vector,
it will cause memory corruption and/or a crash.
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = zeros<mat>(5,10);
A.submat( 0,1, 2,3 ) = randu<mat>(3,3);
A( span(0,2), span(1,3) ) = randu<mat>(3,3);
A( 0,1, size(3,3) ) = randu<mat>(3,3);
mat B = A.submat( 0,1, 2,3 );
mat C = A( span(0,2), span(1,3) );
mat D = A( 0,1, size(3,3) );
A.col(1) = randu<mat>(5,1);
A(span::all, 1) = randu<mat>(5,1);
mat X = randu<mat>(5,5);
// get all elements of X that are greater than 0.5
vec q = X.elem( find(X > 0.5) );
// add 123 to all elements of X greater than 0.5
X.elem( find(X > 0.5) ) += 123.0;
// set four specific elements of X to 1
uvec indices;
indices << 2 << 3 << 6 << 8;
X.elem(indices) = ones<vec>(4);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#diag">diagonal views</a></li>
<li><a href="#each_colrow">.each_col() & .each_row()</a> (vector operations repeated on each column or row)</li>
<li><a href="#colptr">.colptr()</a></li>
<li><a href="#in_range">.in_range()</a></li>
<li><a href="#find">find()</a></li>
<li><a href="#join">join_rows/columns/slices</a></li>
<li><a href="#shed">shed_rows/columns/slices</a></li>
<li><a href="#insert">insert rows/columns/slices</a></li>
<li><a href="#subcube">subcube views</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="subcube"></a>
<b>subcube views and slices</b>
<ul>
<li>A collection of member functions of the <i>Cube</i> class that provide subcube views<br>
<br>
<li>For a cube <i>Q</i>, the subviews are accessed as:</li>
<br>
<ul>
<li>contiguous views:
<br>
<br>
<ul>
Q.<b>slice( </b>slice_number <b>)</b><br>
Q.<b>slices( </b>first_slice<b>,</b> last_slice <b>)</b><br>
<br>
Q.<b>subcube( </b>first_row<b>,</b> first_col<b>,</b> first_slice<b>, </b>last_row<b>,</b> last_col<b>, </b>last_slice <b>)</b><br>
<br>
Q<b>( span(</b>first_row<b>,</b> last_row<b>), span(</b>first_col<b>,</b> last_col<b>), span(</b>first_slice<b>,</b> last_slice<b>) )</b><br>
<br>
Q<b>( </b>first_row<b>,</b> first_col<b>,</b> first_slice<b>, size(</b>n_rows<b>,</b> n_cols<b>, </b>n_slices<b>) )</b><br>
Q<b>( </b>first_row<b>,</b> first_col<b>,</b> first_slice<b>, size(</b>R<b>) )</b> <i>(R is a cube)</i><br>
<br>
Q.<b>tube( </b>row<b>,</b> col <b>)</b><br>
Q.<b>tube( </b>first_row<b>,</b> first_col<b>,</b> last_row<b>,</b> last_col <b>)</b><br>
Q.<b>tube( span(</b>first_row<b>,</b> last_row<b>), span(</b>first_col<b>,</b> last_col<b>) )</b><br>
Q.<b>tube( </b>first_row<b>,</b> first_col<b>, size(</b>n_rows<b>,</b> n_cols<b>) )</b><br>
</ul>
</li>
<br>
<li>non-contiguous views:
<ul>
<br>
Q.<b>elem(</b> vector_of_indices <b>)</b><br>
Q<b>(</b> vector_of_indices <b>)</b>
</ul>
</li>
</ul>
</li>
<br>
<li>
Instances of <i>span(a,b)</i> can be replaced by:
<ul>
<li><i>span()</i> or <i>span::all</i>, to indicate the entire range</li>
<li><i>span(a)</i>, to indicate a particular row, column or slice</li>
</ul>
</li>
<br>
<li>
An individual slice, accessed via <i>.slice()</i>, is an instance of the <i>Mat</i> class
(a reference to a matrix is provided)
</li>
<br>
<li>
All <i>.tube()</i> forms are variants of <i>.subcube()</i>, using <i>first_slice = 0</i> and <i>last_slice = Q.n_slices-1</i>
</li>
<br>
<li>
The <i>.tube(row,col)</i> form uses <i>row = first_row = last_row</i>, and <i>col = first_col = last_col</i>
</li>
<br>
<li>
In the function <i>Q.elem(vector_of_indices)</i>,
elements specified in <i>vector_of_indices</i> are accessed.
<i>Q</i> is interpreted as one long vector,
with slice-by-slice and column-by-column ordering of the elements of <i>Q</i>.
The <i>vector_of_indices</i> must evaluate to be a vector of type <i><a href="#Col">uvec</a></i>
(eg., generated by <i><a href="#find">find()</a></i>).
The aggregate set of the specified elements is treated as a column vector
(ie., the output of <i>Q.elem()</i> is always a column vector).
</li>
<br>
<li>
Examples:
<ul>
<pre>
cube A = randu<cube>(2,3,4);
mat B = A.slice(1);
A.slice(0) = randu<mat>(2,3);
A.slice(0)(1,2) = 99.0;
A.subcube(0,0,1, 1,1,2) = randu<cube>(2,2,2);
A( span(0,1), span(0,1), span(1,2) ) = randu<cube>(2,2,2);
A( 0,0,1, size(2,2,2) ) = randu<cube>(2,2,2);
// add 123 to all elements of A greater than 0.5
A.elem( find(A > 0.5) ) += 123.0;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#in_range">.in_range()</a></li>
<li><a href="#join">join_slices()</a></li>
<li><a href="#shed">shed_slices()</a></li>
<li><a href="#insert">insert_slices()</a></li>
<li><a href="#submat">submatrix views</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="subfield"></a>
<b>subfield views</b>
<ul>
<li>A collection of member functions of the <i>field</i> class that provide subfield views<br>
<br>
<li>For a 2D field <i>F</i>, the subfields are accessed as:</li>
<br>
<ul>
F.<b>row( </b>row_number <b>)</b><br>
F.<b>col( </b>col_number <b>)</b><br>
<br>
F.<b>rows( </b>first_row<b>,</b> last_row <b>)</b><br>
F.<b>cols( </b>first_col<b>,</b> last_col <b>)</b><br>
<br>
F.<b>subfield( </b>first_row<b>,</b> first_col<b>,</b> last_row<b>,</b> last_col <b>)</b><br>
<br>
F<b>( span(</b>first_row<b>,</b> last_row<b>), span(</b>first_col<b>,</b> last_col<b>) )</b><br>
<br>
F<b>( </b>first_row<b>,</b> first_col<b>, size(</b>G<b>) )</b> <i>(G is a 2D field)</i><br>
F<b>( </b>first_row<b>,</b> first_col<b>, size(</b>n_rows<b>, </b>n_cols<b>) )</b><br>
</ul>
<br>
<li>For a 3D field <i>F</i>, the subfields are accessed as:</li>
<br>
<ul>
F.<b>slice( </b>slice_number <b>)</b><br>
<br>
F.<b>slices( </b>first_slice<b>,</b> last_slice <b>)</b><br>
<br>
F.<b>subfield( </b>first_row<b>,</b> first_col<b>,</b> first_slice<b>,</b> last_row<b>,</b> last_col<b>,</b> last_slice <b>)</b><br>
<br>
F<b>( span(</b>first_row<b>,</b> last_row<b>), span(</b>first_col<b>,</b> last_col<b>), span(</b>first_slice<b>,</b> last_slice<b>) )</b><br>
<br>
F<b>( </b>first_row<b>,</b> first_col<b>,</b> first_slice<b>, size(</b>G<b>) )</b> <i>(G is a 3D field)</i><br>
F<b>( </b>first_row<b>,</b> first_col<b>,</b> first_slice<b>, size(</b>n_rows<b>, </b>n_cols<b>, </b>n_slices<b>) )</b><br>
</ul>
</li>
<br>
<li>
Instances of <i>span(a,b)</i> can be replaced by:
<ul>
<li><i>span()</i> or <i>span::all</i>, to indicate the entire range</li>
<li><i>span(a)</i>, to indicate a particular row or column</li>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#in_range">.in_range()</a></li>
<li><a href="#submat">submatrix views</a></li>
<li><a href="#subcube">subcube views</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="swap"></a>
<b>.swap( X )</b>
<ul>
<li>
Member function of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>Cube</i>
</li>
<br>
<li>
Swap contents with object <i>X</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = zeros<mat>(4,5);
mat B = ones<mat>(6,7);
A.swap(B);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#swap_rows">.swap_rows() & .swap_cols()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="swap_rows"></a>
<b>
.swap_rows( row1, row2 )
<br>.swap_cols( col1, col2 )
</b>
<ul>
<li>
Member functions of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>SpMat</i>
</li>
<br>
<li>
Swap the contents of specified rows or columns
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(5,5);
X.swap_rows(0,4);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#flip">fliplr() & flipud()</a></li>
<li><a href="#swap">.swap()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="t_st_members"></a>
<b>
.t()
<br>.st()
</b>
<ul>
<li>
Member functions of any matrix or vector expression
</li>
<br>
<li>
<i>.t()</i> provides a transposed copy of the object; if a given object has complex elements, a Hermitian transpose is done (ie. the conjugate of the elements is taken during the transpose operation)
</li>
<br>
<li>
<i>.st()</i> provides a transposed copy of the object, without taking the conjugate of the elements (complex matrices)
</li>
<br>
<li>
For non-complex objects, the <i>.t()</i> and <i>.st()</i> functions are equivalent
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
mat B = A.t();
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#trans">trans()</a></li>
<li><a href="#strans">strans()</a></li>
<li><a href="#flip">.fliplr() & .flipud()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="transform"></a>
<b>.transform( </b>functor<b> )</b>
<br>
<b>.transform( </b>lambda_function<b> )</b> <i>(C++11 only)</i>
<br>
<ul>
<li>
Member functions of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>Cube</i>
</li>
<br>
<li>
Transform each element using a functor or lambda function
</li>
<br>
<li>
For matrices, transformation is done column-by-column (ie. column 0 is transformed, then column 1, ...)
</li>
<br>
<li>
For cubes, transformation is done slice-by-slice; each slice is transformed column-by-column
</li>
<br>
<li>
Examples:
<ul>
<pre>
// C++11 only example
mat A = ones<mat>(4,5);
// add 123 to every element
A.transform( [](double val) { return (val + 123.0); } );
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#operators">overloaded operators</a></li>
<li><a href="#imbue">.imbue()</a></li>
<li><a href="#fill">.fill()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Function_object">function object</a> at Wikipedia</li>
<li><a href="http://en.wikipedia.org/wiki/C%2B%2B11#Lambda_functions_and_expressions">C++11 lambda functions</a> at Wikipedia</li>
<li><a href="http://www.cprogramming.com/c++11/c++11-lambda-closures.html">lambda function</a> at cprogramming.com</li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="zeros_member"></a>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;"><b>.zeros()</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>SpMat</i>, <i>Cube</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.zeros( n_elem )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Col</i> and <i>Row</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.zeros( n_rows, n_cols )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Mat</i> and <i>SpMat</i>)
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>.zeros( n_rows, n_cols, n_slices )</b></td>
<td style="vertical-align: top;"><br>
</td>
<td> </td>
<td style="vertical-align: top;">(member function of <i>Cube</i>)
</td>
</tr>
</tbody>
</table>
<ul>
<li>
Set the elements of an object to zero, optionally first resizing to specified dimensions
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,10);
A.zeros(); // sets all elements to zero
A.zeros(10,20); // sets the size to 10 rows and 20 columns
// followed by setting all elements to zero
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#zeros_standalone">zeros()</a> (standalone function)</li>
<li><a href="#ones_member">.ones()</a></li>
<li><a href="#randu_randn_member">.randu()</a></li>
<li><a href="#fill">.fill()</a></li>
<li><a href="#imbue">.imbue()</a></li>
<li><a href="#reset">.reset()</a></li>
<li><a href="#set_size">.set_size()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<hr class="greyline">
<br>
<br>
<font size=+1><b>Other Classes</b></font>
<br>
<br>
<hr class="greyline">
<br>
<a name="running_stat"></a>
<b>running_stat<</b><i>type</i><b>></b>
<ul>
<li>
Class for keeping the running statistics of a continuously sampled one dimensional process/signal;
useful if the storage of individual samples (scalars) is not required,
or the number of samples is not known beforehand
</li>
<br>
<li>
<i>type</i> is one of: <i>float</i>, <i>double</i>, <i><a href="#cx_double">cx_float</a></i>, <i><a href="#cx_double">cx_double</a></i>
</li>
<br>
<li>
For an instance of <i>running_stat</i> named as <i>X</i>, the member functions are:
<br>
<br>
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>X(</b>scalar<b>)</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
update the statistics so far using the given scalar
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.min()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the minimum value so far
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.max()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the maximum value so far
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.mean()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the mean or average value so far
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.var()</b> and <b>X.var(</b>norm_type<b>)</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the variance so far
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.stddev()</b> and <b>X.stddev(</b>norm_type<b>)</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the standard deviation so far
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.reset()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
reset all statistics and set the number of samples to zero
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.count()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the number of samples so far
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
The <i>norm_type</i> argument is optional; by default <i>norm_type=0</i> is used
</li>
<br>
<li>
For the <i>.var()</i> and <i>.stddev()</i> functions, the default <i>norm_type=0</i> performs normalisation using <i>N-1</i>
(where <i>N</i> is the number of samples so far),
providing the best unbiased estimator;
using <i>norm_type=1</i> causes normalisation to be done using <i>N</i>, which provides the second moment around the mean
</li>
<br>
<li>
The return type of <i>.count()</i> depends on the underlying form of <i>type</i>: it is either <i>float</i> or <i>double</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
running_stat<double> stats;
for(uword i=0; i<10000; ++i)
{
double sample = randn();
stats(sample);
}
cout << "mean = " << stats.mean() << endl;
cout << "var = " << stats.var() << endl;
cout << "min = " << stats.min() << endl;
cout << "max = " << stats.max() << endl;
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#stats_fns">statistics functions</a></li>
<li><a href="#running_stat_vec">running_stat_vec</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="running_stat_vec"></a>
<b>running_stat_vec<</b><i>vec_type</i><b>></b>
<br><b>running_stat_vec<</b><i>vec_type</i><b>>(calc_cov)</b>
<ul>
<li>
Class for keeping the running statistics of a continuously sampled multi-dimensional process/signal;
useful if the storage of individual samples (vectors) is not required,
or if the number of samples is not known beforehand
</li>
<br>
<li>
This class is similar to <i>running_stat</i>, with the difference that vectors are processed instead of scalars
</li>
<br>
<li>
<i>vec_type</i> is the vector type of the samples; for example: <i><a href="#Col">vec</a></i>, <i><a href="#Col">cx_vec</a></i>, <i><a href="#Row">rowvec</a></i>, ...
</li>
<br>
<li>
For an instance of <i>running_stat_vec</i> named as <i>X</i>, the member functions are:
<br>
<br>
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>X(</b>vector<b>)</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
update the statistics so far using the given vector
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.min()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the vector of minimum values so far
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.max()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the vector of maximum values so far
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.mean()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the mean vector so far
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.var()</b> and <b>X.var(</b>norm_type<b>)</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the vector of variances so far
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.stddev()</b> and <b>X.stddev(</b>norm_type<b>)</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the vector of standard deviations so far
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.cov()</b> and <b>X.cov(</b>norm_type<b>)</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the covariance matrix so far;
valid if <i>calc_cov=true</i> during construction of <i>running_stat_vec</i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.reset()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
reset all statistics and set the number of samples to zero
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>X.count()</b>
</td>
<td style="vertical-align: top;"> <br>
</td>
<td style="vertical-align: top;">
get the number of samples so far
</td>
</tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
The <i>calc_cov</i> argument is optional; by default <i>calc_cov=false</i>, indicating that the covariance matrix will not be calculated;
to enable the covariance matrix, use <i>calc_cov=true</i> during construction; for example: <i>running_stat_vec<vec> X(true);</i>
</li>
<br>
<li>
The <i>norm_type</i> argument is optional; by default <i>norm_type=0</i> is used
</li>
<br>
<li>
For the <i>.var()</i> and <i>.stddev()</i> functions, the default <i>norm_type=0</i> performs normalisation using <i>N-1</i>
(where <i>N</i> is the number of samples so far),
providing the best unbiased estimator;
using <i>norm_type=1</i> causes normalisation to be done using <i>N</i>, which provides the second moment around the mean
</li>
<br>
<li>
The return type of <i>.count()</i> depends on the underlying form of <i>vec_type</i>: it is either <i>float</i> or <i>double</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
running_stat_vec<vec> stats;
vec sample;
for(uword i=0; i<10000; ++i)
{
sample = randu<vec>(5);
stats(sample);
}
cout << "mean = " << endl << stats.mean() << endl;
cout << "var = " << endl << stats.var() << endl;
cout << "max = " << endl << stats.max() << endl;
//
//
running_stat_vec<rowvec> more_stats(true);
for(uword i=0; i<20; ++i)
{
sample = randu<rowvec>(3);
sample(1) -= sample(0);
sample(2) += sample(1);
more_stats(sample);
}
cout << "covariance matrix = " << endl;
cout << more_stats.cov() << endl;
rowvec sd = more_stats.stddev();
cout << "correlations = " << endl;
cout << more_stats.cov() / (sd.t() * sd);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#cov">cov()</a></li>
<li><a href="#cor">cor()</a></li>
<li><a href="#running_stat">running_stat</a></li>
<li><a href="#stats_fns">statistics functions</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="wall_clock"></a>
<b>wall_clock</b>
<ul>
<li>
Simple wall clock timer class, for measuring the number of elapsed seconds between two intervals
</li>
<br>
<li>
Examples:
<ul>
<pre>
wall_clock timer;
mat A = randu<mat>(4,4);
mat B = randu<mat>(4,4);
mat C;
timer.tic();
for(uword i=0; i<100000; ++i)
{
C = A + B + A + B;
}
double n_secs = timer.toc();
cout << "took " << n_secs << " seconds" << endl;
</pre>
</ul>
</li>
</ul>
<br>
<hr class="greyline">
<hr class="greyline">
<br>
<br>
<font size=+1><b>Generated Vectors/Matrices</b></font>
<br>
<br>
<hr class="greyline">
<br>
<a name="eye_standalone"></a>
<b>eye( n_rows, n_cols )</b>
<ul>
<li>
Generate a matrix with the elements along the main diagonal set to one
and off-diagonal elements set to zero
</li>
<br>
<li>
An identity matrix is generated when <i>n_rows</i> = <i>n_cols</i>
</li>
<br>
<li>
Usage:
<ul>
<li>
<i>matrix_type</i> X = eye<<i>matrix_type</i>>(n_rows, n_cols)
</li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = eye<mat>(5,5);
mat B = 123.0 * eye<mat>(5,5);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#eye_member">.eye()</a> (member function of Mat)</li>
<li><a href="#diag">.diag()</a></li>
<li><a href="#ones_standalone">ones()</a></li>
<li><a href="#diagmat">diagmat()</a></li>
<li><a href="#diagvec">diagvec()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="linspace"></a>
<b>linspace( start, end )</b>
<br><b>linspace( start, end, N )</b>
<ul>
<li>
Generate a vector with <i>N</i> elements;
the values of the elements linearly increase from <i>start</i> to (and including) <i>end</i>
</li>
<br>
<li>
By default <i>N = 100</i>
</li>
<br>
<li>
Usage:
<ul>
<li><i>vector_type</i> v = linspace<<i>vector_type</i>>(start, end, N)</li>
<li><i>matrix_type</i> X = linspace<<i>matrix_type</i>>(start, end, N)</li>
</ul>
</li>
<br>
<li>
If a <i>matrix_type</i> is specified, the resultant matrix will have one column
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec v = linspace<vec>(10, 20, 5);
mat X = linspace<mat>(10, 20, 5);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#ones_standalone">ones()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="ones_standalone"></a>
<b>
ones( n_elem )
<br>ones( n_rows, n_cols )
<br>ones( n_rows, n_cols, n_slices )
</b>
<ul>
<li>
Generate a vector, matrix or cube with all elements set to one
</li>
<br>
<li>
Usage:
<ul>
<li><i>vector_type</i> v = ones<<i>vector_type</i>>(n_elem)</li>
<li><i>matrix_type</i> X = ones<<i>matrix_type</i>>(n_rows, n_cols)</li>
<li><i>cube_type</i> Q = ones<<i>cube_type</i>>(n_rows, n_cols, n_slices)</li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec v = ones<vec>(10);
uvec u = ones<uvec>(11);
mat A = ones<mat>(5,6);
cube Q = ones<cube>(5,6,7);
mat B = 123.0 * ones<mat>(5,6);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#ones_member">.ones()</a> (member function of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>Cube</i>)</li>
<li><a href="#eye_standalone">eye()</a></li>
<li><a href="#linspace">linspace()</a></li>
<li><a href="#zeros_standalone">zeros()</a></li>
<li><a href="#randu_randn_standalone">randu() & randn()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="randi"></a>
<b>randi( n_elem )</b>
<br><b>randi( n_elem, distr_param(a,b) )</b>
<br>
<br><b>randi( n_rows, n_cols )</b>
<br><b>randi( n_rows, n_cols, distr_param(a,b) )</b>
<br>
<br><b>randi( n_rows, n_cols, n_slices )</b>
<br><b>randi( n_rows, n_cols, n_slices, distr_param(a,b) )</b>
<ul>
<li>
Generate a vector, matrix or cube with the elements set to random <b>integer</b> values in the [a,b] interval
</li>
<br>
<li>The default distribution parameters are <i>a=0</i> and <i>b=maximum_int</i>
</li>
<br>
<li>
Usage:
<ul>
<li><i>vector_type</i> v = randi<<i>vector_type</i>>(n_elem)</li>
<li><i>vector_type</i> v = randi<<i>vector_type</i>>(n_elem, distr_param(a,b))</li>
<br>
<li><i>matrix_type</i> X = randi<<i>matrix_type</i>>(n_rows, n_cols)</li>
<li><i>matrix_type</i> X = randi<<i>matrix_type</i>>(n_rows, n_cols, distr_param(a,b))</li>
<br>
<li><i>cube_type</i> Q = randi<<i>cube_type</i>>(n_rows, n_cols, n_slices)</li>
<li><i>cube_type</i> Q = randi<<i>cube_type</i>>(n_rows, n_cols, n_slices, distr_param(a,b))</li>
</ul>
</li>
<br>
<li>
To change the RNG seed, use <i>arma_rng::set_seed(value)</i> or <i>arma_rng::set_seed_random()</i> functions
</li>
<br>
<li>
<b>Caveat:</b> if you want to generate a continuous distribution with floating point values (ie. <i>float</i> or <i>double</i>),
use <a href="#randu_randn_standalone">randu()</a> or <a href="#randu_randn_standalone">randn()</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
imat A = randi<imat>(5, 6);
imat A = randi<imat>(6, 7, distr_param(-10, +20));
arma_rng::set_seed_random(); // set the seed to a random value
</pre>
</ul>
</li>
<li>See also:
<ul>
<li><a href="#randu_randn_standalone">randu() & randn()</a></li>
<li><a href="#imbue">.imbue()</a></li>
<li><a href="#ones_standalone">ones()</a></li>
<li><a href="#zeros_standalone">zeros()</a></li>
<li><a href="#shuffle">shuffle()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="randu_randn_standalone"></a>
<b>randu( n_elem )</b>
<br><b>randu( n_rows, n_cols )</b>
<br><b>randu( n_rows, n_cols, n_slices )</b>
<br>
<br><b>randn( n_elem )</b>
<br><b>randn( n_rows, n_cols )</b>
<br><b>randn( n_rows, n_cols, n_slices )</b>
<ul>
<li>
Generate a vector, matrix or cube with the elements set to random <b>floating point</b> values
</li>
<br>
<li><i>randu()</i> uses a uniform distribution in the [0,1] interval
</li>
<br>
<li><i>randn()</i> uses a normal/Gaussian distribution with zero mean and unit variance
</li>
<br>
<li>
Usage:
<ul>
<li><i>vector_type</i> v = randu<<i>vector_type</i>>(n_elem)</li>
<li><i>matrix_type</i> X = randu<<i>matrix_type</i>>(n_rows, n_cols)</li>
<li><i>cube_type</i> Q = randu<<i>cube_type</i>>(n_rows, n_cols, n_slices)</li>
</ul>
</li>
<br>
<li>
To change the RNG seed, use <i>arma_rng::set_seed(value)</i> or <i>arma_rng::set_seed_random()</i> functions
</li>
<br>
<li>
<b>Caveat:</b> if you want to generate a matrix with random integer values instead of floating point values,
use <a href="#randi">randi()</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec v = randu<vec>(5);
mat A = randu<mat>(5,6);
cube Q = randu<cube>(5,6,7);
arma_rng::set_seed_random(); // set the seed to a random value
</pre>
</ul>
</li>
<li>See also:
<ul>
<li><a href="#randu_randn_member">.randu() & .randn()</a> (member functions)</li>
<li><a href="#imbue">.imbue()</a></li>
<li><a href="#randi">randi()</a></li>
<li><a href="#ones_standalone">ones()</a></li>
<li><a href="#zeros_standalone">zeros()</a></li>
<li><a href="#shuffle">shuffle()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Uniform_distribution_(continuous)">uniform distribution in Wikipedia</a></li>
<li><a href="http://en.wikipedia.org/wiki/Normal_distribution">normal distribution in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="repmat"></a>
<b>repmat( A, num_copies_per_row, num_copies_per_col )</b>
<ul>
<li>Generate a matrix by replicating matrix <i>A</i> in a block-like fashion</li>
<br>
<li>The generated matrix has the following size:
<ul>
rows = num_copies_per_row * A.n_rows
<br>
cols = num_copies_per_col * A.n_cols
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(2, 3);
mat B = repmat(A, 4, 5);
</pre>
</ul>
</li>
<li>See also:
<ul>
<li><a href="#copy_size">.copy_size()</a></li>
<li><a href="#each_colrow">.each_col() / .each_row()</a></li>
<li><a href="#reshape">reshape()</a></li>
<li><a href="#resize">resize()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="speye"></a>
<b>speye( n_rows, n_cols )</b>
<ul>
<li>
Generate a sparse matrix with the elements along the main diagonal set to one
and off-diagonal elements set to zero
</li>
<br>
<li>
An identity matrix is generated when <i>n_rows</i> = <i>n_cols</i>
</li>
<br>
<li>
Usage:
<ul>
<li>
<i>sparse_matrix_type</i> X = speye<<i>sparse_matrix_type</i>>(n_rows, n_cols)
</li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
sp_mat A = speye<sp_mat>(5,5);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#spones">spones()</a></li>
<li><a href="#sprandu_sprandn">sprandu()/sprandn()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="spones"></a>
<b>spones( A )</b>
<ul>
<li>
Generate a sparse matrix with the same structure as sparse matrix <i>A</i>,
but with the non-zero elements set to one
</li>
<br>
<li>
Examples:
<ul>
<pre>
sp_mat A = sprandu<sp_mat>(100, 200, 0.1);
sp_mat B = spones(A);
</pre>
</ul>
</li>
<li>See also:
<ul>
<li><a href="#speye">speye()</a></li>
<li><a href="#sprandu_sprandn">sprandu()/sprandn()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="sprandu_sprandn"></a>
<b>sprandu( n_rows, n_cols, density )</b>
<br><b>sprandn( n_rows, n_cols, density )</b>
<ul>
<li>
Generate a sparse matrix with the non-zero elements set to random values
</li>
<br>
<li>
The <i>density</i> argument specifies the percentage of non-zero elements; it must be in the [0,1] interval
</li>
<br>
<li><i>sprandu()</i> uses a uniform distribution in the [0,1] interval
</li>
<br>
<li><i>sprandn()</i> uses a normal/Gaussian distribution with zero mean and unit variance
</li>
<br>
<li>
Usage:
<ul>
<li><i>sparse_matrix_type</i> X = sprandu<<i>sparse_matrix_type</i>>(n_rows, n_cols, density)</li>
</ul>
</li>
<br>
<li>
To change the RNG seed, use <i>arma_rng::set_seed(value)</i> or <i>arma_rng::set_seed_random()</i> functions
</li>
<br>
<li>
Examples:
<ul>
<pre>
sp_mat A = sprandu<sp_mat>(100, 200, 0.1);
</pre>
</ul>
</li>
<li>See also:
<ul>
<li><a href="#speye">speye()</a></li>
<li><a href="#spones">spones()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="toeplitz"></a>
<b>toeplitz( A )</b>
<br><b>toeplitz( A, B )</b>
<br><b>circ_toeplitz( A )</b>
<ul>
<li>
toeplitz(): generate a Toeplitz matrix, with the first column specified by <i>A</i>, and (optionally) the first row specified by <i>B</i>
</li>
<br>
<li>
circ_toeplitz(): generate a circulant Toeplitz matrix
</li>
<br>
<li>
A and B must be vectors
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec A = randu<vec>(5);
mat X = toeplitz(A);
mat Y = circ_toeplitz(A);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="http://mathworld.wolfram.com/ToeplitzMatrix.html">Toeplitz matrix in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Toeplitz_matrix">Toeplitz matrix in Wikipedia</a></li>
<li><a href="http://en.wikipedia.org/wiki/Circulant_matrix">Circulant matrix in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="zeros_standalone"></a>
<b>zeros( n_elem )</b>
<br><b>zeros( n_rows, n_cols )</b>
<br><b>zeros( n_rows, n_cols, n_slices )</b>
<ul>
<li>
Generate a vector, matrix or cube with the elements set to zero
</li>
<br>
<li>
Usage:
<ul>
<li><i>vector_type</i> v = zeros<<i>vector_type</i>>(n_elem)</li>
<li><i>matrix_type</i> X = zeros<<i>matrix_type</i>>(n_rows, n_cols)</li>
<li><i>cube_type</i> X = zeros<<i>cube_type</i>>(n_rows, n_cols, n_slices)</li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec v = zeros<vec>(10);
uvec u = zeros<uvec>(11);
mat A = zeros<mat>(5,6);
cube Q = zeros<cube>(5,6,7);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#zeros_member">.zeros()</a> (member function of <i>Mat</i>, <i>Col</i>, <i>Row</i>, <i>SpMat</i> and <i>Cube</i>)</li>
<li><a href="#ones_member">.ones()</a> (member function of <i>Mat</i>, <i>Col</i>, <i>Row</i> and <i>Cube</i>)</li>
<li><a href="#ones_standalone">ones()</a></li>
<li><a href="#randu_randn_standalone">randu() & randn()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline">
<hr class="greyline">
<br>
<br>
<font size=+1><b>Functions Individually Applied to Each Element of a Matrix/Cube</b></font>
<br>
<br>
<hr class="greyline">
<br>
<a name="abs"></a>
<b>abs( X )</b>
<ul>
<li>
Obtain the magnitude of each element
</li>
<br>
<li>
Usage for non-complex matrices and cubes:
<ul>
<li><i>matrix_type</i> Y = abs(X)</li>
<li><i>cube_type</i> Y = abs(X)</li>
<li>X and Y must have the same matrix_type / cube_type</li>
</ul>
</li>
<br>
<li>
Usage for complex matrices and cubes:
<ul>
<li><i>non_complex_matrix_type</i> Y = abs(X)</li>
<li><i>non_complex_cube_type</i> Y = abs(X)</li>
<li>X must be a have complex matrix / cube type, eg., <i>cx_mat</i> or <i>cx_cube</i></li>
<li>The type of Y must be related to the type of X,
eg., if X has the type <i>cx_mat</i>, then the type of Y must be <i>mat</i>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = abs(A);
cx_mat X = randu<cx_mat>(5,5);
mat Y = abs(X);
</pre>
</ul>
</li>
<li>
See also:
<ul>
<li><a href="#conj">conj()</a></li>
<li><a href="#imag_real">imag() / real()</a></li>
<li><a href="#conv_to">conv_to()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="conj"></a>
<b>conj( X )</b>
<ul>
<li>
Obtain the complex conjugate of each element in a complex matrix or cube
</li>
<br>
<li>
Examples:
<ul>
<pre>
cx_mat X = randu<cx_mat>(5,5);
cx_mat Y = conj(X);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#abs">abs()</a></li>
<li><a href="#imag_real">imag() / real()</a></li>
<li><a href="#trans">trans()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="conv_to"></a>
<b>
conv_to< <i>type</i> >::from( X )
</b>
<ul>
<li>
Convert from one matrix type to another (eg. <i>mat</i> to <i>imat</i>), or one cube type to another (eg. <i>cube</i> to <i>icube</i>)
</li>
<br>
<li>
Conversion between <i>std::vector</i> and Armadillo matrices/vectors is also possible
</li>
<br>
<li>
Conversion of a <i>mat</i> object into <i>colvec</i>, <i>rowvec</i> or <i>std::vector</i> is possible if the object can be interpreted as a vector
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
fmat B = conv_to<fmat>::from(A);
typedef std::vector<double> stdvec;
stdvec x(3);
x[0] = 0.0; x[1] = 1.0; x[2] = 2.0;
colvec y = conv_to< colvec >::from(x);
stdvec z = conv_to< stdvec >::from(y);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#as_scalar">as_scalar()</a></li>
<li><a href="#abs">abs()</a></li>
<li><a href="#imag_real">imag() / real()</a></li>
<li><a href="#adv_constructors_mat">advanced constructors (matrices)</a></li>
<li><a href="#adv_constructors_cube">advanced constructors (cubes)</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="eps"></a>
<b>eps( X )</b>
<ul>
<li>
Obtain the positive distance of the absolute value of each element of <i>X</i> to the next largest representable floating point number
</li>
<br>
<li>
<i>X</i> can be a scalar (eg. <i>double</i>), vector or matrix
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
mat B = eps(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#constants">datum::eps</a></li>
<li><a href="http://mathworld.wolfram.com/Floating-PointArithmetic.html">Floating-Point Arithmetic in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/IEEE_754-2008">IEEE Standard for Floating-Point Arithmetic in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="imag_real"></a>
<b>imag( X )</b>
<br><b>real( X )</b>
<ul>
<li>
Extract the imaginary/real part of a complex matrix or cube
</li>
<br>
<li>
Examples:
<ul>
<pre>
cx_mat C = randu<cx_mat>(5,5);
mat A = imag(C);
mat B = real(C);
</pre>
</ul>
</li>
<br>
<li><b>Caveat:</b> versions 4.4, 4.5 and 4.6 of the GCC C++ compiler have a bug when using the <i>-std=c++0x</i> compiler option (ie. experimental support for C++11);
to work around this bug, preface Armadillo's <i>imag()</i> and <i>real()</i> with the <i>arma</i> namespace qualification, eg. <i>arma::imag(C)</i>
</li>
<br>
<li>See also:
<ul>
<li><a href="#set_imag">set_imag() / set_real()</a></li>
<li><a href="#abs">abs()</a></li>
<li><a href="#conj">conj()</a></li>
<li><a href="#conv_to">conv_to()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="misc_fns"></a>
<b>
miscellaneous element-wise functions:
<ul>
exp, exp2, exp10, trunc_exp
<br>log, log2, log10, trunc_log
<br>pow, sqrt, square
<br>floor, ceil, round
<br>sign
</ul>
</b>
<ul>
<li>
Apply a function to each element
</li>
<br>
<li>
Usage:
<ul>
<li>
<i>matrix_type</i> B = fn(A)
</li>
<li>
<i>cube_type</i> B = fn(A)
</li>
<li>
A and B must have the same <i>matrix_type/cube_type</i>
</li>
<li>
fn(A) is one of:
<ul>
<table style="text-align: left; width: 100%;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
exp(A)<sup> </sup>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
base-e exponential: <i>e<sup>x</sup></i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
exp2(A)<sup> </sup>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
base-2 exponential: <i>2<sup>x</sup></i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
exp10(A)<sup> </sup>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
base-10 exponential: <i>10<sup>x</sup></i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
trunc_exp(A)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
base-e exponential,
truncated to avoid infinity
<br>
<font size=-1>(only for elements with type <i>float</i> or <i>double</i>)</font>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
log(A)<sub> </sub>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
natural log: <i>log<sub>e</sub> x</i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
log2(A)<sub> </sub>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
base-2 log: <i>log<sub>2</sub> x</i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
log10(A)<sub> </sub>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
base-10 log: <i>log<sub>10</sub> x</i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
trunc_log(A)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
natural log,
truncated to avoid ±infinity
<br>
<font size=-1>(only for elements with type <i>float</i> or <i>double</i>)</font>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
pow(A, p)<sup> </sup>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
raise to the power of p: <i>x<sup>p</sup></i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
sqrt(A)<sup> </sup>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
square root: <i>x<sup>½</sup></i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
square(A)<sup> </sup>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
square: <i>x<sup>2</sup></i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
floor(A)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
largest integral value that is not greater than the input value
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ceil(A)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
smallest integral value that is not less than the input value
</td>
</tr>
<tr>
<td style="vertical-align: top;">
round(A)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
round to nearest integer, away from zero
</td>
</tr>
<tr>
<td style="vertical-align: top;">
sign(A)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
signum function;
for each element <i>a</i> in <i>A</i>, the corresponding element <i>b</i> in <i>B</i> is:
<table>
<tbody>
<tr><td style="text-align: right;">−1</td><td> if <i>a</i> < 0</td></tr>
<tr><td style="text-align: right;">0</td><td> if <i>a</i> = 0</td></tr>
<tr><td style="text-align: right;">+1</td><td> if <i>a</i> > 0</td></tr>
</tbody>
</table>
if <i>a</i> is complex and non-zero, then <i>b</i> = <i>a</i> / abs(<i>a</i>)
</td>
</tr>
</tbody>
</table>
</ul>
</li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = exp(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#abs">abs()</a></li>
<li><a href="#conj">conj()</a></li>
<li><a href="#imag_real">imag() / real()</a></li>
<li><a href="#constants">pre-defined constants</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="trig_fns"></a>
<b>trigonometric element-wise functions (cos, sin, tan, ...)</b>
<ul>
<li>
Apply a trigonometric function to each element
</li>
<br>
<li>
Usage:
<ul>
<li>
<i>matrix_type</i> Y = trig_fn(X)
</li>
<li>
<i>cube_type</i> Y = trig_fn(X)
</li>
<li>
X and Y must have the same <i>matrix_type/cube_type</i>
</li>
<li>
trig_fn is one of:
<ul>
<li>
cos family: <i>cos</i>, <i>acos</i>, <i>cosh</i>, <i>acosh</i>
</li>
<li>
sin family: <i>sin</i>, <i>asin</i>, <i>sinh</i>, <i>asinh</i>
</li>
<li>
tan family: <i>tan</i>, <i>atan</i>, <i>tanh</i>, <i>atanh</i>
</li>
</ul>
</li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(5,5);
mat Y = cos(X);
</pre>
</ul>
</li>
</ul>
<br>
<hr class="greyline">
<hr class="greyline">
<br>
<br>
<font size=+1><b>Scalar Valued Functions of Vectors/Matrices/Cubes</b></font>
<br>
<br>
<hr class="greyline">
<br>
<a name="accu"></a>
<b>accu( X )</b>
<ul>
<li>
Accumulate (sum) all elements of a matrix or cube
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
double x = accu(A);
mat B = randu<mat>(5,5);
double y = accu(A % B);
// operator % performs element-wise multiplication,
// hence accu(A % B) is a "multiply-and-accumulate" operation
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#sum">sum()</a></li>
<li><a href="#cumsum">cumsum()</a></li>
<li><a href="#as_scalar">as_scalar()</a></li>
<li><a href="#trace">trace()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="as_scalar"></a>
<b>as_scalar( expression )</b>
<ul>
<li>
Evaluate an expression that results in a 1x1 matrix,
followed by converting the 1x1 matrix to a pure scalar
</li>
<br>
<li>
If a binary or trinary expression is given (ie. 2 or 3 terms),
the function will try to exploit the fact that the result is a 1x1 matrix
by using optimised expression evaluations
</li>
<br>
<li>
Examples:
<ul>
<pre>
rowvec r = randu<rowvec>(5);
colvec q = randu<colvec>(5);
mat X = randu<mat>(5,5);
// examples of some expressions
// for which optimised implementations exist
double a = as_scalar(r*q);
double b = as_scalar(r*X*q);
double c = as_scalar(r*diagmat(X)*q);
double d = as_scalar(r*inv(diagmat(X))*q);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#accu">accu()</a></li>
<li><a href="#trace">trace()</a></li>
<li><a href="#dot">dot()</a></li>
<li><a href="#norm">norm()</a></li>
<li><a href="#conv_to">conv_to()</a></li>
<li><a href="#reshape">reshape()</a></li>
<li><a href="#resize">resize()</a></li>
<li><a href="#vectorise">vectorise()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="cond"></a>
<b>cond( A )</b>
<ul>
<li>
Condition number of matrix <i>A</i> (the ratio of the largest singular value to the smallest)
</li>
<br>
<li>
Large condition numbers suggest that matrix <i>A</i> is nearly singular
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
double c = cond(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#i_member">.i()</a></li>
<li><a href="#inv">inv()</a></li>
<li><a href="http://mathworld.wolfram.com/ConditionNumber.html">condition number in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Condition_number">condition number in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="det"></a>
<b>det( A )</b>
<br><b>det( A, method )</b>
<ul>
<li>
Determinant of square matrix <i>A</i>
</li>
<br>
<li>
If <i>A</i> is not square, a <i>std::logic_error</i> exception is thrown
</li>
<br>
<li>The <i>method</i> argument is optional.
For matrix sizes ≤ 4x4, a fast algorithm is used.
In rare instances, the fast algorithm might be less precise than the standard algorithm.
To force the use of the standard algorithm, set the <i>method</i> argument to "std".
For matrix sizes greater than 4x4, the standard algorithm is always used
</li>
<br>
<li>
<b>Caveat</b>: for large matrices you may want to use <a href="#log_det">log_det()</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
double x = det(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#log_det">log_det()</a></li>
<li><a href="http://mathworld.wolfram.com/Determinant.html">determinant in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Determinant">determinant in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="dot"></a>
<b>dot( A, B )</b>
<br><b>cdot( A, B )</b>
<br><b>norm_dot( A, B )</b>
<ul>
<li>
<i>dot(A,B)</i>: dot product of <i>A</i> and <i>B</i>, under the assumption that <i>A</i> and <i>B</i> are vectors with the same number of elements
</li>
<br>
<li>
<i>cdot(A,B)</i>: as per <i>dot(A,B)</i>, but the complex conjugate of <i>A</i> is used
</li>
<br>
<li>
<i>norm_dot(A,B)</i>: normalised version of <i>dot(A,B)</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec a = randu<vec>(10);
vec b = randu<vec>(10);
double x = dot(a,b);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#as_scalar">as_scalar()</a></li>
<li><a href="#cross">cross()</a></li>
<li><a href="#conj">conj()</a></li>
<li><a href="#norm">norm()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="log_det"></a>
<b>log_det( val, sign, A )</b>
<ul>
<li>
Log determinant of square matrix <i>A</i>, such that the determinant is equal to <i>exp(val)*sign</i>
</li>
<br>
<li>
If <i>A</i> is not square, a <i>std::logic_error</i> exception is thrown
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
double val;
double sign;
log_det(val, sign, A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#det">det()</a></li>
<li><a href="http://mathworld.wolfram.com/Determinant.html">determinant in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Determinant">determinant in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="norm"></a>
<b>norm( X )</b>
<br><b>norm( X, p )</b>
<ul>
<li>
Compute the <i>p</i>-norm of <i>X</i>, where <i>X</i> can be a vector or a matrix
</li>
<br>
<li>
For vectors, <i>p</i> is an integer ≥1, or one of: "-inf", "inf", "fro"
</li>
<br>
<li>
For matrices, <i>p</i> is one of: 1, 2, "inf", "fro"; the calculated norm is the <i>induced norm</i> (not entrywise norm)
</li>
<br>
<li>
"-inf" is the minimum norm, "inf" is the maximum norm, while "fro" is the Frobenius norm
</li>
<br>
<li>
To obtain the zero norm or Hamming norm (ie. the number of non-zero elements),
use this expression: <a href="#accu">accu</a>(X != 0)
</li>
<br>
<li>
In version 4.100+, the argument <i>p</i> is optional; by default <i>p=2</i> is used
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec q = randu<vec>(5);
double x = norm(q, 2);
double y = norm(q, "inf");
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#dot">dot()</a></li>
<li><a href="#normalise">normalise()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Norm_(mathematics)">Vector Norm in Wikipedia</a></li>
<li><a href="http://mathworld.wolfram.com/VectorNorm.html">Vector Norm in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Matrix_norm">Matrix Norm in Wikipedia</a></li>
<li><a href="http://mathworld.wolfram.com/MatrixNorm.html">Matrix Norm in MathWorld</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="rank"></a>
<b>rank( X )</b>
<br>
<b>rank( X, tolerance )</b>
<ul>
<li>Returns the rank of matrix <i>X</i></li>
<br>
<li>Any singular values less than default tolerance are treated as zero</li>
<br>
<li>The <i>tolerance</i> argument is optional;
by default the tolerance is <i>max(X.n_rows, X.n_cols)*eps(sigma)</i>,
where <i>sigma</i> is the largest singular value of <i>X</i>
</li>
<br>
<li>The computation is based on singular value decomposition;
if the decomposition fails, a <i>std::runtime_error</i> exception is thrown</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
uword r = rank(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#eps">eps()</a></li>
<li><a href="http://mathworld.wolfram.com/MatrixRank.html">Rank in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Rank_(linear_algebra)">Rank in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="trace"></a>
<b>trace( X )</b>
<ul>
<li>
Sum of the diagonal elements of square matrix <i>X</i>
</li>
<br>
<li>
If <i>X</i> is an expression,
the function will try to use optimised expression evaluations to calculate only the diagonal elements
</li>
<br>
<li>
A <i>std::logic_error</i> exception is thrown if <i>X</i> does not evaluate to a square matrix
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
double x = trace(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#accu">accu()</a></li>
<li><a href="#as_scalar">as_scalar()</a></li>
<li><a href="#diag">.diag()</a></li>
<li><a href="#diagvec">diagvec()</a></li>
<li><a href="#sum">sum()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<hr class="greyline">
<br>
<br>
<font size=+1><b>Scalar/Vector Valued Functions of Vectors/Matrices</b></font>
<br>
<br>
<hr class="greyline">
<br>
<a name="all"></a>
<b>all( V )</b>
<br><b>all( X )</b>
<br><b>all( X, dim )</b>
<ul>
<li>For vector <i>V</i>, return <i>true</i> if all elements of the vector are non-zero or satisfy a relational condition</li>
<br>
<li>
For matrix <i>X</i> and
<ul>
<li>
<i>dim=0</i>, return a row vector (of type <a href="#Row">urowvec</a> or <a href="#Mat">umat</a>),
with each element (0 or 1) indicating whether the corresponding column of <i>X</i> has all non-zero elements</li>
<br>
<li>
<i>dim=1</i>, return a column vector (of type <a href="#Col">ucolvec</a> or <a href="#Mat">umat</a>),
with each element (0 or 1) indicating whether the corresponding row of <i>X</i> has all non-zero elements</li>
</ul>
</li>
<br>
<li>
The <i>dim</i> argument is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>
Relational operators can be used instead of <i>V</i> or <i>X</i>, eg. <i>A > 0.5</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec V = randu<vec>(10);
mat X = randu<mat>(5,5);
// status1 will be set to true if vector V has all non-zero elements
bool status1 = all(V);
// status2 will be set to true if vector V has all elements greater than 0.5
bool status2 = all(V > 0.5);
// status3 will be set to true if matrix X has all elements greater than 0.6;
// note the use of vectorise()
bool status3 = all(vectorise(X) > 0.6);
// generate a row vector indicating which columns of X have all elements greater than 0.7
umat A = all(X > 0.7);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#any">any()</a></li>
<li><a href="#find">find()</a></li>
<li><a href="#conv_to">conv_to()</a> (convert between matrix/vector types)</li>
<li><a href="#vectorise">vectorise()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="any"></a>
<b>any( V )</b>
<br><b>any( X )</b>
<br><b>any( X, dim )</b>
<ul>
<li>For vector <i>V</i>, return <i>true</i> if any element of the vector is non-zero or satisfies a relational condition</li>
<br>
<li>
For matrix <i>X</i> and
<ul>
<li>
<i>dim=0</i>, return a row vector (of type <a href="#Row">urowvec</a> or <a href="#Mat">umat</a>),
with each element (0 or 1) indicating whether the corresponding column of <i>X</i> has any non-zero elements</li>
<br>
<li>
<i>dim=1</i>, return a column vector (of type <a href="#Col">ucolvec</a> or <a href="#Mat">umat</a>),
with each element (0 or 1) indicating whether the corresponding row of <i>X</i> has any non-zero elements</li>
</ul>
</li>
<br>
<li>
The <i>dim</i> argument is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>
Relational operators can be used instead of <i>V</i> or <i>X</i>, eg. <i>A > 0.9</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec V = randu<vec>(10);
mat X = randu<mat>(5,5);
// status1 will be set to true if vector V has any non-zero elements
bool status1 = any(V);
// status2 will be set to true if vector V has any elements greater than 0.5
bool status2 = any(V > 0.5);
// status3 will be set to true if matrix X has any elements greater than 0.6;
// note the use of vectorise()
bool status3 = any(vectorise(X) > 0.6);
// generate a row vector indicating which columns of X have elements greater than 0.7
umat A = any(X > 0.7);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#all">all()</a></li>
<li><a href="#find">find()</a></li>
<li><a href="#conv_to">conv_to()</a> (convert between matrix/vector types)</li>
<li><a href="#vectorise">vectorise()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="diagvec"></a>
<b>diagvec( A )</b>
<br><b>diagvec( A, k )</b>
<ul>
<li>
Extract the <i>k</i>-th diagonal from matrix <i>A</i>
</li>
<br>
<li>
The argument <i>k</i> is optional; by default the main diagonal is extracted (<i>k=0</i>)
</li>
<br>
<li>For <i>k > 0</i>, the <i>k</i>-th super-diagonal is extracted (top-right corner)</li>
<br>
<li>For <i>k < 0</i>, the <i>k</i>-th sub-diagonal is extracted (bottom-left corner)</li>
<br>
<li>
The extracted diagonal is interpreted as a column vector
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
vec d = diagvec(A);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#diag">.diag()</a></li>
<li><a href="#diagmat">diagmat()</a></li>
<li><a href="#trace">trace()</a></li>
<li><a href="#vectorise">vectorise()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="min_and_max"></a>
<b>min( V )</b>
<br><b>min( X )</b>
<br><b>min( X, dim )</b>
<br><b>min( A, B )</b>
<br>
<br><b>max( V )</b>
<br><b>max( X )</b>
<br><b>max( X, dim )</b>
<br><b>max( A, B )</b>
<ul>
<li>
For vector <i>V</i>, return the extremum value
</li>
<br>
<li>
For matrix <i>X</i>, return the extremum value for each column (<i>dim=0</i>), or each row (<i>dim=1</i>)
</li>
<br>
<li>
The <i>dim</i> argument is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>
For two matrices <i>A</i> and <i>B</i>, return a matrix containing element-wise extremum values
</li>
<br>
<li>
Examples:
<ul>
<pre>
colvec v = randu<colvec>(10,1);
double val = max(v);
mat X = randu<mat>(10,10);
rowvec r = max(X);
// same result as max(X)
// the 0 explicitly indicates "traverse across rows"
rowvec s = max(X,0);
// the 1 explicitly indicates "traverse across columns"
colvec t = max(X,1);
// find the overall maximum value
double y = max(max(X));
// element-wise maximum
mat A = randu<mat>(5,6);
mat B = randu<mat>(5,6);
mat C = arma::max(A,B); // use arma:: prefix to distinguish from std::max()
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#min_and_max_member">.min() & .max()</a> (member functions of Mat and Cube)</li>
<li><a href="#running_stat">running_stat</a></li>
<li><a href="#running_stat_vec">running_stat_vec</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="prod"></a>
<b>prod( V )</b>
<br><b>prod( X )</b>
<br><b>prod( X, dim )</b>
<ul>
<li>
For vector <i>V</i>, return the product of all elements
</li>
<br>
<li>
For matrix <i>X</i>, return the product of elements in each column (<i>dim=0</i>), or each row (<i>dim=1</i>)
</li>
<br>
<li>
The <i>dim</i> argument is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>
Examples:
<ul>
<pre>
colvec q = randu<colvec>(10,1);
double x = prod(q);
mat A = randu<mat>(10,10);
rowvec b = prod(A);
// same result as prod(A)
// the 0 explicitly indicates
// "traverse across rows"
rowvec c = prod(A,0);
// the 1 explicitly indicates
// "traverse across columns"
colvec d = prod(A,1);
// find the overall product
double y = prod(prod(A));
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#schur_product">Schur product</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="sum"></a>
<br><b>sum( V )</b>
<br><b>sum( X )</b>
<br><b>sum( X, dim )</b>
<ul>
<li>
For vector <i>V</i>, return the sum of all elements
</li>
<br>
<li>
For matrix <i>X</i>, return the sum of elements in each column (<i>dim=0</i>), or each row (<i>dim=1</i>)
</li>
<br>
<li>
The <i>dim</i> argument is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>
To get a sum of all the elements regardless of the argument type (ie. matrix or vector),
use <a href="#accu">accu()</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
colvec q = randu<colvec>(10,1);
double x = sum(q);
mat A = randu<mat>(10,10);
rowvec b = sum(A);
// same result as sum(A)
// the 0 explicitly indicates "traverse across rows"
rowvec c = sum(A,0);
// the 1 explicitly indicates "traverse across columns"
colvec d = sum(A,1);
// find the overall sum
double y = sum(sum(A));
double z = accu(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#accu">accu()</a></li>
<li><a href="#cumsum">cumsum()</a></li>
<li><a href="#trace">trace()</a></li>
<li><a href="#as_scalar">as_scalar()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="stats_fns"></a>
<b>statistics: mean, median, stddev, var</b>
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>mean( V )</b>
<br><b>mean( X )</b>
<br><b>mean( X, dim )</b>
<br>
<br>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
mean (average value)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>median( V )</b>
<br><b>median( X )</b>
<br><b>median( X, dim )</b>
<br>
<br>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
median
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>stddev( V )</b>
<br><b>stddev( V, norm_type )</b>
<br><b>stddev( X )</b>
<br><b>stddev( X, norm_type )</b>
<br><b>stddev( X, norm_type, dim )</b>
<br>
<br>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
standard deviation
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<b>var( V )</b>
<br><b>var( V, norm_type )</b>
<br><b>var( X )</b>
<br><b>var( X, norm_type )</b>
<br><b>var( X, norm_type, dim )</b>
<br>
<br>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
variance
</td>
</tr>
</tbody>
</table>
<br>
<li>
For vector <i>V</i>, return a particular statistic calculated using all the elements of the vector
</li>
<br>
<li>
For matrix <i>X</i>, find a particular statistic for each column (<i>dim=0</i>), or each row (<i>dim=1</i>)
</li>
<br>
<li>
The <i>dim</i> argument is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>
The <i>norm_type</i> argument is optional; by default <i>norm_type=0</i> is used
</li>
<br>
<li>
For the <i>var()</i> and <i>stddev()</i> functions:
<ul>
<li>the default <i>norm_type=0</i> performs normalisation using <i>N-1</i> (where <i>N</i> is the number of samples), providing the best unbiased estimator</li>
<li>using <i>norm_type=1</i> performs normalisation using <i>N</i>, which provides the second moment around the mean</li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = mean(A);
mat C = var(A);
double m = mean(mean(A));
vec q = randu<vec>(5);
double v = var(q);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#cov">cov()</a></li>
<li><a href="#cor">cor()</a></li>
<li><a href="#running_stat">running_stat</a>: class for running statistics of scalars</li>
<li><a href="#running_stat_vec">running_stat_vec</a>: class for running statistics of vectors</li>
<li><a href="#hist">hist()</a></li>
<li><a href="#histc">histc()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline">
<hr class="greyline">
<br>
<br>
<font size=+1><b>Vector/Matrix/Cube Valued Functions of Vectors/Matrices/Cubes</b></font>
<br>
<br>
<hr class="greyline">
<br>
<a name="conv"></a>
<b>
conv( A, B )
</b>
<ul>
<li>
Convolution of vectors <i>A</i> and <i>B</i>
</li>
<br>
<li>
If <i>A</i> and <i>B</i> are polynomial coefficient vectors, convolving them is equivalent to multiplying the two polynomials
</li>
<br>
<li>
The convolution operation is also equivalent to FIR filtering
</li>
<br>
<li>
The orientation of the result vector is the same as the orientation of <i>A</i> (ie. column or row vector)
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec A = randu<vec>(128) - 0.5;
vec B = randu<vec>(128) - 0.5;
vec C = conv(A,B);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#fft">fft()</a></li>
<li><a href="#cor">cor()</a></li>
<li><a href="http://mathworld.wolfram.com/Convolution.html">Convolution in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Convolution">Convolution in Wikipedia</a></li>
<li><a href="http://en.wikipedia.org/wiki/Finite_impulse_response">FIR filter in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="cor"></a>
<b>cor( X, Y )</b>
<br><b>cor( X, Y, norm_type )</b>
<br>
<br><b>cor( X )</b>
<br><b>cor( X, norm_type )</b>
<ul>
<li>
For two matrix arguments <i>X</i> and <i>Y</i>,
if each row of <i>X</i> and <i>Y</i> is an observation and each column is a variable,
the <i>(i,j)</i>-th entry of <i>cor(X,Y)</i> is the correlation coefficient between the <i>i</i>-th variable in <i>X</i> and the <i>j</i>-th variable in <i>Y</i>
</li>
<br>
<li>
For vector arguments, the type of vector is ignored and each element in the vector is treated as an observation
</li>
<br>
<li>
For matrices, <i>X</i> and <i>Y</i> must have the same dimensions
</li>
<br>
<li>
For vectors, <i>X</i> and <i>Y</i> must have the same number of elements
</li>
<br>
<li>
<i>cor(X)</i> is equivalent to <i>cor(X, X)</i>, also called autocorrelation
</li>
<br>
<li>
The default <i>norm_type=0</i> performs normalisation of the correlation matrix using <i>N-1</i> (where <i>N</i> is the number of observations).
Using <i>norm_type=1</i> causes normalisation to be done using <i>N</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(4,5);
mat Y = randu<mat>(4,5);
mat R = cor(X,Y);
mat S = cor(X,Y, 1);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#cov">cov()</a></li>
<li><a href="#conv">conv()</a></li>
<li><a href="#stats_fns">statistics functions</a></li>
<li><a href="#running_stat_vec">running_stat_vec</a></li>
<li><a href="http://mathworld.wolfram.com/Correlation.html">Correlation in MathWorld</a></li>
<li><a href="http://mathworld.wolfram.com/Autocorrelation.html">Autocorrelation in MathWorld</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="cov"></a>
<b>cov( X, Y )</b>
<br><b>cov( X, Y, norm_type )</b>
<br>
<br><b>cov( X )</b>
<br><b>cov( X, norm_type )</b>
<ul>
<li>
For two matrix arguments <i>X</i> and <i>Y</i>,
if each row of <i>X</i> and <i>Y</i> is an observation and each column is a variable,
the <i>(i,j)</i>-th entry of <i>cov(X,Y)</i> is the covariance between the <i>i</i>-th variable in <i>X</i> and the <i>j</i>-th variable in <i>Y</i>
</li>
<br>
<li>
For vector arguments, the type of vector is ignored and each element in the vector is treated as an observation
</li>
<br>
<li>
For matrices, <i>X</i> and <i>Y</i> must have the same dimensions
</li>
<br>
<li>
For vectors, <i>X</i> and <i>Y</i> must have the same number of elements
</li>
<br>
<li>
<i>cov(X)</i> is equivalent to <i>cov(X, X)</i>
</li>
<br>
<li>
The default <i>norm_type=0</i> performs normalisation using <i>N-1</i> (where <i>N</i> is the number of observations),
providing the best unbiased estimation of the covariance matrix (if the observations are from a normal distribution).
Using <i>norm_type=1</i> causes normalisation to be done using <i>N</i>, which provides the second moment matrix of the observations about their mean
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(4,5);
mat Y = randu<mat>(4,5);
mat C = cov(X,Y);
mat D = cov(X,Y, 1);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#cor">cor()</a></li>
<li><a href="#stats_fns">statistics functions</a></li>
<li><a href="#running_stat_vec">running_stat_vec</a></li>
<li><a href="http://mathworld.wolfram.com/Covariance.html">Covariance in MathWorld</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="cross"></a>
<b>cross( A, B )</b>
<ul>
<li>
Calculate the cross product between A and B, under the assumption that A and B are 3 dimensional vectors
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec a = randu<vec>(3);
vec b = randu<vec>(3);
vec c = cross(a,b);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#dot">dot()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Cross_product">Cross product in Wikipedia</a></li>
<li><a href="http://mathworld.wolfram.com/CrossProduct.html">Cross product in MathWorld</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="cumsum"></a>
<b>cumsum( V )</b>
<br><b>cumsum( X )</b>
<br><b>cumsum( X, dim )</b>
<ul>
<li>
For vector <i>V</i>, return a vector of the same orientation, containing the cumulative sum of elements
</li>
<br>
<li>
For matrix <i>X</i>, return a matrix containing the cumulative sum of elements in each column (<i>dim=0</i>), or each row (<i>dim=1</i>)
</li>
<br>
<li>
The <i>dim</i> argument is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = cumsum(A);
mat C = cumsum(A, 1);
vec x = randu<vec>(10);
vec y = cumsum(x);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#accu">accu()</a></li>
<li><a href="#sum">sum()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="diagmat"></a>
<b>diagmat( X )</b>
<ul>
<li>
Interpret a matrix or vector <i>X</i> as a diagonal matrix
</li>
<br>
<li>
If <i>X</i> is a matrix, the matrix must be square; the main diagonal is copied and all other elements in the generated matrix are set to zero
</li>
<br>
<li>
If <i>X</i> is a vector, elements of the vector are placed on the main diagonal in the generated matrix and all other elements are set to zero
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = diagmat(A);
mat C = A*diagmat(A);
rowvec q = randu<rowvec>(5);
colvec r = randu<colvec>(5);
mat X = diagmat(q)*diagmat(r);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#diagvec">diagvec()</a></li>
<li><a href="#diag">.diag()</a></li>
<li><a href="#trimat">trimatu() / trimatl()</a></li>
<li><a href="#symmat">symmatu() / symmatl()</a></li>
<li><a href="#reshape">reshape()</a></li>
<li><a href="#vectorise">vectorise()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="find"></a>
<b>find( X )</b>
<br><b>find( X, k )</b>
<br><b>find( X, k, s )</b>
<ul>
<li>Return a column vector containing the indices of elements of <i>X</i> that are non-zero or satisfy a relational condition</li>
<br>
<li>The output vector must have the type <a href="#Col">uvec</a> or <a href="#Mat">umat</a>
(ie. the indices are stored as unsigned integers of type <a href="#uword">uword</a>)
</li>
<br>
<li>
<i>X</i> is interpreted as a vector, with column-by-column ordering of the elements of <i>X</i>
</li>
<br>
<li>Relational operators can be used instead of <i>X</i>, eg. <i>A > 0.5</i>
</li>
<br>
<li>If <i>k=0</i> (default), return the indices of all non-zero elements, otherwise return at most <i>k</i> of their indices</li>
<br>
<li>If <i>s="first"</i> (default), return at most the first <i>k</i> indices of the non-zero elements
</li>
<br>
<li>If <i>s="last"</i>, return at most the last <i>k</i> indices of the non-zero elements
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = randu<mat>(5,5);
uvec q1 = find(A > B);
uvec q2 = find(A > 0.5);
uvec q3 = find(A > 0.5, 3, "last");
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#all">all()</a></li>
<li><a href="#any">any()</a></li>
<li><a href="#unique">unique()</a></li>
<li><a href="#sort_index">sort_index()</a></li>
<li><a href="#conv_to">conv_to()</a> (convert between matrix/vector types)</li>
<li><a href="#submat">submatrix views</a></li>
<li><a href="#subcube">subcube views</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="flip"></a>
<b>fliplr( X )</b>
<br><b>flipud( X )</b>
<ul>
<li>
<i>fliplr():</i> generate a copy of matrix <i>X</i>, with the order of the columns reversed
</li>
<br>
<li>
<i>flipud():</i> generate a copy of matrix <i>X</i>, with the order of the rows reversed
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = fliplr(A);
mat C = flipud(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#swap_rows">.swap_rows() & .swap_cols()</a></li>
<li><a href="#t_st_members">.t()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="hist"></a>
<b>hist( V )</b>
<br><b>hist( V, n_bins )</b>
<br><b>hist( X )</b>
<br><b>hist( X, n_bins )</b>
<br><b>hist( X, n_bins, dim )</b>
<br>
<br><b>hist( V, centers )</b>
<br><b>hist( X, centers )</b>
<br><b>hist( X, centers, dim )</b>
<ul>
<li>
For vector <i>V</i>,
produce an unsigned vector of the same orientation as <i>V</i> (ie. either <a href="#Col">uvec</a> or <a href="#Row">urowvec</a>)
that represents a histogram of counts
</li>
<br>
<li>
For matrix <i>X</i>,
produce a <a href="#Mat">umat</a> matrix containing either
column histogram counts (for <i>dim=0</i>, default),
or
row histogram counts (for <i>dim=1</i>)
</li>
<br>
<li>
The bin centers can be automatically determined from the data, with the number of bins specified via <i>n_bins</i> (default is 10);
the range of the bins is determined by the range of the data
</li>
<br>
<li>
The bin centers can also be explicitly specified via the <i>centers</i> vector;
the vector must contain monotonically increasing values (eg. 0.1, 0.2, 0.3, ...)
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec v = randn<vec>(1000); // Gaussian distribution
uvec h1 = hist(v, 11);
uvec h2 = hist(v, linspace<vec>(-2,2,11));
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#histc">histc()</a></li>
<li><a href="#stats_fns">statistics functions</a></li>
<li><a href="#conv_to">conv_to()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="histc"></a>
<b>histc( V, edges )</b>
<br><b>histc( X, edges )</b>
<br><b>histc( X, edges, dim )</b>
<ul>
<li>
For vector <i>V</i>,
produce an unsigned vector of the same orientation as <i>V</i> (ie. either <a href="#Col">uvec</a> or <a href="#Row">urowvec</a>)
that contains the counts of the number of values that fall between the elements in the <i>edges</i> vector
</li>
<br>
<li>
For matrix <i>X</i>,
produce a <i>umat</i> matrix containing either
column histogram counts (for <i>dim=0</i>, default),
or
row histogram counts (for <i>dim=1</i>)
</li>
<br>
<li>
The <i>edges</i> vector must contain monotonically increasing values (eg. 0.1, 0.2, 0.3, ...)
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec v = randn<vec>(1000); // Gaussian distribution
uvec h = histc(v, linspace<vec>(-2,2,11));
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#hist">hist()</a></li>
<li><a href="#stats_fns">statistics functions</a></li>
<li><a href="#conv_to">conv_to()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="inplace_strans"></a>
<b>inplace_strans( X )</b>
<br><b>inplace_strans( X, method )</b>
<ul>
<li>
Simple in-place / in-situ transpose of matrix <i>X</i>, without taking the conjugate of the elements (complex matrices)
</li>
<br>
<li>
Use <a href="#inplace_trans">inplace_trans()</a> instead,
unless you explicitly need to take the transpose of a complex matrix without taking the conjugate of the elements
</li>
<br>
<li>
See the documentation for <a href="#inplace_trans">inplace_trans()</a> for more details
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="inplace_trans"></a>
<b>inplace_trans( X )</b>
<br><b>inplace_trans( X, method )</b>
<ul>
<li>
In-place / in-situ transpose of matrix <i>X</i>
</li>
<br>
<li>
If <i>X</i> has real elements, a normal transpose is done
</li>
<br>
<li>
If <i>X</i> has complex elements, a Hermitian transpose is done (ie. the conjugate of the elements is taken during the transpose operation)
</li>
<br>
<li>
The argument <i>method</i> is optional
</li>
<br>
<li>
By default, a standard transposition algorithm is used; a low-memory algorithm can be used instead by explicitly setting <i>method</i> to "lowmem"
</li>
<br>
<li>
The low-memory algorithm is considerably slower than the standard algorithm;
using the low-memory algorithm is only recommended for cases where <i>X</i> takes up more than half of available memory (ie. very large <i>X</i>)
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(4,5);
mat Y = randu<mat>(20000,30000);
inplace_trans(X); // use standard algorithm by default
inplace_trans(Y, "lowmem"); // use low-memory (and slow) algorithm
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#inplace_strans">inplace_strans()</a></li>
<li><a href="#t_st_members">.t()</a></li>
<li><a href="#trans">trans()</a></li>
<li><a href="https://en.wikipedia.org/wiki/In-place_matrix_transposition">inplace matrix transpose in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="join"></a>
<b>join_rows( A, B )</b>
<br><b>join_horiz( A, B )</b>
<br>
<br><b>join_cols( A, B )</b>
<br><b>join_vert( A, B )</b>
<br>
<br><b>join_slices( C, D )</b>
<ul>
<li>
<i>join_rows()</i> and <i>join_horiz()</i>: horizontal concatenation;
for two matrices <i>A</i> and <i>B</i>, join each row of <i>A</i> with the corresponding row of <i>B</i>;
matrices <i>A</i> and <i>B</i> must have the same number of rows
</li>
<br>
<li>
<i>join_cols()</i> and <i>join_vert()</i>: vertical concatenation;
for two matrices <i>A</i> and <i>B</i>, join each column of <i>A</i> with the corresponding column of <i>B</i>;
matrices <i>A</i> and <i>B</i> must have the same number of columns
</li>
<br>
<li>
<i>join_slices()</i>:
for two cubes <i>C</i> and <i>D</i>, join the slices of <i>C</i> with the slices of <i>D</i>;
cubes <i>C</i> and <i>D</i> have the same number of rows and columns (ie. all slices must have the same size)
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
mat B = randu<mat>(4,6);
mat C = randu<mat>(6,5);
mat X = join_rows(A,B);
mat Y = join_cols(A,C);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#shed">shed rows/columns/slices</a></li>
<li><a href="#insert">insert rows/columns/slices</a></li>
<li><a href="#submat">submatrix views</a></li>
<li><a href="#subcube">subcube views</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="kron"></a>
<b>kron( A, B )</b>
<ul>
<li>Kronecker tensor product</li>
<br>
<li>Given matrix <i>A</i> (with <i>n</i> rows and <i>p</i> columns) and matrix <i>B</i> (with <i>m</i> rows and <i>q</i> columns),
generate a matrix (with <i>nm</i> rows and <i>pq</i> columns) that denotes the tensor product of <i>A</i> and <i>B</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
mat B = randu<mat>(5,4);
mat K = kron(A,B);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="http://mathworld.wolfram.com/KroneckerProduct.html">Kronecker Product in MathWorld</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="normalise"></a>
<b>normalise( V )</b>
<br><b>normalise( V, p )</b>
<br>
<br><b>normalise( X )</b>
<br><b>normalise( X, p )</b>
<br><b>normalise( X, p, dim )</b>
<ul>
<li>For vector <i>V</i>, return its normalised version (ie. having unit <i>p</i>-norm)</li>
<br>
<li>
For matrix <i>X</i>, return its normalised version, where each column (<i>dim=0</i>) or row (<i>dim=1</i>) has been normalised to have unit <i>p</i>-norm</li>
<br>
<li>
The <i>p</i> argument is optional; by default <i>p=2</i> is used
</li>
<br>
<li>
The <i>dim</i> argument is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>
Examples:
<ul>
<pre>
vec A = randu<vec>(10);
vec B = normalise(A);
vec C = normalise(A, 1);
mat X = randu<mat>(5,6);
mat Y = normalise(X);
mat Z = normalise(X, 2, 1);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#norm">norm()</a></li>
<li><a href="#dot">norm_dot()</a></li>
<li><a href="http://mathworld.wolfram.com/NormalizedVector.html">Normalised vector in MathWorld</a>
<li><a href="http://en.wikipedia.org/wiki/Unit_vector">Unit vector in Wikipedia</a>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<br>
<a name="reshape"></a>
<b>reshape( mat, n_rows, n_cols )</b>
<br><b>reshape( cube, n_rows, n_cols, n_slices )</b>
<ul>
<li>
Generate a matrix or cube sized according to given size specifications,
whose elements are taken from the given matrix/cube in a column-wise manner;
the elements in the generated object are placed column-wise (ie. the first column is filled up before filling the second column)
</li>
<br>
<li>
The layout of the elements in the generated object will be different to the layout in the given object
</li>
<br>
<li>
The total number of elements in the generated matrix/cube doesn't have to be the same as the total number of elements in the given matrix/cube
</li>
<br>
<li>
If the total number of elements in the given matrix/cube is less than the specified size,
the remaining elements in the generated matrix/cube are set to zero
</li>
<br>
<li>
If the total number of elements in the given matrix/cube is greater than the specified size,
only a subset of elements is taken from the given matrix/cube
</li>
<br>
<li>
<b>Caveat:</b>
do not use <i>reshape()</i> if you simply want to change the size without preserving data;
use <a href="#set_size">.set_size()</a> instead, which is much faster
</li>
<br>
<li>
<b>Caveat:</b>
if you wish to grow/shrink a matrix while preserving the elements <b>as well as</b> the layout of the elements,
use <a href="#resize">resize()</a> instead
</li>
<br>
<li>
<b>Caveat:</b>
if you want to create a vector representation of a matrix (ie. concatenate all the columns or rows),
use <a href="#vectorise">vectorise()</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(10, 5);
mat B = reshape(A, 5, 10);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#reshape_member">.reshape()</a> (member function of Mat and Cube)</li>
<li><a href="#set_size">.set_size()</a> (member function of Mat and Cube)</li>
<li><a href="#resize">resize()</a></li>
<li><a href="#vectorise">vectorise()</a></li>
<li><a href="#as_scalar">as_scalar()</a></li>
<li><a href="#conv_to">conv_to()</a></li>
<li><a href="#diagmat">diagmat()</a></li>
<li><a href="#repmat">repmat()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="resize"></a>
<b>resize( mat, n_rows, n_cols )</b>
<br><b>resize( cube, n_rows, n_cols, n_slices )</b>
<ul>
<li>
Generate a matrix or cube sized according to given size specifications,
whose elements as well as the layout of the elements are taken from the given matrix/cube
</li>
<br>
<li>
<b>Caveat:</b>
do not use <i>resize()</i> if you simply want to change the size without preserving data;
use <a href="#set_size">.set_size()</a> instead, which is much faster
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4, 5);
mat B = resize(A, 7, 6);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#resize_member">.resize()</a> (member function of Mat and Cube)</li>
<li><a href="#set_size">.set_size()</a> (member function of Mat and Cube)</li>
<li><a href="#reshape">reshape()</a></li>
<li><a href="#vectorise">vectorise()</a></li>
<li><a href="#as_scalar">as_scalar()</a></li>
<li><a href="#conv_to">conv_to()</a></li>
<li><a href="#repmat">repmat()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="shuffle"></a>
<b>shuffle( V )</b>
<br><b>shuffle( X )</b>
<br><b>shuffle( X, dim )</b>
<ul>
<li>
For vector <i>V</i>, generate a copy of the vector with the elements shuffled
</li>
<br>
<li>
For matrix <i>X</i>, generate a copy of the matrix with the rows (<i>dim=0</i>) or columns (<i>dim=1</i>) shuffled
</li>
<br>
<li>
The <i>dim</i> argument is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
mat B = shuffle(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#randu_randn_standalone">randu() / randn()</a></li>
<li><a href="#sort">sort()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="sort"></a>
<b>sort( V )</b>
<br><b>sort( V, sort_direction )</b>
<br>
<br><b>sort( X )</b>
<br><b>sort( X, sort_direction )</b>
<br><b>sort( X, sort_direction, dim )</b>
<br>
<ul>
<li>For vector <i>V</i>, return a vector which is a sorted version of the input vector</li>
<br>
<li>For matrix <i>X</i>, return a matrix with the elements of the input matrix sorted in each column (<i>dim=0</i>), or each row (<i>dim=1</i>)</li>
<br>
<li>
The <i>dim</i> argument is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>The <i>sort_direction</i> argument is optional; <i>sort_direction</i> is either "ascend" or "descend"; by default "ascend" is used</li>
<br>
<li>For matrices and vectors with complex numbers, sorting is via absolute values</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(10,10);
mat B = sort(A);
</pre>
</ul>
</li>
<li>
See also:
<ul>
<li><a href="#sort_index">sort_index()</a></li>
<li><a href="#shuffle">shuffle()</a></li>
<li><a href="#randu_randn_standalone">randu() / randn()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="sort_index"></a>
<b>sort_index( V )</b>
<br><b>sort_index( V, sort_direction )</b>
<br>
<br><b>stable_sort_index( V )</b>
<br><b>stable_sort_index( V, sort_direction )</b>
<ul>
<li>Return a vector which describes the sorted order of the elements of input vector <i>V</i>
(ie. it contains the indices of the elements of <i>V</i>)
</li>
<br>
<li>The output vector must have the type <a href="#Col">uvec</a> or <a href="#Mat">umat</a>
(ie. the indices are stored as unsigned integers of type <a href="#uword">uword</a>)
</li>
<br>
<li>The <i>sort_direction</i> argument is optional; <i>sort_direction</i> is either "ascend" or "descend"; by default "ascend" is used</li>
<br>
<li>The <i>stable_sort_index()</i> variant preserves the relative order of elements with equivalent values</li>
<br>
<li>
Examples:
<ul>
<pre>
vec q = randu<vec>(10);
uvec indices = sort_index(q);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#find">find()</a></li>
<li><a href="#sort">sort()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="symmat"></a>
<b>symmatu( A )</b>
<br><b>symmatl( A )</b>
<ul>
<li>
<i>symmatu(A)</i>: interpret square matrix <i>A</i> as symmetric, reflecting the upper triangle to the lower triangle
</li>
<br>
<li>
<i>symmatl(A)</i>: interpret square matrix <i>A</i> as symmetric, reflecting the lower triangle to the upper triangle
</li>
<br>
<li>
If <i>A</i> is non-square, a <i>std::logic_error</i> exception is thrown
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = symmatu(A);
mat C = symmatl(A);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#diagmat">diagmat()</a></li>
<li><a href="#trimat">trimatu() / trimatl()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Symmetric_matrix">Symmetric matrix in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="strans"></a>
<b>strans( A )</b>
<ul>
<li>
Simple matrix transpose of <i>A</i>, without taking the conjugate of the elements (complex matrices)
</li>
<br>
<li>
Use <a href="#trans">trans()</a> instead, unless you explicitly need to take the transpose of a complex matrix without taking the conjugate of the elements
</li>
<br>
<li>See also:
<ul>
<li><a href="#t_st_members">.st()</a></li>
<li><a href="#trans">trans()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="trans"></a>
<b>trans( A )</b>
<ul>
<li>
Matrix transpose / Hermitian transpose of <i>A</i>
</li>
<br>
<li>
If <i>A</i> has real elements, a normal transpose is done
</li>
<br>
<li>
If <i>A</i> has complex elements, a Hermitian transpose is done (ie. the conjugate of the elements is taken during the transpose operation)
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,10);
mat B = trans(A);
mat C = A.t(); // equivalent to trans(A), but more compact
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#t_st_members">.t()</a></li>
<li><a href="#strans">strans()</a></li>
<li><a href="#inplace_trans">inplace_trans</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="trimat"></a>
<b>trimatu( A )</b>
<br><b>trimatl( A )</b>
<ul>
<li>
<i>trimatu(A)</i>: interpret square matrix <i>A</i> as upper triangular
</li>
<br>
<li>
<i>trimatl(A)</i>: interpret square matrix <i>A</i> as lower triangular
</li>
<br>
<li>
A <i>std::logic_error</i> exception is thrown if <i>A</i> is non-square
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat U = trimatu(A);
mat L = trimatl(A);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#symmat">symmatu() / symmatl()</a></li>
<li><a href="#diagmat">diagmat()</a></li>
<li><a href="http://mathworld.wolfram.com/TriangularMatrix.html">Triangular matrix in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Triangular_matrix">Triangular matrix in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline">
<br>
<a name="unique"></a>
<b>unique( A )</b>
<br>
<ul>
<li>
Return the unique elements of <i>A</i>, sorted in ascending order
</li>
<br>
<li>
If <i>A</i> is a vector, the output is also a vector with the same orientation (row or column) as <i>A</i>;
if <i>A</i> is a matrix, the output is always a column vector
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X;
X << 1 << 2 << endr
<< 2 << 3 << endr;
mat Y = unique(X);
</pre>
</ul>
</li>
<br>
<li>See also:
<ul>
<li><a href="#find">find()</a></li>
<li><a href="#sort">sort()</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline">
<a name="vectorise"></a>
<b>vectorise( A )</b>
<br><b>vectorise( A, dim )</b>
<ul>
<li>
Generate a column vector (<i>dim=0</i>) or row vector (<i>dim=1</i>) from matrix <i>A</i>
</li>
<br>
<li>
The argument <i>dim</i> is optional; by default <i>dim=0</i> is used
</li>
<br>
<li>
For <i>dim=0</i>, the elements are copied from <i>X</i> column-wise; equivalent to concatenating all the columns of <i>A</i>
</li>
<br>
<li>
For <i>dim=1</i>, the elements are copied from <i>X</i> row-wise; equivalent to concatenating all the rows of <i>A</i>
</li>
<br>
<li>
Concatenating columns is faster than concatenating rows
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4, 5);
vec v = vectorise(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#reshape">reshape()</a></li>
<li><a href="#resize">resize()</a></li>
<li><a href="#as_scalar">as_scalar()</a></li>
<li><a href="#diagvec">diagvec()</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<hr class="greyline">
<br>
<br>
<font size=+1><b>Decompositions, Factorisations, Inverses and Equation Solvers</b></font>
<br>
<br>
<hr class="greyline">
<br>
<a name="chol"></a>
<b>R = chol( X )</b>
<br><b>chol( R, X )</b>
<ul>
<li>
Cholesky decomposition of matrix <i>X</i>, such that <i>R.t()*R = X</i>
</li>
<br>
<li>
Matrix <i>X</i> must be symmetric and positive-definite
</li>
<br>
<li>If the decomposition fails, <i>R</i> is reset and:
<ul>
<li><i>chol(X)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>chol(R,X)</i> returns a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(5,5);
mat Y = X.t()*X;
mat R = chol(Y);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="http://mathworld.wolfram.com/CholeskyDecomposition.html">Cholesky decomposition in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Cholesky_decomposition">Cholesky decomposition in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="eig_sym"></a>
<b>vec eigval = eig_sym( X )</b>
<br>
<br><b>eig_sym( eigval, X )</b>
<br>
<br><b>eig_sym( eigval, eigvec, X )</b>
<br><b>eig_sym( eigval, eigvec, X, method )</b>
<ul>
<li>Eigen decomposition of <b>dense</b> symmetric/hermitian matrix <i>X</i></li>
<br>
<li>The eigenvalues and corresponding eigenvectors are stored in <i>eigval</i> and <i>eigvec</i>, respectively</li>
<br>
<li>The eigenvalues are in ascending order</li>
<br>
<li>If <i>X</i> is not square, a <i>std::logic_error</i> exception is thrown</li>
<br>
<li>The <i>method</i> argument is optional; <i>method</i> is either "dc" or "std", with "dc" indicating divide-and-conquer and "std" indicating standard
<ul>
<li>
In version 4.000 and later, the default method is "dc"
</li>
<li>
In version 3.930, the default method is "std"
</li>
</ul>
</li>
<br>
<li>
The divide-and-conquer method provides slightly different results than the standard method, but is considerably faster for large matrices
</li>
<br>
<li>If the decomposition fails, the output objects are reset and:
<ul>
<li><i>eig_sym(X)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>eig_sym(eigval, X)</i> and <i>eig_sym(eigval, eigvec, X)</i> return a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>There is currently no check whether <i>X</i> is symmetric</li>
<br>
<li>
Examples:
<ul>
<pre>
// for matrices with real elements
mat A = randu<mat>(50,50);
mat B = A.t()*A; // generate a symmetric matrix
vec eigval;
mat eigvec;
eig_sym(eigval, eigvec, B);
// for matrices with complex elements
cx_mat C = randu<cx_mat>(50,50);
cx_mat D = C.t()*C;
vec eigval2;
cx_mat eigvec2;
eig_sym(eigval2, eigvec2, D);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#eig_gen">eig_gen()</a></li>
<li><a href="#eig_pair">eig_pair()</a></li>
<li><a href="#svd">svd()</a></li>
<li><a href="#svd_econ">svd_econ()</a></li>
<li><a href="#eigs_sym">eigs_sym()</a></li>
<li><a href="http://mathworld.wolfram.com/EigenDecomposition.html">eigen decomposition in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Eigenvalues_and_eigenvectors">eigenvalues & eigenvectors in Wikipedia</a></li>
<li><a href="http://en.wikipedia.org/wiki/Divide-and-conquer_eigenvalue_algorithm">divide & conquer eigenvalue algorithm in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="eig_gen"></a>
<b>cx_vec eigval = eig_gen( X )</b>
<br>
<br><b>eig_gen( eigval, X )</b>
<br>
<br><b>eig_gen( eigval, eigvec, X )</b>
<ul>
<li>
Eigen decomposition of <b>dense</b> general (non-symmetric/non-hermitian) square matrix <i>X</i></li>
<br>
<li>The eigenvalues and corresponding eigenvectors are stored in <i>eigval</i> and <i>eigvec</i>, respectively</li>
<br>
<li>If <i>X</i> is not square, a <i>std::logic_error</i> exception is thrown</li>
<br>
<li>If the decomposition fails, the output objects are reset and:
<ul>
<li><i>eig_gen(X)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>eig_gen(eigval, X)</i> and <i>eig_gen(eigval, eigvec, X)</i> return a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(10,10);
cx_vec eigval;
cx_mat eigvec;
eig_gen(eigval, eigvec, A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#eig_pair">eig_pair()</a></li>
<li><a href="#eig_sym">eig_sym()</a></li>
<li><a href="#svd">svd()</a></li>
<li><a href="#svd_econ">svd_econ()</a></li>
<li><a href="#eigs_gen">eigs_gen()</a></li>
<li><a href="http://mathworld.wolfram.com/EigenDecomposition.html">eigen decomposition in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Eigenvalues_and_eigenvectors">eigenvalues & eigenvectors in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="eig_pair"></a>
<b>cx_vec eigval = eig_pair( A, B )</b>
<br>
<br><b>eig_pair( eigval, A, B )</b>
<br>
<br><b>eig_pair( eigval, eigvec, A, B )</b>
<ul>
<li>
Eigen decomposition for pair of general <b>dense</b> square matrices <i>A</i> and <i>B</i> of the same size,
such that <i>A*eigvec = B*eigvec*diagmat(eigval)</i>
</li>
<br>
<li>The eigenvalues and corresponding eigenvectors are stored in <i>eigval</i> and <i>eigvec</i>, respectively</li>
<br>
<li>If <i>A</i> or <i>B</i> is not square, a <i>std::logic_error</i> exception is thrown</li>
<br>
<li>If the decomposition fails, the output objects are reset and:
<ul>
<li><i>eig_pair(A,B)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>eig_pair(eigval, A, B)</i> and <i>eig_pair(eigval, eigvec, A, B)</i> return a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(10,10);
mat B = randu<mat>(10,10);
cx_vec eigval;
cx_mat eigvec;
eig_pair(eigval, eigvec, A, B);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#eig_gen">eig_gen()</a></li>
<li><a href="#eig_sym">eig_sym()</a></li>
<li><a href="http://mathworld.wolfram.com/EigenDecomposition.html">eigen decomposition in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Eigenvalues_and_eigenvectors">eigenvalues & eigenvectors in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="eigs_sym"></a>
<b>vec eigval = eigs_sym( X, k )</b>
<br><b>vec eigval = eigs_sym( X, k, form )</b>
<br>
<br><b>eigs_sym( eigval, X, k )</b>
<br><b>eigs_sym( eigval, X, k, form )</b>
<br>
<br><b>eigs_sym( eigval, eigvec, X, k )</b>
<br><b>eigs_sym( eigval, eigvec, X, k, form )</b>
<ul>
<li>Obtain a limited number of eigenvalues and eigenvectors of <b>sparse</b> symmetric real matrix <i>X</i></li>
<br>
<li>
<i>k</i> specifies the number of eigenvalues and eigenvectors
</li>
<br>
<li>The argument <i>form</i> is optional; <i>form</i> is either "lm" or "sm":
<ul>
<table>
<tbody>
<tr><td><li>"lm":</li> </td><td> </td><td>obtain eigenvalues with largest magnitude (default operation)</td></tr>
<tr><td><li>"sm":</li> </td><td> </td><td>obtain eigenvalues with smallest magnitude</td></tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>The eigenvalues and corresponding eigenvectors are stored in <i>eigval</i> and <i>eigvec</i>, respectively</li>
<br>
<li>If <i>X</i> is not square, a <i>std::logic_error</i> exception is thrown</li>
<br>
<li>If the decomposition fails, the output objects are reset and:
<ul>
<li><i>eigs_sym(X,k)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>eigs_sym(eigval,X,k)</i> and <i>eigs_sym(eigval,eigvec,X,k)</i> return a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>There is currently no check whether <i>X</i> is symmetric</li>
<br>
<li>
Examples:
<ul>
<pre>
sp_mat A = sprandu<mat>(1000, 1000, 0.1);
sp_mat B = A.t()*A; // generate sparse symmetric matrix
vec eigval;
mat eigvec;
eigs_sym(eigval, eigvec, B);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#eigs_gen">eigs_gen()</a></li>
<li><a href="#eig_sym">eig_sym()</a></li>
<li><a href="http://mathworld.wolfram.com/EigenDecomposition.html">eigen decomposition in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Eigenvalues_and_eigenvectors">eigenvalues & eigenvectors in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="eigs_gen"></a>
<b>cx_vec eigval = eigs_gen( X, k )</b>
<br><b>cx_vec eigval = eigs_gen( X, k, form )</b>
<br>
<br><b>eigs_gen( eigval, X, k )</b>
<br><b>eigs_gen( eigval, X, k, form )</b>
<br>
<br><b>eigs_gen( eigval, eigvec, X, k )</b>
<br><b>eigs_gen( eigval, eigvec, X, k, form )</b>
<ul>
<li>
Obtain a limited number of eigenvalues and eigenvectors of <b>sparse</b> general (non-symmetric/non-hermitian) square matrix <i>X</i>
</li>
<br>
<li>
<i>k</i> specifies the number of eigenvalues and eigenvectors
</li>
<br>
<li>The argument <i>form</i> is optional; <i>form</i> is one of:
<ul>
<table>
<tbody>
<tr><td><li>"lm":</li> </td><td> </td><td>obtain eigenvalues with largest magnitude (default operation)</td></tr>
<tr><td><li>"sm":</li> </td><td> </td><td>obtain eigenvalues with smallest magnitude</td></tr>
<tr><td><li>"lr":</li> </td><td> </td><td>obtain eigenvalues with largest real part</td></tr>
<tr><td><li>"sr":</li> </td><td> </td><td>obtain eigenvalues with smallest real part</td></tr>
<tr><td><li>"li":</li> </td><td> </td><td>obtain eigenvalues with largest imaginary part</td></tr>
<tr><td><li>"si":</li> </td><td> </td><td>obtain eigenvalues with smallest imaginary part</td></tr>
</tbody>
</table>
</ul>
</li>
<br>
<li>
The eigenvalues and corresponding eigenvectors are stored in <i>eigval</i> and <i>eigvec</i>, respectively
</li>
<br>
<li>
If <i>X</i> is not square, a <i>std::logic_error</i> exception is thrown
</li>
<br>
<li>If the decomposition fails, the output objects are reset and:
<ul>
<li><i>eigs_gen(X,k)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>eigs_gen(eigval,X,k)</i> and <i>eigs_gen(eigval,eigvec,X,k)</i> return a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
sp_mat A = sprandu<sp_mat>(1000, 1000, 0.1);
cx_vec eigval;
cx_mat eigvec;
eigs_gen(eigval, eigvec, A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#eigs_sym">eigs_sym()</a></li>
<li><a href="#eig_gen">eig_gen()</a></li>
<li><a href="http://mathworld.wolfram.com/EigenDecomposition.html">eigen decomposition in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Eigenvalues_and_eigenvectors">eigenvalues & eigenvectors in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="fft"></a>
<b>cx_mat Y = fft( X )</b><br>
<b>cx_mat Y = fft( X, n )</b><br>
<br>
<b>cx_mat Z = ifft( cx_mat Y )</b><br>
<b>cx_mat Z = ifft( cx_mat Y, n )</b><br>
<ul>
<li>fft(): fast Fourier transform of a vector or matrix (real or complex)</li>
<br>
<li>ifft(): inverse fast Fourier transform of a vector or matrix (complex only)</li>
<br>
<li>If given a matrix, the transform is done on each column vector of the matrix</li>
<br>
<li>
The optional <i>n</i> argument specifies the transform length:
<ul>
<li>if <i>n</i> is larger than the length of the input vector, a zero-padded version of the vector is used</li>
<li>if <i>n</i> is smaller than the length of the input vector, only the first <i>n</i> elements of the vector are used</li>
</ul>
</li>
<br>
<li>
If <i>n</i> is not specified, the transform length is the same as the length of the input vector
</li>
<br>
<li><b>Caveat:</b> the transform is fastest when the transform length is a power of 2, eg. 64, 128, 256, 512, 1024, ...</li>
<br>
<li>The implementation of the transform in this version is preliminary; it is not yet fully optimised</li>
<br>
<li>
Examples:
<ul>
<pre>
vec X = randu<vec>(100);
cx_vec Y = fft(X, 128);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#fft2">fft2()</a></li>
<li><a href="#conv">conv()</a></li>
<li><a href="#imag_real">real()</a></li>
<li><a href="http://mathworld.wolfram.com/FastFourierTransform.html">fast Fourier transform in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Fast_Fourier_transform">fast Fourier transform in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="fft2"></a>
<b>cx_mat Y = fft2( X )</b><br>
<b>cx_mat Y = fft2( X, n_rows, n_cols )</b><br>
<br>
<b>cx_mat Z = ifft2( cx_mat Y )</b><br>
<b>cx_mat Z = ifft2( cx_mat Y, n_rows, n_cols )</b><br>
<ul>
<li>fft2(): 2D fast Fourier transform of a matrix (real or complex)</li>
<br>
<li>ifft2(): 2D inverse fast Fourier transform of a matrix (complex only)</li>
<br>
<li>
The optional arguments <i>n_rows</i> and <i>n_cols</i> specify the size of the transform;
a truncated and/or zero-padded version of the input matrix is used
</li>
<br>
<li><b>Caveat:</b> the transform is fastest when both <i>n_rows</i> and <i>n_cols</i> are a power of 2, eg. 64, 128, 256, 512, 1024, ...</li>
<br>
<li>The implementation of the transform in this version is preliminary; it is not yet fully optimised</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(100,100);
cx_mat B = fft2(A);
cx_mat C = fft2(A, 128, 128);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#fft">fft()</a></li>
<li><a href="#conv">conv()</a></li>
<li><a href="#imag_real">real()</a></li>
<li><a href="http://mathworld.wolfram.com/FastFourierTransform.html">fast Fourier transform in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Fast_Fourier_transform">fast Fourier transform in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="inv"></a>
<b>B = inv( A )</b>
<br><b>B = inv( A, method )</b>
<br>
<br><b>inv( B, A )</b>
<br><b>inv( B, A, method )</b>
<ul>
<li>
Inverse of square matrix <i>A</i>
</li>
<br>
<li>The <i>method</i> argument is optional.
For matrix sizes ≤ 4x4, a fast algorithm is used.
In rare instances, the fast algorithm might be less precise than the standard algorithm.
To force the use of the standard algorithm, set the <i>method</i> argument to "std".
For matrix sizes greater than 4x4, the standard algorithm is always used
</li>
<br>
<li>
If <i>A</i> is not square, a <i>std::logic_error</i> exception is thrown
</li>
<br>
<li>If <i>A</i> appears to be singular, <i>B</i> is reset and:
<ul>
<li><i>inv(A)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>inv(B,A)</i> returns a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>
<b>Caveat:</b> if matrix <i>A</i> is know to be symmetric positive definite, it's faster to use <a href="#inv_sympd">inv_sympd()</a> instead
</li>
<br>
<li>
<b>Caveat:</b> if matrix <i>A</i> is know to be diagonal, use <i>inv( diagmat(A) )</i>
</li>
<br>
<li>
<b>Caveat:</b>
if you want to solve a system of linear equations, such as <i>Z = inv(X)*Y</i>,
it is faster and more accurate to use <a href="#solve">solve()</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = inv(A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#i_member">.i()</a>
<li><a href="#inv_sympd">inv_sympd()</a>
<li><a href="#cond">cond()</a>
<li><a href="#pinv">pinv()</a>
<li><a href="#solve">solve()</a></li>
<li><a href="#diagmat">diagmat()</a></li>
<li><a href="http://mathworld.wolfram.com/MatrixInverse.html">matrix inverse in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Invertible_matrix">invertible matrix in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="inv_sympd"></a>
<b>B = inv_sympd( A )</b>
<br><b>inv_sympd( B, A )</b>
<ul>
<li>
Inverse of symmetric positive definite matrix <i>A</i>
</li>
<br>
<li>
If <i>A</i> is not square, a <i>std::logic_error</i> exception is thrown
</li>
<br>
<li>
There is currently no explicit check whether <i>A</i> is symmetric or positive definite
</li>
<br>
<li>If <i>A</i> appears to be singular, <i>B</i> is reset and:
<ul>
<li><i>inv_sympd(A)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>inv_sympd(B,A)</i> returns a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>
<b>Caveat:</b>
if you want to solve a system of linear equations, such as <i>Z = inv(X)*Y</i>,
it is faster and more accurate to use <a href="#solve">solve()</a> instead
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat AtA = A.t() * A;
mat B = inv_sympd(AtA);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#inv">inv()</a>
<li><a href="#cond">cond()</a>
<li><a href="#pinv">pinv()</a>
<li><a href="#solve">solve()</a></li>
<li><a href="#eig_sym">eig_sym()</a></li>
<li><a href="http://mathworld.wolfram.com/MatrixInverse.html">matrix inverse in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Invertible_matrix">invertible matrix in Wikipedia</a></li>
<li><a href="http://mathworld.wolfram.com/PositiveDefiniteMatrix.html">positive definite matrix in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Positive-definite_matrix">positive definite matrix in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="lu"></a>
<b>lu( L, U, P, X )</b>
<br><b>lu( L, U, X )</b>
<ul>
<li>
Lower-upper decomposition (with partial pivoting) of matrix <i>X</i>
</li>
<br>
<li>
The first form provides
a lower-triangular matrix <i>L</i>,
an upper-triangular matrix <i>U</i>,
and a permutation matrix <i>P</i>,
such that <i>P.t()*L*U = X</i>
</li>
<br>
<li>
The second form provides permuted <i>L</i> and <i>U</i>, such that <i>L*U = X</i>;
note that in this case <i>L</i> is generally not lower-triangular
</li>
<br>
<li>
If the decomposition fails, the output objects are reset and <i>lu()</i> returns a bool set to <i>false</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat L, U, P;
lu(L, U, P, A);
mat B = P.t()*L*U;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="http://en.wikipedia.org/wiki/LU_decomposition">LU decomposition in Wikipedia</a></li>
<li><a href="http://mathworld.wolfram.com/LUDecomposition.html">LU decomposition in MathWorld</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="pinv"></a>
<b>B = pinv( A)</b>
<br><b>B = pinv( A, tolerance )</b>
<br><b>B = pinv( A, tolerance, method )</b>
<br>
<br><b>pinv( B, A )</b>
<br><b>pinv( B, A, tolerance )</b>
<br><b>pinv( B, A, tolerance, method )</b>
<ul>
<li>Moore-Penrose pseudo-inverse of matrix <i>A</i></li>
<br>
<li>The computation is based on singular value decomposition;
if the decomposition fails, <i>B</i> is reset and:
<ul>
<li><i>pinv(A)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>pinv(B,A)</i> returns a bool set to <i>false</i></li>
</ul>
<br>
<li>The <i>tolerance</i> argument is optional</li>
<br>
<li>For matrix <i>A</i> with <i>m</i> rows and <i>n</i> columns,
the default tolerance is <i>max(m,n)*norm(A)*datum::eps</i>,
where <i>datum::eps</i> denotes the difference between 1 and the least value greater than 1 that is representable</li>
<br>
<li>Any singular values less than <i>tolerance</i> are treated as zero</li>
<br>
<li>The <i>method</i> argument is optional; <i>method</i> is either "dc" or "std", with "dc" indicating divide-and-conquer and "std" indicating standard
<ul>
<li>
In version 4.000 and later, the default method is "dc"
</li>
<li>
In version 3.930, the default method is "std"
</li>
</ul>
</li>
<br>
<li>
The divide-and-conquer method provides slightly different results than the standard method, but is considerably faster for large matrices
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(4,5);
mat B = pinv(A); // use default tolerance
mat C = pinv(A, 0.01); // set tolerance to 0.01
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#i_member">.i()</a></li>
<li><a href="#inv">inv()</a></li>
<li><a href="#solve">solve()</a></li>
<li><a href="#constants">datum::eps</a></li>
<li><a href="http://mathworld.wolfram.com/Pseudoinverse.html">Pseudoinverse in MathWorld</a></li>
<li><a href="http://mathworld.wolfram.com/Moore-PenroseMatrixInverse.html">Moore-Penrose Matrix Inverse in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Moore-Penrose_pseudoinverse">Moore-Penrose pseudoinverse in Wikipedia</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="princomp"></a>
<b>mat coeff = princomp( mat X )</b>
<br><b>cx_mat coeff = princomp( cx_mat X )</b><br>
<br><b>princomp( mat coeff, mat X )</b>
<br><b>princomp( cx_mat coeff, cx_mat X )</b><br>
<br><b>princomp( mat coeff, mat score, mat X )</b>
<br><b>princomp( cx_mat coeff, cx_mat score, cx_mat X )</b><br>
<br><b>princomp( mat coeff, mat score, vec latent, mat X )</b>
<br><b>princomp( cx_mat coeff, cx_mat score, vec latent, cx_mat X )</b><br>
<br><b>princomp( mat coeff, mat score, vec latent, vec tsquared, mat X )</b>
<br><b>princomp( cx_mat coeff, cx_mat score, vec latent, cx_vec tsquared, cx_mat X )</b><br>
<br>
<ul>
<li>Principal component analysis of matrix <i>X</i></li><br>
<li>Each row of <i>X</i> is an observation and each column is a variable</li><br>
<li>output objects:
<ul>
<li><i>coeff</i>: principal component coefficients</li>
<li><i>score</i>: projected data</li>
<li><i>latent</i>: eigenvalues of the covariance matrix of <i>X</i></li>
<li><i>tsquared</i>: Hotteling's statistic for each sample</li>
</ul>
</li>
<br>
<li>The computation is based on singular value decomposition;
if the decomposition fails, the output objects are reset and:
<ul>
<li><i>princomp(X)</i> throws a <i>std::runtime_error</i> exception</li>
<li>remaining forms of <i>princomp()</i> return a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,4);
mat coeff;
mat score;
vec latent;
vec tsquared;
princomp(coeff, score, latent, tsquared, A);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="http://en.wikipedia.org/wiki/Principal_component_analysis">principal components analysis in Wikipedia</a></li>
<li><a href="http://mathworld.wolfram.com/PrincipalComponentAnalysis.html">principal components analysis in MathWorld</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="qr"></a>
<b>qr( Q, R, X )</b>
<ul>
<li>
Decomposition of <i>X</i> into an orthogonal matrix <i>Q</i> and a right triangular matrix <i>R</i>, such that <i>Q*R = X</i>
</li>
<br>
<li>
If the decomposition fails, <i>Q</i> and <i>R</i> are reset and the function returns a bool set to <i>false</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(5,5);
mat Q, R;
qr(Q,R,X);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#qr_econ">qr_econ()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Orthogonal_matrix">orthogonal matrix in Wikipedia</a></li>
<li><a href="http://en.wikipedia.org/wiki/QR_decomposition">QR decomposition in Wikipedia</a></li>
<li><a href="http://mathworld.wolfram.com/QRDecomposition.html">QR decomposition in MathWorld</a></li>
<li><a href="http://octave.sourceforge.net/octave/function/qr.html">QR decomposition in Octave</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="qr_econ"></a>
<b>qr_econ( Q, R, X )</b>
<ul>
<li>
Economical decomposition of <i>X</i> (with size <i>m</i> x <i>n</i>) into an orthogonal matrix <i>Q</i> and a right triangular matrix <i>R</i>, such that <i>Q*R = X</i>
</li>
<br>
<li>
If <i>m</i> > <i>n</i>, only the first <i>n</i> rows of <i>R</i> and the first <i>n</i> columns of <i>Q</i> are calculated
(ie. the zero rows of <i>R</i> and the corresponding columns of <i>Q</i> are omitted)
</li>
<br>
<li>
If the decomposition fails, <i>Q</i> and <i>R</i> are reset and the function returns a bool set to <i>false</i>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(6,5);
mat Q, R;
qr_econ(Q,R,X);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#qr">qr()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Orthogonal_matrix">orthogonal matrix in Wikipedia</a></li>
<li><a href="http://en.wikipedia.org/wiki/QR_decomposition">QR decomposition in Wikipedia</a></li>
<li><a href="http://octave.sourceforge.net/octave/function/qr.html">QR decomposition in Octave</a></li>
<li><a href="http://mathworld.wolfram.com/QRDecomposition.html">QR decomposition in MathWorld</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<a name="solve"></a>
<b>X = solve( A, B )</b>
<br><b>X = solve( A, B, method )</b>
<br>
<br><b>solve( X, A, B )</b>
<br><b>solve( X, A, B, method )</b>
<ul>
<li>Solve a system of linear equations, <i>A*X = B</i>, where <i>X</i> is unknown;
similar functionality to the \ operator in Matlab/Octave, ie. <i>X = A \ B</i>
</li>
<br>
<li>If <i>A</i> is square, <i>solve()</i> is faster and more accurate than using <i>X = inv(A)*B</i></li>
<br>
<li>
If <i>A</i> is non-square,
<i>solve()</i> will try to provide approximate solutions to under-determined as well as over-determined systems</li>
<br>
<li>
<i>B</i> can be a vector or a matrix
</li>
<br>
<li>
The number of rows in <i>A</i> and <i>B</i> must be the same
</li>
<br>
<li>The <i>method</i> argument is optional.
For matrix sizes ≤ 4x4, a fast algorithm is used.
In rare instances, the fast algorithm might be less precise than the standard algorithm.
To force the use of the standard algorithm,
set the <i>method</i> argument to "std".
For matrix sizes greater than 4x4, the standard algorithm is always used
</li>
<br>
<li>
If <i>A</i> is known to be a triangular matrix,
the solution can be computed faster by explicitly marking <i>A</i> as triangular
through <a href="#trimat">trimatu()</a> or <a href="#trimat">trimatl()</a>
</li>
<br>
<li>
If no solution is found, <i>X</i> is reset and:
<ul>
<li><i>solve(A,B)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>solve(X,A,B)</i> returns a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
vec b = randu<vec>(5);
mat B = randu<mat>(5,5);
vec x = solve(A, b);
mat X = solve(A, B);
vec x2;
solve(x2, A, b);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#i_member">.i()</a></li>
<li><a href="#inv">inv()</a></li>
<li><a href="#pinv">pinv()</a></li>
<li><a href="#syl">syl()</a></li>
<li><a href="http://mathworld.wolfram.com/LinearSystemofEquations.html">linear system of equations in MathWorld</a></li>
<li><a href="http://en.wikipedia.org/wiki/Linear_system_of_equations">system of linear equations in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="svd"></a>
<b>vec s = svd( mat X )</b>
<br><b>vec s = svd( cx_mat X )</b>
<br>
<br><b>svd( vec s, mat X )</b>
<br><b>svd( vec s, cx_mat X )</b>
<br>
<br><b>svd( mat U, vec s, mat V, mat X )</b>
<br><b>svd( mat U, vec s, mat V, mat X, method )</b>
<br>
<br><b>svd( cx_mat U, vec s, cx_mat V, cx_mat X )</b>
<br><b>svd( cx_mat U, vec s, cx_mat V, cx_mat X, method )</b>
<ul>
<li>
Singular value decomposition of matrix <i>X</i>
</li>
<br>
<li>If <i>X</i> is square, it can be reconstructed using <i>X = U*diagmat(s)*V.t()</i>
</li>
<br>
<li>
The singular values are in descending order
</li>
<br>
<li>The <i>method</i> argument is optional; <i>method</i> is either "dc" or "std", with "dc" indicating divide-and-conquer and "std" indicating standard
<ul>
<li>
In version 4.000 and later, the default method is "dc"
</li>
<li>
In version 3.930, the default method is "std"
</li>
</ul>
</li>
<br>
<li>
The divide-and-conquer method provides slightly different results than the standard method, but is considerably faster for large matrices
</li>
<br>
<li>
If the decomposition fails, the output objects are reset and:
<ul>
<li><i>svd(X)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>svd(s,X)</i> and <i>svd(U,s,V,X)</i> return a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(5,5);
mat U;
vec s;
mat V;
svd(U,s,V,X);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#svd_econ">svd_econ()</a></li>
<li><a href="#eig_gen">eig_gen()</a></li>
<li><a href="#eig_sym">eig_sym()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Singular_value_decomposition">singular value decomposition in Wikipedia</a></li>
<li><a href="http://mathworld.wolfram.com/SingularValueDecomposition.html">singular value decomposition in MathWorld</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline">
<br>
<a name="svd_econ"></a>
<b>svd_econ( mat U, vec s, mat V, mat X )</b>
<br><b>svd_econ( mat U, vec s, mat V, mat X, side )</b>
<br><b>svd_econ( mat U, vec s, mat V, mat X, side, method )</b>
<br>
<br><b>svd_econ( cx_mat U, vec s, cx_mat V, cx_mat X )</b>
<br><b>svd_econ( cx_mat U, vec s, cx_mat V, cx_mat X, side )</b>
<br><b>svd_econ( cx_mat U, vec s, cx_mat V, cx_mat X, side, method )</b>
<ul>
<li>
Economical singular value decomposition of <i>X</i>
</li>
<br>
<li>
The singular values are in descending order
</li>
<br>
<li>
The <i>side</i> argument is optional; <i>side</i> is one of:
<ul>
<li>"both": compute both left and right singular vectors (default operation)</li>
<li>"left": compute only left singular vectors</li>
<li>"right": compute only right singular vectors</li>
</ul>
</li>
<br>
<li>The <i>method</i> argument is optional; <i>method</i> is either "dc" or "std", with "dc" indicating divide-and-conquer and "std" indicating standard
<ul>
<li>
In version 4.000 and later, the default method is "dc"
</li>
<li>
In version 3.930, the default method is "std"
</li>
</ul>
</li>
<br>
<li>
The divide-and-conquer method provides slightly different results than the standard method, but is considerably faster for large matrices
</li>
<br>
<li>
If the decomposition fails, the output objects are reset and a bool set to <i>false</i> is returned
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat X = randu<mat>(4,5);
mat U;
vec s;
mat V;
svd_econ(U, s, V, X);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#svd">svd()</a></li>
<li><a href="#eig_gen">eig_gen()</a></li>
<li><a href="#eig_sym">eig_sym()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Singular_value_decomposition">singular value decomposition in Wikipedia</a></li>
<li><a href="http://mathworld.wolfram.com/SingularValueDecomposition.html">singular value decomposition in MathWorld</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline">
<br>
<a name="syl"></a>
<b>X = syl( A, B, C )</b>
<br><b>syl( X, A, B, C )</b>
<ul>
<li>Solve the Sylvester equation, ie., <i>AX + XB + C = 0</i>, where <i>X</i> is unknown</li>
<br>
<li>Matrices <i>A</i>, <i>B</i> and <i>C</i> must be square sized</li>
<br>
<li>
If no solution is found, <i>X</i> is reset and:
<ul>
<li><i>syl(A,B,C)</i> throws a <i>std::runtime_error</i> exception</li>
<li><i>syl(X,A,B,C)</i> returns a bool set to <i>false</i></li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = randu<mat>(5,5);
mat C = randu<mat>(5,5);
mat X1 = syl(A, B, C);
mat X2;
syl(X2, A, B, C);
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#solve">solve()</a></li>
<li><a href="http://en.wikipedia.org/wiki/Sylvester_equation">Sylvester equation in Wikipedia</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline">
<hr class="greyline">
<br>
<br>
<font size=+1><b>Miscellaneous</b></font>
<br>
<br>
<hr class="greyline">
<br>
<a name="is_finite_standalone"></a>
<b>is_finite( X )</b>
<ul>
<li>
Returns <i>true</i> if all elements in <i>X</i> are finite
</li>
<br>
<li>
Returns <i>false</i> if at least one element in <i>X</i> is non-finite (±infinity or NaN)
</li>
<br>
<li>
<i>X</i> can be a scalar (eg. <i>double</i>), vector, matrix or cube
</li>
<br>
<li>
Examples:
<ul>
<pre>
mat A = randu<mat>(5,5);
mat B = randu<mat>(5,5);
B(1,1) = datum::nan;
cout << is_finite(A) << endl;
cout << is_finite(B) << endl;
cout << is_finite( 0.123456789 ) << endl;
cout << is_finite( datum::nan ) << endl;
cout << is_finite( datum::inf ) << endl;
</pre>
</ul>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#constants">pre-defined constants (pi, nan, inf, ...)</a></li>
<li><a href="#is_finite">.is_finite()</a> (member function of <i>Mat</i> and <i>Cube</i>)</li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="logging"></a>
<b>logging of warnings and errors</b>
<br>
<br>
<b>set_stream_err1( user_stream )</b><br>
<b>set_stream_err2( user_stream )</b><br>
<br>
<b>std::ostream& x = get_stream_err1()</b>
<br>
<b>std::ostream& x = get_stream_err2()</b>
<br>
<ul>
<li>
By default, Armadillo prints warnings and messages associated with <i>std::logic_error</i>, <i>std::runtime_error</i> and <i>std::bad_alloc</i> exceptions
to the <i>std::cout</i> stream
</li>
<br>
<li><b>set_stream_err1()</b>: change the stream for messages associated with <i>std::logic_error</i> exceptions (eg. out of bounds accesses)</li>
<br>
<li><b>set_stream_err2()</b>: change the stream for warnings and messages associated with <i>std::runtime_error</i> and <i>std::bad_alloc</i> exceptions (eg. failed decompositions, out of memory)</li>
<br>
<li><b>get_stream_err1()</b>: get a reference to the stream for messages associated with <i>std::logic_error</i> exceptions</li>
<br>
<li><b>get_stream_err2()</b>: get a reference to the stream for warnings and messages associated with <i>std::runtime_error</i> exceptions</li>
<br>
<li>
The printing of all errors and warnings can be disabled by defining <a href="#config_hpp">ARMA_DONT_PRINT_ERRORS</a> before including the armadillo header
</li>
<br>
<li>
Examples:
<ul>
<pre>
// print "hello" to the current err1 stream
get_stream_err1() << "hello" << endl;
// change the err2 stream to be a file
ofstream f("my_log.txt");
set_stream_err2(f);
// trying to invert a singular matrix
// will print a message to the err2 stream
// and throw an exception
mat X = zeros<mat>(5,5);
mat Y = inv(X);
// disable messages being printed to the err2 stream
std::ostream nullstream(0);
set_stream_err2(nullstream);
</pre>
</ul>
</li>
<br>
<li>
<b>Caveat</b>: set_stream_err1() and set_stream_err2() will not change the stream used by .print()
</li>
<br>
<li>
See also:
<ul>
<li><a href="#config_hpp">config.hpp</a></li>
<li><a href="#print">.print()</a></li>
<li><a href="http://cplusplus.com/reference/iostream/cout/">std::cout</a></li>
<li><a href="http://cplusplus.com/reference/iostream/ostream/">std::ostream</a></li>
<li><a href="http://cplusplus.com/reference/std/stdexcept/logic_error/">std::logic_error</a></li>
<li><a href="http://cplusplus.com/reference/std/stdexcept/runtime_error/">std::runtime_error</a></li>
<li><a href="http://cplusplus.com/doc/tutorial/exceptions/">tutorial on exceptions</a></li>
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="constants"></a>
<b>pre-defined constants (pi, inf, speed of light, ...)</b>
<br>
<ul>
<table style="text-align: left; width: 100%;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
datum::pi
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
π, the ratio of any circle's circumference to its diameter
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::inf
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
infinity
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::nan
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
“not a number” (NaN); <b>caveat:</b> NaN is not equal to anything, even itself
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::e
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
base of the natural logarithm
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::sqrt2
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
square root of 2
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::eps
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
the difference between 1 and the least value greater than 1 that is representable (type and machine dependant)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::log_min
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
log of minimum non-zero value (type and machine dependant)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::log_max
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
log of maximum value (type and machine dependant)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::euler
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Euler's constant, aka Euler-Mascheroni constant
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::gratio
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
golden ratio
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::m_u
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
atomic mass constant (in kg)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::N_A
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Avogadro constant
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::k
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Boltzmann constant (in joules per kelvin)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::k_evk
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Boltzmann constant (in eV/K)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::a_0
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Bohr radius (in meters)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::mu_B
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Bohr magneton
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::Z_0
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
characteristic impedance of vacuum (in ohms)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::G_0
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
conductance quantum (in siemens)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::k_e
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Coulomb's constant (in meters per farad)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::eps_0
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
electric constant (in farads per meter)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::m_e
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
electron mass (in kg)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::eV
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
electron volt (in joules)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::ec
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
elementary charge (in coulombs)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::F
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Faraday constant (in coulombs)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::alpha
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
fine-structure constant
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::alpha_inv
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
inverse fine-structure constant
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::K_J
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Josephson constant
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::mu_0
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
magnetic constant (in henries per meter)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::phi_0
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
magnetic flux quantum (in webers)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::R
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
molar gas constant (in joules per mole kelvin)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::G
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Newtonian constant of gravitation (in newton square meters per kilogram squared)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::h
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Planck constant (in joule seconds)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::h_bar
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Planck constant over 2 pi, aka reduced Planck constant (in joule seconds)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::m_p
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
proton mass (in kg)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::R_inf
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Rydberg constant (in reciprocal meters)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::c_0
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
speed of light in vacuum (in meters per second)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::sigma
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Stefan-Boltzmann constant
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::R_k
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
von Klitzing constant (in ohms)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
datum::b
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Wien wavelength displacement law constant
</td>
</tr>
</tbody>
</table>
<br>
<li>
<b>Caveat:</b>
datum::nan is not equal to anything, even itself;
if you wish to check whether a given number <i>x</i> is finite,
use <a href="#is_finite_standalone">is_finite</a>(<i>x</i>)
</li>
<br>
<li>
The constants are stored in the <i>Datum<type></i> class,
where <i>type</i> is either <i>float</i> or <i>double</i>
</li>
<br>
<li>
For convenience,
<i>Datum<double></i> has been typedefed as <i>datum</i>
while
<i>Datum<float></i> has been typedefed as <i>fdatum</i>
</li>
<br>
<li>
The physical constants were mainly taken from
<a href="http://physics.nist.gov/cuu/Constants">NIST</a>
and some from
<a href="http://www.wolframalpha.com">WolframAlpha</a>
on 2009-06-23;
constants from NIST are in turn sourced from the <a href="http://physics.nist.gov/cuu/Constants/papers.html">2006 CODATA values</a>
</li>
<br>
<li>
Examples:
<ul>
<pre>
cout << "2.0 * pi = " << 2.0 * datum::pi << endl;
cout << "speed of light = " << datum::c_0 << endl;
cout << "log_max for floats = ";
cout << fdatum::log_max << endl;
cout << "log_max for doubles = ";
cout << datum::log_max << endl;
</pre>
</ul>
</li>
<li>
See also:
<ul>
<li><a href="#is_finite_standalone">is_finite()</a></li>
<li><a href="#fill">.fill()</a></li>
<li><a href="http://en.wikipedia.org/wiki/NaN">NaN</a> in Wikipedia</li>
<li><a href="http://en.wikipedia.org/wiki/Physical_constant">physical constant</a> in Wikipedia</li>
<li><a href="http://cplusplus.com/reference/std/limits/numeric_limits/">std::numeric_limits</a></li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
<!--
<a name="log_add"></a>
<b>log_add(log_a, log_b)</b>
<ul>
<li>
Safe replacement for log(exp(log_a) + exp(log_b))
</li>
<br>
<li>
Usage:
<ul>
<li>
<i>scalar_type</i> log_c = log_add(log_a, log_b)
</li>
<li>
<i>scalar_type</i> is either <i>float</i> or <i>double</i>
</li>
<li>
log_a, log_b and log_c must have the same type
</li>
</ul>
</li>
</ul>
<br>
<hr class="greyline"><br>
-->
<a name="uword"></a>
<b>uword</b>, <b>sword</b>
<ul>
<li>
<i>uword</i> is a typedef for an unsigned integer with a minimum width of 32 bits; if <i>ARMA_64BIT_WORD</i> is enabled, the minimum width is 64 bits
</li>
<br>
<li>
<i>sword</i> is a typedef for a signed integer with a minimum width of 32 bits; if <i>ARMA_64BIT_WORD</i> is enabled, the minimum width is 64 bits
</li>
<br>
<li>
<a href="#config_hpp_arma_64bit_word"><i>ARMA_64BIT_WORD</i></a> can be enabled via editing <i>include/armadillo_bits/config.hpp</i>
</li>
<br>
<li>See also:
<ul>
<li><a href="http://cplusplus.com/doc/tutorial/variables/">C++ variable types</a></li>
<li><a href="http://www.cplusplus.com/doc/tutorial/other_data_types/">explanation of <i>typedef</i></a></li>
<li><a href="#Mat">imat & umat</a> matrix types
<li><a href="#Col">ivec & uvec</a> vector types
</ul>
</li>
<br>
</ul>
<hr class="greyline"><br>
<a name="cx_double"></a>
<b>cx_double</b>, <b>cx_float</b>
<ul>
<li>
<i>cx_double</i> is a shorthand / typedef for <i>std::complex<double></i>
</li>
<br>
<li>
<i>cx_float</i> is a shorthand / typedef for <i>std::complex<float></i>
</li>
<br>
<li>
Example:
<ul>
<pre>
cx_mat X = randu<cx_mat>(5,5);
X(1,2) = cx_double(2.0, 3.0);
</pre>
</ul>
</li>
<li>See also:
<ul>
<li><a href="http://cplusplus.com/reference/std/complex/">complex numbers in the standard C++ library</a></li>
<li><a href="http://www.cplusplus.com/doc/tutorial/other_data_types/">explanation of <i>typedef</i></a></li>
<li><a href="#Mat">cx_mat</a> matrix type
<li><a href="#Col">cx_vec</a> vector type
</ul>
</li>
<br>
</ul>
<a name="syntax"></a>
<hr class="greyline">
<br>
<b>
Examples of Matlab/Octave syntax and conceptually corresponding Armadillo syntax
</b>
<br>
<br>
<ul>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
<b>Matlab/Octave</b>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<b>Armadillo</b>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<b>Notes</b>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A(1, 1)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A(0, 0)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
indexing in Armadillo starts at 0
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A(k, k)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A(k-1, k-1)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
size(A,1)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#attributes">.n_rows</a>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
read only
</td>
</tr>
<tr>
<td style="vertical-align: top;">
size(A,2)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#attributes">.n_cols</a>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
size(Q,3)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Q<a href="#attributes">.n_slices</a>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Q is a <a href="#Cube">cube</a> (3D array)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
numel(A)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#attributes">.n_elem</a>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A(:, k)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#submat">.col</a>(k)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
this is a conceptual example only;
exact conversion from Matlab/Octave to Armadillo syntax
will require taking into account that indexing starts at 0
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A(k, :)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#submat">.row</a>(k)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A(:, p:q)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#submat">.cols</a>(p, q)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A(p:q, :)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#submat">.rows</a>(p, q)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A(p:q, r:s)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<font size=-1>
A<a href="#submat">.submat</a>(p, r, q, s)
</font>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<font size=-1>
A.submat(first_row, first_col, last_row, last_col)
</font>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<font size=-1>
or
</font>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<font size=-1>
A( <a href="#submat">span</a>(p,q), <a href="#submat">span</a>(r,s) )
</font>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<font size=-1>
A( span(first_row, last_row), span(first_col, last_col) )
</font>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
Q(:, :, k)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Q<a href="#subcube">.slice</a>(k)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Q is a <a href="#Cube">cube</a> (3D array)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
Q(:, :, t:u)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Q<a href="#subcube">.slices</a>(t, u)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
Q(p:q, r:s, t:u)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<font size=-1>
Q<a href="#subcube">.subcube</a>(p, r, t, q, s, u)
</font>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<font size=-1>
.subcube(first_row, first_col, first_slice, last_row, last_col, last_slice)
</font>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<font size=-1>
or
</font>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<font size=-1>
Q( <a href="#subcube">span</a>(p,q), <a href="#subcube">span</a>(r,s), <a href="#subcube">span</a>(t,u) )
</font>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A'
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#t_st_members">.t()</a> or <a href="#trans">trans</a>(A)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
matrix transpose / Hermitian transpose
<br>
(for complex matrices, the conjugate of each element is taken)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A.'
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#t_st_members">.st()</a> or <a href="#strans">strans</a>(A)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
simple matrix transpose
<br>
(for complex matrices, the conjugate of each element is not taken)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A = zeros(size(A))
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#zeros_member">.zeros()</a>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A = ones(size(A))
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A.<a href="#ones_member">ones()</a>
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A = zeros(k)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A = <a href="#zeros_standalone">zeros</a><mat>(k,k)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A = ones(k)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A = <a href="#ones_standalone">ones</a><mat>(k,k)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
C = complex(A,B)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
cx_mat C = <a href="#Mat">cx_mat</a>(A,B)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A .* B
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A % B
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<a href="#operators">element-wise multiplication</a>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A ./ B
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A / B
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<a href="#operators">element-wise division</a>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A \ B
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<a href="#solve">solve</a>(A,B)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
conceptually similar to <a href="#inv">inv</a>(A)*B, but more efficient
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A = A + 1;
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A++
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A = A - 1;
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A--
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A = [ 1 2; 3 4; ]
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A <font size=-1><<</font> 1 <font size=-1><<</font> 2 <font size=-1><<</font> endr<br>
<font size=-1><<</font> 3 <font size=-1><<</font> 4 <font size=-1><<</font> endr;
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<a href="#element_initialisation">element initialisation</a>,
with special element <i>endr</i> indicating <i>end of row</i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
X = [ A B ]
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
X = <a href="#join">join_horiz</a>(A,B)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
X = [ A; B ]
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
X = <a href="#join">join_vert</a>(A,B)
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
A
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
cout <font size=-1><<</font> A <font size=-1><<</font> endl;
<br>or
<br>A<a href="#print">.print</a>("A =");
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
save -ascii 'A.dat' A
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#save_load_mat">.save</a>("A.dat", raw_ascii);
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Matlab/Octave matrices saved as ascii are readable by Armadillo (and vice-versa)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
load -ascii 'A.dat'
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
A<a href="#save_load_mat">.load</a>("A.dat", raw_ascii);
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
S = { 'abc'; 'def' }
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<a href="#field">field</a><std::string> S(2);
<br>S(0) = "abc";
<br>S(1) = "def";
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
<a href="#field">fields</a> can store arbitrary objects, in a 1D or 2D layout
</td>
</tr>
</tbody>
</table>
</ul>
<br>
<a name="example_prog"></a>
<hr class="greyline">
<br>
<b>example program</b>
<br>
<br>
<ul>
<li>
If you save the program below as <i>example.cpp</i>,
under Linux you can compile it using:
<br>
g++ example.cpp -o example -O1 -larmadillo
</li>
<ul>
<pre>
#include <iostream>
#include <armadillo>
using namespace std;
using namespace arma;
int main(int argc, char** argv)
{
mat A = randu<mat>(4,5);
mat B = randu<mat>(4,5);
cout << A*B.t() << endl;
return 0;
}
</pre>
</ul>
<li>
You may also want to have a look at the example programs that come with the Armadillo archive
</li>
<br>
<li>
As Armadillo is a template library, we strongly recommended to have optimisation enabled when compiling programs
(eg. when compiling with GCC, use the -O1 or -O2 options)
</li>
</ul>
<br>
<a name="config_hpp"></a>
<hr class="greyline">
<br>
<b>config.hpp</b>
<br>
<br>
<ul>
<li>
Armadillo can be configured via editing the file <i>include/armadillo_bits/config.hpp</i>.
Specific functionality can be enabled or disabled by uncommenting or commenting out a particular <i>#define</i>, listed below.
<br>
<br>
<table style="text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">
ARMA_USE_LAPACK
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Enable the use of LAPACK, or a high-speed replacement for LAPACK (eg. Intel MKL, AMD ACML or the Accelerate framework).
Armadillo requires LAPACK for functions such as <a href="#svd">svd()</a>, <a href="#inv">inv()</a>, <a href="#eig_sym">eig_sym()</a>, <a href="#solve">solve()</a>, etc.
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_USE_BLAS
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Enable the use of BLAS, or a high-speed replacement for BLAS (eg. OpenBLAS, Intel MKL, AMD ACML or the Accelerate framework).
BLAS is used for <a href="#operators">matrix multiplication</a>.
Without BLAS, Armadillo will use a built-in matrix multiplication routine, which might be slower for large matrices.
<!--However, if you're using 64 bit operating system with 32 bit BLAS, it's better to disable the use of BLAS.-->
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_USE_ARPACK
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Enable the use of ARPACK, or a high-speed replacement for ARPACK.
Armadillo requires ARPACK for the eigen decomposition of sparse matrices, ie. <a href="#eigs_gen">eigs_gen()</a> and <a href="#eigs_sym">eigs_sym()</a>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_BLAS_CAPITALS
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Use capitalised (uppercase) BLAS and LAPACK function names (eg. DGEMM vs dgemm)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_BLAS_UNDERSCORE
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Append an underscore to BLAS and LAPACK function names (eg. dgemm_ vs dgemm). Enabled by default.
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_BLAS_LONG
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Use "long" instead of "int" when calling BLAS and LAPACK functions
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_BLAS_LONG_LONG
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Use "long long" instead of "int" when calling BLAS and LAPACK functions
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_USE_TBB_ALLOC
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Use Intel TBB <i>scalable_malloc()</i> and <i>scalable_free()</i> instead of standard <i>malloc()</i> and <i>free()</i> for managing matrix memory
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_USE_MKL_ALLOC
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Use Intel MKL <i>mkl_malloc()</i> and <i>mkl_free()</i> instead of standard <i>malloc()</i> and <i>free()</i> for managing matrix memory
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<a name="config_hpp_arma_64bit_word"></a>
ARMA_64BIT_WORD
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Use 64 bit integers. Useful if you require matrices/vectors capable of holding more than 4 billion elements.
Your machine and compiler must have support for 64 bit integers (eg. via "long" or "long long").
This can also be enabled by adding <i>#define ARMA_64BIT_WORD</i> before each instance of <i>#include <armadillo></i>.
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<a name="config_hpp_arma_use_cxx11"></a>
ARMA_USE_CXX11
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Use C++11 features, such as <a href="#element_initialisation">initialiser lists</a>;
automatically enabled when using a compiler in C++11 mode, for example, g++ -std=c++11
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_USE_HDF5
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Enable the ability to <a href="#save_load_mat">save and load</a> matrices stored in the HDF5 format;
the <i>hdf5.h</i> header file must be available on your system and you will need to link with the hdf5 library (eg. -lhdf5)
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<a name="config_hpp_arma_no_debug"></a>
ARMA_NO_DEBUG
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Disable all run-time checks, such as <a href="#element_access">bounds checking</a>.
This will result in faster code, but you first need to make sure that your code runs correctly!
We strongly recommend to have the run-time checks enabled during development,
as this greatly aids in finding mistakes in your code, and hence speeds up development.
We recommend that run-time checks be disabled <b>only</b> for the shipped version of your program
(ie. final release build).
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_EXTRA_DEBUG
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Print out the trace of internal functions used for evaluating expressions.
Not recommended for normal use.
This is mainly useful for debugging the library.
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_MAT_PREALLOC
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
The number of preallocated elements used by matrices and vectors.
Must be always enabled and set to an integer that is at least 1.
By default set to 16.
If you mainly use lots of very small vectors (eg. ≤ 4 elements), change the number to the size of your vectors.
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_DEFAULT_OSTREAM
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
The default stream used for printing <a href="#logging">error messages</a> and by <a href="#print">.print()</a>.
Must be always enabled.
By default defined to <i>std::cout</i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_PRINT_ERRORS
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Print errors and warnings encountered during program execution
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_DONT_PRINT_ERRORS
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Do not print errors or warnings. Overrides <i>ARMA_PRINT_ERRORS</i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_DONT_USE_LAPACK
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Disable use of LAPACK. Overrides <i>ARMA_USE_LAPACK</i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_DONT_USE_BLAS
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Disable use of BLAS. Overrides <i>ARMA_USE_BLAS</i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
<tr>
<td style="vertical-align: top;">
ARMA_DONT_USE_ARPACK
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
Disable use of ARPACK. Overrides <i>ARMA_USE_ARPACK</i>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
<td style="vertical-align: top;">
</td>
</tr>
</tbody>
</table>
</li>
<br>
<li>
See also:
<ul>
<li><a href="#logging">logging of warnings and errors</a></li>
<li><a href="#element_access">element access</a></li>
<li><a href="#element_initialisation">element initialisation</a></li>
<li><a href="#uword">uword/sword</a></li>
</ul>
</li>
<br>
</ul>
<br>
<!--
<a name="catching_exceptions"></a>
<hr class="greyline">
<br>
<b>how to catch std::runtime_error exceptions</b>
<br>
<br>
<ul>
<li>
If a function such as <a href="#inv">inv()</a> fails to find a solution,
an error message is printed and a <i>std::runtime_error</i> exception is thrown.
If the exception is not caught, the program typically terminates.
Below is an example of how to catch exceptions:
<ul>
<pre>
#include <iostream>
#include <armadillo>
using namespace std;
using namespace arma;
int main(int argc, char** argv)
{
// create a non-invertible matrix
mat A = zeros<mat>(5,5);
mat B;
try
{
B = inv(A);
}
catch (std::runtime_error& x)
{
cout << "caught an exception" << endl;
}
return 0;
}
</pre>
</ul>
<li>
See also:
<ul>
<li><a href="#logging">logging of warnings and errors</a></li>
<li><a href="http://cplusplus.com/doc/tutorial/exceptions/">tutorial on exceptions</a></li>
<li><a href="http://cplusplus.com/reference/std/stdexcept/runtime_error/">std::runtime_error</a></li>
</ul>
</li>
<br>
</ul>
<br>
-->
<a name="api_additions"></a>
<a name="api_changes"></a>
<hr class="greyline">
<br>
<b>API Additions, Changes and Deprecations</b>
<br>
<br>
<li>API and Version Policy
<ul>
<li>
Armadillo's version number is <i>A.B.C</i>, where <i>A</i> is a major version, <i>B</i> is a minor version, and <i>C</i> is the patch level (indicating bug fixes)
</li>
<br>
<li>
Within each major version (eg. 4.x), minor versions with an even number (ie. evenly divisible by two) are backwards compatible with earlier even minor versions.
For example, code written for version 4.000 will work with version 4.100, 4.120, 4.200, etc.
However, as each minor version may have more features (ie. API extensions) than earlier versions,
code specifically written for version 4.100 doesn't necessarily work with 4.000
</li>
<br>
<li>
Experimental versions are denoted by an odd minor version number (ie. not evenly divisible by two), such as 4.199.
Experimental versions are generally faster and/or have more functionality,
but their APIs have not been finalised yet (though the likelihood of APIs changes is quite low)
</li>
<br>
<li>
We don't like changes to existing APIs and strongly prefer not to break any user software.
However, to allow evolution, we reserve the right to alter the APIs in future <i>major</i> versions of Armadillo
while remaining backwards compatible in as many cases as possible
(eg. version 5.x may have slightly different APIs than 4.x).
In a rare instance the user API may need to be tweaked if a bug fix absolutely requires it
</li>
<br>
<li>
This policy is applicable to the APIs described in this documentation; it is not applicable to internal functions
(ie. the underlying internal implementation details may change across consecutive minor versions)
</li>
</ul>
</li>
<!--
<br>
<li>
<a name="deprecated"></a>
List of deprecated functionality; this functionality will be <b>removed</b> in version 5.0:
<ul>
<li>
...
</li>
</ul>
</li>
-->
<br>
<br>
<li>
List of additions and changes for each version:
<br>
<br>
<ul>
<a name="added_in_4200"></a>
<li>Added in 4.200:
<ul>
<li>faster transpose of sparse matrices</li>
<li>more efficient handling of aliasing during matrix multiplication</li>
<li>faster <a href="#inv">inverse</a> of matrices marked as diagonal</li>
</ul>
</li>
<br>
<a name="added_in_4100"></a>
<li>Added in 4.100:
<ul>
<li>added <a href="#normalise">normalise()</a> for normalising vectors to unit <i>p</i>-norm</li>
<li>extended the <a href="#field">field class</a> to handle 3D layout</li>
<li>extended <a href="#eigs_sym">eigs_sym()</a> and <a href="#eigs_gen">eigs_gen()</a> to obtain eigenvalues of various forms (eg. largest or smallest magnitude)</li>
<li>automatic SIMD vectorisation of elementary expressions (eg. matrix addition) when using Clang 3.4+ with -O3 optimisation</li>
<li>faster handling of sparse submatrix views</li>
</ul>
</li>
<br>
<a name="added_in_4000"></a>
<li>Added in 4.000:
<ul>
<li>eigen decompositions of sparse matrices: <a href="#eigs_sym">eigs_sym()</a> and <a href="#eigs_gen">eigs_gen()</a></li>
<li>eigen decomposition for pair of matrices: <a href="#eig_pair">eig_pair()</a></li>
<li>simpler forms of <a href="#eig_gen">eig_gen()</a></li>
<li>condition number of matrices: <a href="#cond">cond()</a></li>
<li>expanded <a href="#find">find()</a> to handle cubes</li>
<li>expanded <a href="#subcube">subcube views</a> to access elements specified in a vector</li>
<li>template argument for <a href="#running_stat_vec">running_stat_vec</a> expanded to accept vector types</li>
<li>more robust fast <a href="#inv">inverse</a> of 4x4 matrices</li>
</ul>
</li>
<br>
<li>Changed in 4.000:
<ul>
<li>Faster divide-and-conquer decompositions are now used by default for
<a href="#eig_sym">eig_sym()</a>,
<a href="#pinv">pinv()</a>,
<a href="#princomp">princomp()</a>,
<a href="#rank">rank()</a>,
<a href="#svd">svd()</a>,
<a href="#svd_econ">svd_econ()</a>
</li>
<li>
The form <i>inv(sympd(X))</i> no longer assumes that <i>X</i> is positive definite; use <a href="#inv_sympd">inv_sympd()</a> instead
</li>
</ul>
</li>
<br>
<a name="added_in_3930"></a>
<li>Added in 3.930:
<ul>
<li><i>size()</i> based specifications of <a href="#submat">submatrix view</a> sizes</li>
<li>element-wise variants of <a href="#min_and_max">min()</a> and <a href="#min_and_max">max()</a></li>
<li>divide-and-conquer variant of <a href="#svd_econ">svd_econ()</a></li>
<li>divide-and-conquer variant of <a href="#pinv">pinv()</a></li>
<li><a href="#randi">randi()</a> for generating matrices with random integer values</li>
<li><a href="#inplace_trans">inplace_trans()</a> for memory efficient in-place transposes</li>
<li>more intuitive specification of sort direction in <a href="#sort">sort()</a> and <a href="#sort_index">sort_index()</a></li>
<li>more intuitive specification of method in <a href="#det">det()</a>, <a href="#i_member">.i()</a>, <a href="#inv">inv()</a> and <a href="#solve">solve()</a></li>
<li>more precise timer for the <a href="#wall_clock">wall_clock</a> class when using C++11</li>
</ul>
</li>
<br>
<a name="added_in_3920"></a>
<li>Added in 3.920:
<ul>
<li>faster <a href="#zeros_member">.zeros()</a></li>
<li>faster <a href="#misc_fns">round()</a>, <a href="#misc_fns">exp2()</a> and <a href="#misc_fns">log2()</a> when using C++11</li>
<li>signum function: <a href="#misc_fns">sign()</a></li>
<li>move constructors when using C++11</li>
<li>2D fast Fourier transform: <a href="#fft2">fft2()</a></li>
<li><a href="#subcube">.tube()</a> for easier extraction of vectors and subcubes from cubes</li>
<li>specification of a fill type during construction of <a href="#Mat">Mat</a>, <a href="#Col">Col</a>, <a href="#Row">Row</a> and <a href="#Cube">Cube</a> classes,
eg. <i>mat X(4, 5, fill::zeros)</i></li>
</ul>
</li>
<br>
<a name="added_in_3910"></a>
<li>Added in 3.910:
<ul>
<li>faster multiplication of a matrix with a transpose of itself, ie. <i>X*X.t()</i> and <i>X.t()*X</i></li>
<li><a href="#vectorise">vectorise()</a> for reshaping matrices into vectors</li>
<li><a href="#all">all()</a> and <a href="#any">any()</a> for indicating presence of elements satisfying a relational condition</li>
</ul>
</li>
<br>
<a name="added_in_3900"></a>
<li>Added in 3.900:
<ul>
<li>automatic SSE2 vectorisation of elementary expressions (eg. matrix addition) when using GCC 4.7+ with -O3 optimisation</li>
<li>faster <a href="#stats_fns">median()</a></li>
<li>faster handling of compound expressions with transposes of <a href="#submat">submatrix</a> rows</li>
<li>faster handling of compound expressions with transposes of complex vectors</li>
<li>support for <a href="#save_load_mat">saving & loading</a> of <a href="#Cube">cubes</a> in HDF5 format</li>
</ul>
</li>
<br>
<a name="added_in_3820"></a>
<li>Added in 3.820:
<ul>
<li>faster <a href="#as_scalar">as_scalar()</a> for compound expressions</li>
<li>faster transpose of small vectors</li>
<li>faster matrix-vector product for small vectors</li>
<li>faster multiplication of small <a href="#adv_constructors_mat_fixed">fixed size matrices</a></li>
</ul>
</li>
<br>
<a name="added_in_3810"></a>
<li>Added in 3.810:
<ul>
<li>fast Fourier transform: <a href="#fft">fft()</a></li>
<li>handling of <a href="#imbue">.imbue()</a> and <a href="#transform">.transform()</a> by submatrices and subcubes</li>
<li><a href="#batch_constructors_sp_mat">batch insertion constructors</a> for sparse matrices
</ul>
</li>
<br>
<a name="added_in_3800"></a>
<li>Added in 3.800:
<ul>
<li><a href="#imbue">.imbue()</a> for filling a matrix/cube with values provided by a functor or lambda expression</li>
<li><a href="#swap">.swap()</a> for swapping contents with another matrix</li>
<li><a href="#transform">.transform()</a> for transforming a matrix/cube using a functor or lambda expression</li>
<li><a href="#misc_fns">round()</a> for rounding matrix elements towards nearest integer</li>
<li>faster <a href="#find">find()</a></li>
</ul>
</li>
<br>
<li>Changed in 3.800:
<ul>
<li>Armadillo is now licensed using the <a href="http://www.mozilla.org/MPL/2.0/">Mozilla Public License 2.0</a>;
<br>
see also the associated <a href="http://www.mozilla.org/MPL/2.0/FAQ.html">frequently asked questions</a> about the license</li>
</ul>
<br>
</li>
<a name="added_in_36"></a>
<li>Added in 3.6:
<ul>
<li>faster handling of compound expressions with submatrices and subcubes</li>
<li>faster <a href="#trace">trace()</a></li>
<li>support for loading matrices as text files with <i>NaN</i> and <i>Inf</i> elements</li>
<li><a href="#sort_index">stable_sort_index()</a>, which preserves the relative order of elements with equivalent values</li>
<li>handling of <a href="#SpMat">sparse matrices</a> by <a href="#stats_fns">mean()</a>, <a href="#stats_fns">var()</a>, <a href="#norm">norm()</a>, <a href="#abs">abs()</a>, <a href="#misc_fns">square()</a>, <a href="#misc_fns">sqrt()</a></li>
<li>saving and loading of sparse matrices in <i>arma_binary</i> format</li>
</ul>
<br>
</li>
<a name="added_in_34"></a>
<li>Added in 3.4:
<ul>
<li>economical QR decomposition: <a href="#qr_econ">qr_econ()</a></li>
<li><a href="#each_colrow">.each_col() & .each_row()</a> for vector operations repeated on each column or row of a matrix</li>
<li>preliminary support for <a href="#SpMat">sparse matrices</a></li>
<li>ability to <a href="#save_load_mat">save and load</a> matrices in HDF5 format</li>
<li>faster <a href="#svd">singular value decomposition</a> via optional use of divide-and-conquer algorithm</li>
<li>faster <a href="#randu_randn_member">.randn()</a></li>
<li>faster <a href="#dot">dot() and cdot()</a> for complex numbers</li>
</ul>
<br>
</li>
<a name="added_in_32"></a>
<li>Added in 3.2:
<ul>
<li><a href="#unique">unique()</a>, for finding unique elements of a matrix</li>
<li><a href="#eval_member">.eval()</a>, for forcing the evaluation of delayed expressions</li>
<li>faster <a href="#eig_sym">eigen decomposition</a> via optional use of divide-and-conquer algorithm</li>
<li>faster <a href="#t_st_members">transpose</a> of vectors and compound expressions</li>
<li>faster handling of <a href="#diag">diagonal views</a></li>
<li>faster handling of tiny <a href="#adv_constructors_col_fixed">fixed size</a> vectors (≤ 4 elements)</li>
</ul>
<br>
</li>
<a name="added_in_30"></a>
<li>Added in 3.0:
<ul>
<li>shorthand for inverse: <a href="#i_member">.i()</a></li>
<li><a href="#constants">datum</a> class</li>
<li><a href="#hist">hist()</a> and <a href="#histc">histc()</a></li>
<li>non-contiguous <a href="#submat">submatrix views</a></li>
<li>faster handling of <a href="#submat">submatrix views</a> with a single row or column</li>
<li>faster element access in <a href="#adv_constructors_mat_fixed">fixed size matrices</a></li>
<li>faster <a href="#repmat">repmat()</a></li>
</ul>
<br>
</li>
<li>Changed in 3.0:
<ul>
<li>expressions <i>X=<a href="#inv">inv</a>(A)*B</i> and <i>X=A<a href="#i_member">.i()</a>*B</i> are automatically converted to <i>X=<a href="#solve">solve</a>(A,B)</i>
<li>better detection of vector expressions by <a href="#sum">sum()</a>, <a href="#cumsum">cumsum()</a>, <a href="#prod">prod()</a>, <a href="#min_and_max">min()</a>, <a href="#min_and_max">max()</a>, <a href="#stats_fns">mean()</a>, <a href="#stats_fns">median()</a>, <a href="#stats_fns">stddev()</a>, <a href="#stats_fns">var()</a>
<li>faster generation of random numbers
(eg. <a href="#randu_randn_standalone">randu()</a> and <a href="#randu_randn_standalone">randn()</a>),
via an algorithm that produces slightly different numbers than in 2.x
</li>
<li>
support for tying writable auxiliary (external) memory to fixed size matrices has been removed;
instead, you can use standard matrices with <a href="#adv_constructors_mat">writable auxiliary memory</a>,
or initialise fixed size matrices by <a href="#adv_constructors_mat">copying the memory</a>.
Using auxiliary memory with standard matrices is unaffected.
</li>
<li>
<i>.print_trans()</i> and <i>.raw_print_trans()</i> have been removed;
instead, you can chain <i><a href="#t_st_members">.t()</a></i> and <i><a href="#print">.print()</a></i> to achieve a similar result: <i>X.t().print()</i>
</li>
</ul>
<br>
</li>
<a name="added_in_24"></a>
<li>Added in 2.4:
<ul>
<li>shorter forms of transposes: <a href="#t_st_members">.t()</a> and <a href="#t_st_members">.st()</a></li>
<li><a href="#resize_member">.resize()</a> and <a href="#resize">resize()</a></li>
<li>optional use of 64 bit indices (allowing matrices to have more than 4 billion elements),
<br>enabled via ARMA_64BIT_WORD in <i>include/armadillo_bits/config.hpp</i></li>
<li>experimental support for C++11 initialiser lists,
<br>enabled via ARMA_USE_CXX11 in <i>include/armadillo_bits/config.hpp</i></li>
</ul>
<br>
<li>Changed in 2.4:
<ul>
<li>refactored code to eliminate warnings when using the Clang C++ compiler</li>
<li><a href="#Mat">umat</a>, <a href="#Col">uvec</a>, <a href="#min_and_max_member">.min()</a> and <a href="#min_and_max_member">.max()</a>
have been changed to use the <a href="#uword"><i>uword</i></a> type instead of the <i>u32</i> type;
by default the <i>uword</i> and <i>u32</i> types are equivalent (ie. unsigned integer type with a minimum width 32 bits);
however, when the use of 64 bit indices is enabled via ARMA_64BIT_WORD in <i>include/armadillo_bits/config.hpp</i>,
the <i>uword</i> type then has a minimum width of 64 bits
</ul>
</li>
<br>
<li>Added in 2.2:
<ul>
<li><a href="#svd_econ">svd_econ()</a></li>
<li><a href="#toeplitz">circ_toeplitz()</a></li>
<li><a href="#is_vec">.is_colvec()</a> and <a href="#is_vec">.is_rowvec()</a></li>
</ul>
<br>
<li>Added in 2.0:
<ul>
<li><a href="#det">det()</a>, <a href="#inv">inv()</a> and <a href="#solve">solve()</a> can be forced to use more precise algorithms for tiny matrices (≤ 4x4)</li>
<li><a href="#syl">syl()</a>, for solving Sylvester's equation</li>
<li><a href="#strans">strans()</a>, for transposing a complex matrix without taking the complex conjugate</li>
<li><a href="#symmat">symmatu()</a> and <a href="#symmat">symmatl()</a></li>
<li>submatrices of <a href="#submat">submatrices</a></li>
<li>faster <a href="#inv">inverse</a> of symmetric positive definite matrices</li>
<li>faster element access for <a href="#adv_constructors_mat_fixed">fixed size</a> matrices</li>
<li>faster multiplication of tiny matrices (eg. 4x4)</li>
<li>faster compound expressions containing <a href="#submat">submatrices</a></li>
<li>handling of arbitrarily sized empty matrices (eg. 5x0)</li>
<li>.count() member function in <a href="#running_stat">running_stat</a> and <a href="#running_stat_vec">running_stat_vec</a></li>
<li><a href="#save_load_mat">loading & saving</a> of matrices as CSV text files</li>
</ul>
<br>
<li>Changed in 2.0:
<ul>
<li><a href="#trans">trans()</a> now takes the complex conjugate when transposing a complex matrix</li>
<li>Forms of
<a href="#chol">chol()</a>, <a href="#eig_sym">eig_sym()</a>, <a href="#eig_gen">eig_gen()</a>,
<a href="#inv">inv()</a>, <a href="#lu">lu()</a>, <a href="#pinv">pinv()</a>, <a href="#princomp">princomp()</a>,
<a href="#qr">qr()</a>, <a href="#solve">solve()</a>, <a href="#svd">svd()</a>, <a href="#syl">syl()</a>
that do not return a bool indicating success now throw <i>std::runtime_error</i> exceptions when failures are detected</li>
<li>princomp_cov() has been removed; <a href="#eig_sym">eig_sym()</a> in conjunction with <a href="#cov">cov()</a> can be used instead</li>
<li><a href="#is_vec">.is_vec()</a> now outputs <i>true</i> for empty vectors (eg. 0x1)</li>
<li>set_log_stream() & get_log_stream() have been replaced by <a href="#logging">set_stream_err1()</a> & <a href="#logging">get_stream_err1()</a></li>
</ul>
<br>
<li>Added in 1.2:
<ul>
<li><a href="#min_and_max_member">.min() & .max()</a> member functions of Mat and Cube</li>
<li><a href="#misc_fns">floor()</a> and <a href="#misc_fns">ceil()</a></li>
<li>representation of “not a number”: math::nan()</li>
<li>representation of infinity: math::inf()</li>
<li>standalone <a href="#is_finite_standalone">is_finite()</a></li>
<li><a href="#in_range">.in_range()</a> can use <b>span()</b> arguments</li>
<li><a href="#adv_constructors_mat">fixed size</a> matrices and vectors can use auxiliary (external) memory</li>
<li><a href="#submat">submatrices</a> and <a href="#subfield">subfields</a> can be accessed via <i><b>X(</b> <b>span(</b>a,b<b>)</b>, <b>span(</b>c,d<b>)</b> <b>)</b></i></li>
<li><a href="#subcube">subcubes</a> can be accessed via <i><b>X(</b> <b>span(</b>a,b<b>)</b>, <b>span(</b>c,d<b>)</b>, <b>span(</b>e,f<b>)</b> <b>)</b></i></li>
<li>the two argument version of <i><b>span</b></i> can be replaced by
<i><b>span::all</b></i> or <i><b>span()</b></i>, to indicate an entire range
</li>
<li>for cubes, the two argument version of <i><b>span</b></i> can be replaced by
a single argument version, <i><b>span(</b>a<b>)</b></i>, to indicate a single column, row or slice
</li>
<li>arbitrary "flat" subcubes can be interpreted as matrices; for example:
<ul>
<pre>
cube Q = randu<cube>(5,3,4);
mat A = Q( span(1), span(1,2), span::all );
// A has a size of 2x4
vec v = ones<vec>(4);
Q( span(1), span(1), span::all ) = v;
</pre>
</ul>
</li>
<li>interpretation of matrices as triangular through <a href="#trimat">trimatu() / trimatl()</a></li>
<li>explicit handling of triangular matrices by <a href="#solve">solve()</a> and <a href="#inv">inv()</a></li>
<li>extended syntax for <a href="#submat">submatrices</a>, including access to elements whose indices are specified in a vector</li>
<li>ability to change the stream used for <a href="#logging">logging</a> of errors and warnings</li>
<li>ability to <a href="#save_load_mat">save/load matrices</a> in raw binary format</li>
<li>cumulative sum function: <a href="#cumsum">cumsum()</a></li>
</ul>
</li>
<br>
<li>
Changed in 1.0 (compared to earlier 0.x development versions):
<ul>
<li>
the 3 argument version of <a href="#lu">lu()</a>,
eg. lu(L,U,X),
provides L and U which should be the same as produced by Octave 3.2
(this was not the case in versions prior to 0.9.90)
</li>
<br>
<li>
rand() has been replaced by <a href="#randu_randn_standalone">randu()</a>;
this has been done to avoid confusion with <a href="http://cplusplus.com/reference/clibrary/cstdlib/rand/">std::rand()</a>,
which generates random numbers in a different interval
</li>
<br>
<li>
In versions earlier than 0.9.0,
some multiplication operations directly converted result matrices with a size of 1x1 into scalars.
This is no longer the case.
If you know the result of an expression will be a 1x1 matrix and wish to treat it as a pure scalar,
use the <a href="#as_scalar">as_scalar()</a> wrapping function
</li>
<br>
<li>
Almost all functions have been placed in the delayed operations framework (for speed purposes).
This may affect code which assumed that the output of some functions was a pure matrix.
The solution is easy, as explained below.
<br>
<br>
In general, Armadillo queues operations before executing them.
As such, the direct output of an operation or function cannot be assumed to be a directly accessible matrix.
The queued operations are executed when the output needs to be stored in a matrix,
eg. <i>mat B = trans(A)</i> or <i>mat B(trans(A))</i>.
If you need to force the execution of the delayed operations,
place the operation or function inside the corresponding Mat constructor.
For example, if your code assumed that the output of some functions was a pure matrix,
eg. <i>chol(m).diag()</i>, change the code to <i>mat(chol(m)).diag()</i>.
Similarly, if you need to pass the result of an operation such as <i>A+B</i> to one of your own functions,
use <i>my_function( mat(A+B) )</i>.
</li>
</ul>
</li>
</ul>
</li>
<br>
<br>
<br>
<!-- END CONTENT -->
<hr>
<br>
<br>
</td>
</tr>
</tbody>
</table>
</center>
</body>
</html>
|