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
|
/*
Copyright (c) 2003-2006 Niels Kokholm and Peter Sestoft
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
using System;
using System.Diagnostics;
using SCG = System.Collections.Generic;
namespace C5
{
/// <summary>
/// A read-only wrapper class for a generic enumerator
/// </summary>
public class GuardedEnumerator<T> : SCG.IEnumerator<T>
{
#region Fields
SCG.IEnumerator<T> enumerator;
#endregion
#region Constructor
/// <summary>
/// Create a wrapper around a generic enumerator
/// </summary>
/// <param name="enumerator">The enumerator to wrap</param>
public GuardedEnumerator(SCG.IEnumerator<T> enumerator)
{ this.enumerator = enumerator; }
#endregion
#region IEnumerator<T> Members
/// <summary>
/// Move wrapped enumerator to next item, or the first item if
/// this is the first call to MoveNext.
/// </summary>
/// <returns>True if enumerator is valid now</returns>
public bool MoveNext() { return enumerator.MoveNext(); }
/// <summary>
/// Undefined if enumerator is not valid (MoveNext hash been called returning true)
/// </summary>
/// <value>The current item of the wrapped enumerator.</value>
public T Current { get { return enumerator.Current; } }
#endregion
#region IDisposable Members
//TODO: consider possible danger of calling through to Dispose.
/// <summary>
/// Dispose wrapped enumerator.
/// </summary>
public void Dispose() { enumerator.Dispose(); }
#endregion
#region IEnumerator Members
object System.Collections.IEnumerator.Current
{
get { return enumerator.Current; }
}
void System.Collections.IEnumerator.Reset()
{
enumerator.Reset();
}
#endregion
}
/// <summary>
/// A read-only wrapper class for a generic enumerable
///
/// <i>This is mainly interesting as a base of other guard classes</i>
/// </summary>
public class GuardedEnumerable<T> : SCG.IEnumerable<T>
{
#region Fields
SCG.IEnumerable<T> enumerable;
#endregion
#region Constructor
/// <summary>
/// Wrap an enumerable in a read-only wrapper
/// </summary>
/// <param name="enumerable">The enumerable to wrap</param>
public GuardedEnumerable(SCG.IEnumerable<T> enumerable)
{ this.enumerable = enumerable; }
#endregion
#region SCG.IEnumerable<T> Members
/// <summary>
/// Get an enumerator from the wrapped enumerable
/// </summary>
/// <returns>The enumerator (itself wrapped)</returns>
public SCG.IEnumerator<T> GetEnumerator()
{ return new GuardedEnumerator<T>(enumerable.GetEnumerator()); }
#endregion
#region IEnumerable Members
System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
{
return GetEnumerator();
}
#endregion
}
/// <summary>
/// A read-only wrapper for a generic directed enumerable
///
/// <i>This is mainly interesting as a base of other guard classes</i>
/// </summary>
public class GuardedDirectedEnumerable<T> : GuardedEnumerable<T>, IDirectedEnumerable<T>
{
#region Fields
IDirectedEnumerable<T> directedenumerable;
#endregion
#region Constructor
/// <summary>
/// Wrap a directed enumerable in a read-only wrapper
/// </summary>
/// <param name="directedenumerable">the collection to wrap</param>
public GuardedDirectedEnumerable(IDirectedEnumerable<T> directedenumerable)
: base(directedenumerable)
{ this.directedenumerable = directedenumerable; }
#endregion
#region IDirectedEnumerable<T> Members
/// <summary>
/// Get a enumerable that enumerates the wrapped collection in the opposite direction
/// </summary>
/// <returns>The mirrored enumerable</returns>
public IDirectedEnumerable<T> Backwards()
{ return new GuardedDirectedEnumerable<T>(directedenumerable.Backwards()); }
/// <summary>
/// <code>Forwards</code> if same, else <code>Backwards</code>
/// </summary>
/// <value>The enumeration direction relative to the original collection.</value>
public EnumerationDirection Direction
{ get { return directedenumerable.Direction; } }
#endregion
}
/// <summary>
/// A read-only wrapper for an ICollectionValue<T>
///
/// <i>This is mainly interesting as a base of other guard classes</i>
/// </summary>
public class GuardedCollectionValue<T> : GuardedEnumerable<T>, ICollectionValue<T>
{
#region Events
/// <summary>
/// The ListenableEvents value of the wrapped collection
/// </summary>
/// <value></value>
public virtual EventTypeEnum ListenableEvents { get { return collectionvalue.ListenableEvents; } }
/// <summary>
/// The ActiveEvents value of the wrapped collection
/// </summary>
/// <value></value>
public virtual EventTypeEnum ActiveEvents { get { return collectionvalue.ActiveEvents; } }
ProxyEventBlock<T> eventBlock;
/// <summary>
/// The change event. Will be raised for every change operation on the collection.
/// </summary>
public event CollectionChangedHandler<T> CollectionChanged
{
add { (eventBlock ?? (eventBlock = new ProxyEventBlock<T>(this, collectionvalue))).CollectionChanged += value; }
remove { if (eventBlock != null) eventBlock.CollectionChanged -= value; }
}
/// <summary>
/// The change event. Will be raised for every change operation on the collection.
/// </summary>
public event CollectionClearedHandler<T> CollectionCleared
{
add { (eventBlock ?? (eventBlock = new ProxyEventBlock<T>(this, collectionvalue))).CollectionCleared += value; }
remove { if (eventBlock != null) eventBlock.CollectionCleared -= value; }
}
/// <summary>
/// The item added event. Will be raised for every individual addition to the collection.
/// </summary>
public event ItemsAddedHandler<T> ItemsAdded
{
add { (eventBlock ?? (eventBlock = new ProxyEventBlock<T>(this, collectionvalue))).ItemsAdded += value; }
remove { if (eventBlock != null) eventBlock.ItemsAdded -= value; }
}
/// <summary>
/// The item added event. Will be raised for every individual addition to the collection.
/// </summary>
public event ItemInsertedHandler<T> ItemInserted
{
add { (eventBlock ?? (eventBlock = new ProxyEventBlock<T>(this, collectionvalue))).ItemInserted += value; }
remove { if (eventBlock != null) eventBlock.ItemInserted -= value; }
}
/// <summary>
/// The item removed event. Will be raised for every individual removal from the collection.
/// </summary>
public event ItemsRemovedHandler<T> ItemsRemoved
{
add { (eventBlock ?? (eventBlock = new ProxyEventBlock<T>(this, collectionvalue))).ItemsRemoved += value; }
remove { if (eventBlock != null) eventBlock.ItemsRemoved -= value; }
}
/// <summary>
/// The item removed event. Will be raised for every individual removal from the collection.
/// </summary>
public event ItemRemovedAtHandler<T> ItemRemovedAt
{
add { (eventBlock ?? (eventBlock = new ProxyEventBlock<T>(this, collectionvalue))).ItemRemovedAt += value; }
remove { if (eventBlock != null) eventBlock.ItemRemovedAt -= value; }
}
#endregion
#region Fields
ICollectionValue<T> collectionvalue;
#endregion
#region Constructor
/// <summary>
/// Wrap a ICollectionValue<T> in a read-only wrapper
/// </summary>
/// <param name="collectionvalue">the collection to wrap</param>
public GuardedCollectionValue(ICollectionValue<T> collectionvalue)
: base(collectionvalue)
{ this.collectionvalue = collectionvalue; }
#endregion
#region ICollection<T> Members
/// <summary>
/// Get the size of the wrapped collection
/// </summary>
/// <value>The size</value>
public virtual bool IsEmpty { get { return collectionvalue.IsEmpty; } }
/// <summary>
/// Get the size of the wrapped collection
/// </summary>
/// <value>The size</value>
public virtual int Count { get { return collectionvalue.Count; } }
/// <summary>
/// The value is symbolic indicating the type of asymptotic complexity
/// in terms of the size of this collection (worst-case or amortized as
/// relevant).
/// </summary>
/// <value>A characterization of the speed of the
/// <code>Count</code> property in this collection.</value>
public virtual Speed CountSpeed { get { return collectionvalue.CountSpeed; } }
/// <summary>
/// Copy the items of the wrapped collection to an array
/// </summary>
/// <param name="a">The array</param>
/// <param name="i">Starting offset</param>
public virtual void CopyTo(T[] a, int i) { collectionvalue.CopyTo(a, i); }
/// <summary>
/// Create an array from the items of the wrapped collection
/// </summary>
/// <returns>The array</returns>
public virtual T[] ToArray() { return collectionvalue.ToArray(); }
/// <summary>
/// Apply a delegate to all items of the wrapped enumerable.
/// </summary>
/// <param name="a">The delegate to apply</param>
//TODO: change this to throw an exception?
public virtual void Apply(Act<T> a) { collectionvalue.Apply(a); }
/// <summary>
/// Check if there exists an item that satisfies a
/// specific predicate in the wrapped enumerable.
/// </summary>
/// <param name="filter">A filter delegate
/// (<see cref="T:C5.Filter`1"/>) defining the predicate</param>
/// <returns>True is such an item exists</returns>
public virtual bool Exists(Fun<T, bool> filter) { return collectionvalue.Exists(filter); }
/// <summary>
///
/// </summary>
/// <param name="filter"></param>
/// <param name="item"></param>
/// <returns></returns>
public virtual bool Find(Fun<T, bool> filter, out T item) { return collectionvalue.Find(filter, out item); }
/// <summary>
/// Check if all items in the wrapped enumerable satisfies a specific predicate.
/// </summary>
/// <param name="filter">A filter delegate
/// (<see cref="T:C5.Filter`1"/>) defining the predicate</param>
/// <returns>True if all items satisfies the predicate</returns>
public virtual bool All(Fun<T, bool> filter) { return collectionvalue.All(filter); }
/// <summary>
/// Create an enumerable, enumerating the items of this collection that satisfies
/// a certain condition.
/// </summary>
/// <param name="filter">The T->bool filter delegate defining the condition</param>
/// <returns>The filtered enumerable</returns>
public virtual SCG.IEnumerable<T> Filter(Fun<T, bool> filter) { return collectionvalue.Filter(filter); }
/// <summary>
/// Choose some item of this collection.
/// </summary>
/// <exception cref="NoSuchItemException">if collection is empty.</exception>
/// <returns></returns>
public virtual T Choose() { return collectionvalue.Choose(); }
#endregion
#region IShowable Members
/// <summary>
///
/// </summary>
/// <param name="stringbuilder"></param>
/// <param name="formatProvider"></param>
/// <param name="rest"></param>
/// <returns></returns>
public bool Show(System.Text.StringBuilder stringbuilder, ref int rest, IFormatProvider formatProvider)
{
return collectionvalue.Show(stringbuilder, ref rest, formatProvider);
}
#endregion
#region IFormattable Members
/// <summary>
///
/// </summary>
/// <param name="format"></param>
/// <param name="formatProvider"></param>
/// <returns></returns>
public string ToString(string format, IFormatProvider formatProvider)
{
return collectionvalue.ToString(format, formatProvider);
}
#endregion
}
/// <summary>
/// A read-only wrapper for a directed collection
///
/// <i>This is mainly interesting as a base of other guard classes</i>
/// </summary>
public class GuardedDirectedCollectionValue<T> : GuardedCollectionValue<T>, IDirectedCollectionValue<T>
{
#region Fields
IDirectedCollectionValue<T> directedcollection;
#endregion
#region Constructor
/// <summary>
/// Wrap a directed collection in a read-only wrapper
/// </summary>
/// <param name="directedcollection">the collection to wrap</param>
public GuardedDirectedCollectionValue(IDirectedCollectionValue<T> directedcollection)
:
base(directedcollection)
{ this.directedcollection = directedcollection; }
#endregion
#region IDirectedCollection<T> Members
/// <summary>
/// Get a collection that enumerates the wrapped collection in the opposite direction
/// </summary>
/// <returns>The mirrored collection</returns>
public virtual IDirectedCollectionValue<T> Backwards()
{ return new GuardedDirectedCollectionValue<T>(directedcollection.Backwards()); }
/// <summary>
///
/// </summary>
/// <param name="predicate"></param>
/// <param name="item"></param>
/// <returns></returns>
public virtual bool FindLast(Fun<T, bool> predicate, out T item) { return directedcollection.FindLast(predicate, out item); }
#endregion
#region IDirectedEnumerable<T> Members
IDirectedEnumerable<T> IDirectedEnumerable<T>.Backwards()
{ return Backwards(); }
/// <summary>
/// <code>Forwards</code> if same, else <code>Backwards</code>
/// </summary>
/// <value>The enumeration direction relative to the original collection.</value>
public EnumerationDirection Direction
{ get { return directedcollection.Direction; } }
#endregion
}
/// <summary>
/// A read-only wrapper for an <see cref="T:C5.ICollection`1"/>,
/// <para>
/// <i>Suitable for wrapping hash tables, <see cref="T:C5.HashSet`1"/>
/// and <see cref="T:C5.HashBag`1"/> </i></para>
/// </summary>
public class GuardedCollection<T> : GuardedCollectionValue<T>, ICollection<T>
{
#region Fields
ICollection<T> collection;
#endregion
#region Constructor
/// <summary>
/// Wrap an ICollection<T> in a read-only wrapper
/// </summary>
/// <param name="collection">the collection to wrap</param>
public GuardedCollection(ICollection<T> collection)
: base(collection)
{
this.collection = collection;
}
#endregion
#region ICollection<T> Members
/// <summary>
/// (This is a read-only wrapper)
/// </summary>
/// <value>True</value>
public virtual bool IsReadOnly { get { return true; } }
/// <summary> </summary>
/// <value>Speed of wrapped collection</value>
public virtual Speed ContainsSpeed { get { return collection.ContainsSpeed; } }
/// <summary>
///
/// </summary>
/// <returns></returns>
public virtual int GetUnsequencedHashCode()
{ return collection.GetUnsequencedHashCode(); }
/// <summary>
///
/// </summary>
/// <param name="that"></param>
/// <returns></returns>
public virtual bool UnsequencedEquals(ICollection<T> that)
{ return collection.UnsequencedEquals(that); }
/// <summary>
/// Check if an item is in the wrapped collection
/// </summary>
/// <param name="item">The item</param>
/// <returns>True if found</returns>
public virtual bool Contains(T item) { return collection.Contains(item); }
/// <summary>
/// Count the number of times an item appears in the wrapped collection
/// </summary>
/// <param name="item">The item</param>
/// <returns>The number of copies</returns>
public virtual int ContainsCount(T item) { return collection.ContainsCount(item); }
/// <summary>
///
/// </summary>
/// <returns></returns>
public virtual ICollectionValue<T> UniqueItems() { return new GuardedCollectionValue<T>(collection.UniqueItems()); }
/// <summary>
///
/// </summary>
/// <returns></returns>
public virtual ICollectionValue<KeyValuePair<T, int>> ItemMultiplicities() { return new GuardedCollectionValue<KeyValuePair<T, int>>(collection.ItemMultiplicities()); }
/// <summary>
/// Check if all items in the argument is in the wrapped collection
/// </summary>
/// <param name="items">The items</param>
/// <typeparam name="U"></typeparam>
/// <returns>True if so</returns>
public virtual bool ContainsAll<U>(SCG.IEnumerable<U> items) where U : T { return collection.ContainsAll(items); }
/// <summary>
/// Search for an item in the wrapped collection
/// </summary>
/// <param name="item">On entry the item to look for, on exit the equivalent item found (if any)</param>
/// <returns></returns>
public virtual bool Find(ref T item) { return collection.Find(ref item); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
/// <returns></returns>
public virtual bool FindOrAdd(ref T item)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
/// <returns></returns>
public virtual bool Update(T item)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
/// <param name="olditem"></param>
/// <returns></returns>
public virtual bool Update(T item, out T olditem)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
/// <returns></returns>
public virtual bool UpdateOrAdd(T item)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
/// <param name="olditem"></param>
/// <returns></returns>
public virtual bool UpdateOrAdd(T item, out T olditem)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
/// <returns></returns>
public virtual bool Remove(T item)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item">The value to remove.</param>
/// <param name="removeditem">The removed value.</param>
/// <returns></returns>
public virtual bool Remove(T item, out T removeditem)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
public virtual void RemoveAllCopies(T item)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <typeparam name="U"></typeparam>
/// <param name="items"></param>
public virtual void RemoveAll<U>(SCG.IEnumerable<U> items) where U : T
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
public virtual void Clear()
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <typeparam name="U"></typeparam>
/// <param name="items"></param>
public virtual void RetainAll<U>(SCG.IEnumerable<U> items) where U : T
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// Check wrapped collection for internal consistency
/// </summary>
/// <returns>True if check passed</returns>
public virtual bool Check() { return collection.Check(); }
#endregion
#region IExtensible<T> Members
/// <summary> </summary>
/// <value>False if wrapped collection has set semantics</value>
public virtual bool AllowsDuplicates { get { return collection.AllowsDuplicates; } }
//TODO: the equalityComparer should be guarded
/// <summary>
///
/// </summary>
/// <value></value>
public virtual SCG.IEqualityComparer<T> EqualityComparer { get { return collection.EqualityComparer; } }
/// <summary>
/// By convention this is true for any collection with set semantics.
/// </summary>
/// <value>True if only one representative of a group of equal items
/// is kept in the collection together with the total count.</value>
public virtual bool DuplicatesByCounting { get { return collection.DuplicatesByCounting; } }
/// <summary> </summary>
/// <value>True if wrapped collection is empty</value>
public override bool IsEmpty { get { return collection.IsEmpty; } }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
/// <returns></returns>
public virtual bool Add(T item)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
void SCG.ICollection<T>.Add(T item)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <typeparam name="U"></typeparam>
/// <param name="items"></param>
public virtual void AddAll<U>(SCG.IEnumerable<U> items) where U : T
{ throw new ReadOnlyCollectionException(); }
#endregion
#region ICloneable Members
/// <summary>
///
/// </summary>
/// <returns></returns>
public virtual object Clone()
{
return new GuardedCollection<T>((ICollection<T>)(collection.Clone()));
}
#endregion
}
/// <summary>
/// A read-only wrapper for a sequenced collection
///
/// <i>This is mainly interesting as a base of other guard classes</i>
/// </summary>
public class GuardedSequenced<T> : GuardedCollection<T>, ISequenced<T>
{
#region Fields
ISequenced<T> sequenced;
#endregion
#region Constructor
/// <summary>
/// Wrap a sequenced collection in a read-only wrapper
/// </summary>
/// <param name="sorted"></param>
public GuardedSequenced(ISequenced<T> sorted) : base(sorted) { this.sequenced = sorted; }
#endregion
/// <summary>
/// Check if there exists an item that satisfies a
/// specific predicate in this collection and return the index of the first one.
/// </summary>
/// <param name="predicate">A delegate
/// (<see cref="T:C5.Fun`2"/> with <code>R == bool</code>) defining the predicate</param>
/// <returns>the index, if found, a negative value else</returns>
public int FindIndex(Fun<T, bool> predicate)
{
IIndexed<T> indexed = sequenced as IIndexed<T>;
if (indexed != null)
return indexed.FindIndex(predicate);
int index = 0;
foreach (T item in this)
{
if (predicate(item))
return index;
index++;
}
return -1;
}
/// <summary>
/// Check if there exists an item that satisfies a
/// specific predicate in this collection and return the index of the last one.
/// </summary>
/// <param name="predicate">A delegate
/// (<see cref="T:C5.Fun`2"/> with <code>R == bool</code>) defining the predicate</param>
/// <returns>the index, if found, a negative value else</returns>
public int FindLastIndex(Fun<T, bool> predicate)
{
IIndexed<T> indexed = sequenced as IIndexed<T>;
if (indexed != null)
return indexed.FindLastIndex(predicate);
int index = Count - 1;
foreach (T item in Backwards())
{
if (predicate(item))
return index;
index--;
}
return -1;
}
#region ISequenced<T> Members
/// <summary>
///
/// </summary>
/// <returns></returns>
public int GetSequencedHashCode()
{ return sequenced.GetSequencedHashCode(); }
/// <summary>
///
/// </summary>
/// <param name="that"></param>
/// <returns></returns>
public bool SequencedEquals(ISequenced<T> that)
{ return sequenced.SequencedEquals(that); }
#endregion
#region IDirectedCollection<T> Members
/// <summary>
/// Get a collection that enumerates the wrapped collection in the opposite direction
/// </summary>
/// <returns>The mirrored collection</returns>
public virtual IDirectedCollectionValue<T> Backwards()
{ return new GuardedDirectedCollectionValue<T>(sequenced.Backwards()); }
/// <summary>
///
/// </summary>
/// <param name="predicate"></param>
/// <param name="item"></param>
/// <returns></returns>
public virtual bool FindLast(Fun<T, bool> predicate, out T item) { return sequenced.FindLast(predicate, out item); }
#endregion
#region IDirectedEnumerable<T> Members
IDirectedEnumerable<T> IDirectedEnumerable<T>.Backwards()
{ return Backwards(); }
/// <summary>
/// <code>Forwards</code> if same, else <code>Backwards</code>
/// </summary>
/// <value>The enumeration direction relative to the original collection.</value>
public EnumerationDirection Direction
{ get { return EnumerationDirection.Forwards; } }
#endregion
#region ICloneable Members
/// <summary>
///
/// </summary>
/// <returns></returns>
public override object Clone()
{
return new GuardedCollection<T>((ISequenced<T>)(sequenced.Clone()));
}
#endregion
}
/// <summary>
/// A read-only wrapper for a sorted collection
///
/// <i>This is mainly interesting as a base of other guard classes</i>
/// </summary>
public class GuardedSorted<T> : GuardedSequenced<T>, ISorted<T>
{
#region Fields
ISorted<T> sorted;
#endregion
#region Constructor
/// <summary>
/// Wrap a sorted collection in a read-only wrapper
/// </summary>
/// <param name="sorted"></param>
public GuardedSorted(ISorted<T> sorted) : base(sorted) { this.sorted = sorted; }
#endregion
#region ISorted<T> Members
/// <summary>
/// Find the strict predecessor of item in the guarded sorted collection,
/// that is, the greatest item in the collection smaller than the item.
/// </summary>
/// <param name="item">The item to find the predecessor for.</param>
/// <param name="res">The predecessor, if any; otherwise the default value for T.</param>
/// <returns>True if item has a predecessor; otherwise false.</returns>
public bool TryPredecessor(T item, out T res) { return sorted.TryPredecessor(item, out res); }
/// <summary>
/// Find the strict successor of item in the guarded sorted collection,
/// that is, the least item in the collection greater than the supplied value.
/// </summary>
/// <param name="item">The item to find the successor for.</param>
/// <param name="res">The successor, if any; otherwise the default value for T.</param>
/// <returns>True if item has a successor; otherwise false.</returns>
public bool TrySuccessor(T item, out T res) { return sorted.TrySuccessor(item, out res); }
/// <summary>
/// Find the weak predecessor of item in the guarded sorted collection,
/// that is, the greatest item in the collection smaller than or equal to the item.
/// </summary>
/// <param name="item">The item to find the weak predecessor for.</param>
/// <param name="res">The weak predecessor, if any; otherwise the default value for T.</param>
/// <returns>True if item has a weak predecessor; otherwise false.</returns>
public bool TryWeakPredecessor(T item, out T res) { return sorted.TryWeakPredecessor(item, out res); }
/// <summary>
/// Find the weak successor of item in the sorted collection,
/// that is, the least item in the collection greater than or equal to the supplied value.
/// </summary>
/// <param name="item">The item to find the weak successor for.</param>
/// <param name="res">The weak successor, if any; otherwise the default value for T.</param>
/// <returns>True if item has a weak successor; otherwise false.</returns>
public bool TryWeakSuccessor(T item, out T res) { return sorted.TryWeakSuccessor(item, out res); }
/// <summary>
/// Find the predecessor of the item in the wrapped sorted collection
/// </summary>
/// <exception cref="NoSuchItemException"> if no such element exists </exception>
/// <param name="item">The item</param>
/// <returns>The predecessor</returns>
public T Predecessor(T item) { return sorted.Predecessor(item); }
/// <summary>
/// Find the Successor of the item in the wrapped sorted collection
/// </summary>
/// <exception cref="NoSuchItemException"> if no such element exists </exception>
/// <param name="item">The item</param>
/// <returns>The Successor</returns>
public T Successor(T item) { return sorted.Successor(item); }
/// <summary>
/// Find the weak predecessor of the item in the wrapped sorted collection
/// </summary>
/// <exception cref="NoSuchItemException"> if no such element exists </exception>
/// <param name="item">The item</param>
/// <returns>The weak predecessor</returns>
public T WeakPredecessor(T item) { return sorted.WeakPredecessor(item); }
/// <summary>
/// Find the weak Successor of the item in the wrapped sorted collection
/// </summary>
/// <exception cref="NoSuchItemException"> if no such element exists </exception>
/// <param name="item">The item</param>
/// <returns>The weak Successor</returns>
public T WeakSuccessor(T item) { return sorted.WeakSuccessor(item); }
/// <summary>
/// Run Cut on the wrapped sorted collection
/// </summary>
/// <param name="c"></param>
/// <param name="low"></param>
/// <param name="lval"></param>
/// <param name="high"></param>
/// <param name="hval"></param>
/// <returns></returns>
public bool Cut(IComparable<T> c, out T low, out bool lval, out T high, out bool hval)
{ return sorted.Cut(c, out low, out lval, out high, out hval); }
/// <summary>
/// Get the specified range from the wrapped collection.
/// (The current implementation erroneously does not wrap the result.)
/// </summary>
/// <param name="bot"></param>
/// <returns></returns>
public IDirectedEnumerable<T> RangeFrom(T bot) { return sorted.RangeFrom(bot); }
/// <summary>
/// Get the specified range from the wrapped collection.
/// (The current implementation erroneously does not wrap the result.)
/// </summary>
/// <param name="bot"></param>
/// <param name="top"></param>
/// <returns></returns>
public IDirectedEnumerable<T> RangeFromTo(T bot, T top)
{ return sorted.RangeFromTo(bot, top); }
/// <summary>
/// Get the specified range from the wrapped collection.
/// (The current implementation erroneously does not wrap the result.)
/// </summary>
/// <param name="top"></param>
/// <returns></returns>
public IDirectedEnumerable<T> RangeTo(T top) { return sorted.RangeTo(top); }
/// <summary>
/// Get the specified range from the wrapped collection.
/// (The current implementation erroneously does not wrap the result.)
/// </summary>
/// <returns></returns>
public IDirectedCollectionValue<T> RangeAll() { return sorted.RangeAll(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="items"></param>
/// <typeparam name="U"></typeparam>
public void AddSorted<U>(SCG.IEnumerable<U> items) where U : T
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="low"></param>
public void RemoveRangeFrom(T low)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="low"></param>
/// <param name="hi"></param>
public void RemoveRangeFromTo(T low, T hi)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="hi"></param>
public void RemoveRangeTo(T hi)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
#endregion
#region IPriorityQueue<T> Members
/// <summary>
/// Find the minimum of the wrapped collection
/// </summary>
/// <returns>The minimum</returns>
public T FindMin() { return sorted.FindMin(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns></returns>
public T DeleteMin()
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// Find the maximum of the wrapped collection
/// </summary>
/// <returns>The maximum</returns>
public T FindMax() { return sorted.FindMax(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns></returns>
public T DeleteMax()
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
//TODO: we should guard the comparer!
/// <summary>
/// The comparer object supplied at creation time for the underlying collection
/// </summary>
/// <value>The comparer</value>
public SCG.IComparer<T> Comparer { get { return sorted.Comparer; } }
#endregion
#region IDirectedEnumerable<T> Members
IDirectedEnumerable<T> IDirectedEnumerable<T>.Backwards()
{ return Backwards(); }
#endregion
/// <summary>
///
/// </summary>
/// <returns></returns>
public override object Clone()
{
return new GuardedSorted<T>((ISorted<T>)(sorted.Clone()));
}
}
/// <summary>
/// Read-only wrapper for indexed sorted collections
///
/// <i>Suitable for wrapping TreeSet, TreeBag and SortedArray</i>
/// </summary>
public class GuardedIndexedSorted<T> : GuardedSorted<T>, IIndexedSorted<T>
{
#region Fields
IIndexedSorted<T> indexedsorted;
#endregion
#region Constructor
/// <summary>
/// Wrap an indexed sorted collection in a read-only wrapper
/// </summary>
/// <param name="list">the indexed sorted collection</param>
public GuardedIndexedSorted(IIndexedSorted<T> list)
: base(list)
{ this.indexedsorted = list; }
#endregion
#region IIndexedSorted<T> Members
/// <summary>
/// Get the specified range from the wrapped collection.
/// (The current implementation erroneously does not wrap the result.)
/// </summary>
/// <param name="bot"></param>
/// <returns></returns>
public new IDirectedCollectionValue<T> RangeFrom(T bot)
{ return indexedsorted.RangeFrom(bot); }
/// <summary>
/// Get the specified range from the wrapped collection.
/// (The current implementation erroneously does not wrap the result.)
/// </summary>
/// <param name="bot"></param>
/// <param name="top"></param>
/// <returns></returns>
public new IDirectedCollectionValue<T> RangeFromTo(T bot, T top)
{ return indexedsorted.RangeFromTo(bot, top); }
/// <summary>
/// Get the specified range from the wrapped collection.
/// (The current implementation erroneously does not wrap the result.)
/// </summary>
/// <param name="top"></param>
/// <returns></returns>
public new IDirectedCollectionValue<T> RangeTo(T top)
{ return indexedsorted.RangeTo(top); }
/// <summary>
/// Report the number of items in the specified range of the wrapped collection
/// </summary>
/// <param name="bot"></param>
/// <returns></returns>
public int CountFrom(T bot) { return indexedsorted.CountFrom(bot); }
/// <summary>
/// Report the number of items in the specified range of the wrapped collection
/// </summary>
/// <param name="bot"></param>
/// <param name="top"></param>
/// <returns></returns>
public int CountFromTo(T bot, T top) { return indexedsorted.CountFromTo(bot, top); }
/// <summary>
/// Report the number of items in the specified range of the wrapped collection
/// </summary>
/// <param name="top"></param>
/// <returns></returns>
public int CountTo(T top) { return indexedsorted.CountTo(top); }
/// <summary>
/// Run FindAll on the wrapped collection with the indicated filter.
/// The result will <b>not</b> be read-only.
/// </summary>
/// <param name="f"></param>
/// <returns></returns>
public IIndexedSorted<T> FindAll(Fun<T, bool> f)
{ return indexedsorted.FindAll(f); }
/// <summary>
/// Run Map on the wrapped collection with the indicated mapper.
/// The result will <b>not</b> be read-only.
/// </summary>
/// <param name="m"></param>
/// <param name="c">The comparer to use in the result</param>
/// <returns></returns>
public IIndexedSorted<V> Map<V>(Fun<T, V> m, SCG.IComparer<V> c)
{ return indexedsorted.Map(m, c); }
#endregion
#region IIndexed<T> Members
/// <summary>
///
/// </summary>
/// <value>The i'th item of the wrapped sorted collection</value>
public T this[int i] { get { return indexedsorted[i]; } }
/// <summary>
///
/// </summary>
/// <value></value>
public virtual Speed IndexingSpeed { get { return indexedsorted.IndexingSpeed; } }
/// <summary> </summary>
/// <value>A directed collection of the items in the indicated interval of the wrapped collection</value>
public IDirectedCollectionValue<T> this[int start, int end]
{ get { return new GuardedDirectedCollectionValue<T>(indexedsorted[start, end]); } }
/// <summary>
/// Find the (first) index of an item in the wrapped collection
/// </summary>
/// <param name="item"></param>
/// <returns></returns>
public int IndexOf(T item) { return indexedsorted.IndexOf(item); }
/// <summary>
/// Find the last index of an item in the wrapped collection
/// </summary>
/// <param name="item"></param>
/// <returns></returns>
public int LastIndexOf(T item) { return indexedsorted.LastIndexOf(item); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="i"></param>
/// <returns></returns>
public T RemoveAt(int i)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="start"></param>
/// <param name="count"></param>
public void RemoveInterval(int start, int count)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
#endregion
#region IDirectedEnumerable<T> Members
IDirectedEnumerable<T> IDirectedEnumerable<T>.Backwards()
{ return Backwards(); }
#endregion
/// <summary>
///
/// </summary>
/// <returns></returns>
public override object Clone()
{
return new GuardedIndexedSorted<T>((IIndexedSorted<T>)(indexedsorted.Clone()));
}
}
/// <summary>
/// A read-only wrapper for a generic list collection
/// <i>Suitable as a wrapper for LinkedList, HashedLinkedList, ArrayList and HashedArray.
/// <see cref="T:C5.LinkedList`1"/>,
/// <see cref="T:C5.HashedLinkedList`1"/>,
/// <see cref="T:C5.ArrayList`1"/> or
/// <see cref="T:C5.HashedArray`1"/>.
/// </i>
/// </summary>
public class GuardedList<T> : GuardedSequenced<T>, IList<T>, SCG.IList<T>
{
#region Fields
IList<T> innerlist;
GuardedList<T> underlying;
bool slidableView = false;
#endregion
#region Constructor
/// <summary>
/// Wrap a list in a read-only wrapper. A list gets wrapped as read-only,
/// a list view gets wrapped as read-only and non-slidable.
/// </summary>
/// <param name="list">The list</param>
public GuardedList(IList<T> list)
: base(list)
{
this.innerlist = list;
// If wrapping a list view, make innerlist = the view, and make
// underlying = a guarded version of the view's underlying list
if (list.Underlying != null)
underlying = new GuardedList<T>(list.Underlying, null, false);
}
GuardedList(IList<T> list, GuardedList<T> underlying, bool slidableView)
: base(list)
{
this.innerlist = list; this.underlying = underlying; this.slidableView = slidableView;
}
#endregion
#region IList<T> Members
/// <summary>
///
/// </summary>
/// <value>The first item of the wrapped list</value>
public T First { get { return innerlist.First; } }
/// <summary>
///
/// </summary>
/// <value>The last item of the wrapped list</value>
public T Last { get { return innerlist.Last; } }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> if used as setter</exception>
/// <value>True if wrapped list has FIFO semantics for the Add(T item) and Remove() methods</value>
public bool FIFO
{
get { return innerlist.FIFO; }
set { throw new ReadOnlyCollectionException("List is read only"); }
}
/// <summary>
///
/// </summary>
public virtual bool IsFixedSize
{
get { return true; }
}
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> if used as setter</exception>
/// <value>The i'th item of the wrapped list</value>
public T this[int i]
{
get { return innerlist[i]; }
set { throw new ReadOnlyCollectionException("List is read only"); }
}
/// <summary>
///
/// </summary>
/// <value></value>
public virtual Speed IndexingSpeed { get { return innerlist.IndexingSpeed; } }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="index"></param>
/// <param name="item"></param>
public void Insert(int index, T item)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="pointer"></param>
/// <param name="item"></param>
public void Insert(IList<T> pointer, T item)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
public void InsertFirst(T item)
{ throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
public void InsertLast(T item)
{ throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
/// <param name="target"></param>
public void InsertBefore(T item, T target)
{ throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="item"></param>
/// <param name="target"></param>
public void InsertAfter(T item, T target)
{ throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="i"></param>
/// <param name="items"></param>
public void InsertAll<U>(int i, SCG.IEnumerable<U> items) where U : T
{ throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// Perform FindAll on the wrapped list. The result is <b>not</b> necessarily read-only.
/// </summary>
/// <param name="filter">The filter to use</param>
/// <returns></returns>
public IList<T> FindAll(Fun<T, bool> filter) { return innerlist.FindAll(filter); }
/// <summary>
/// Perform Map on the wrapped list. The result is <b>not</b> necessarily read-only.
/// </summary>
/// <typeparam name="V">The type of items of the new list</typeparam>
/// <param name="mapper">The mapper to use.</param>
/// <returns>The mapped list</returns>
public IList<V> Map<V>(Fun<T, V> mapper) { return innerlist.Map(mapper); }
/// <summary>
/// Perform Map on the wrapped list. The result is <b>not</b> necessarily read-only.
/// </summary>
/// <typeparam name="V">The type of items of the new list</typeparam>
/// <param name="mapper">The delegate defining the map.</param>
/// <param name="itemequalityComparer">The itemequalityComparer to use for the new list</param>
/// <returns>The new list.</returns>
public IList<V> Map<V>(Fun<T, V> mapper, SCG.IEqualityComparer<V> itemequalityComparer) { return innerlist.Map(mapper, itemequalityComparer); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns></returns>
public T Remove() { throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns></returns>
public T RemoveFirst() { throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns></returns>
public T RemoveLast() { throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// Create the indicated view on the wrapped list and wrap it read-only.
/// </summary>
/// <param name="start"></param>
/// <param name="count"></param>
/// <returns></returns>
public IList<T> View(int start, int count)
{
IList<T> view = innerlist.View(start, count);
return view == null ? null : new GuardedList<T>(view, underlying ?? this, true);
}
/// <summary>
/// Create the indicated view on the wrapped list and wrap it read-only.
/// </summary>
/// <param name="item"></param>
/// <returns></returns>
public IList<T> ViewOf(T item)
{
IList<T> view = innerlist.ViewOf(item);
return view == null ? null : new GuardedList<T>(view, underlying ?? this, true);
}
/// <summary>
/// Create the indicated view on the wrapped list and wrap it read-only.
/// </summary>
/// <param name="item"></param>
/// <returns></returns>
public IList<T> LastViewOf(T item)
{
IList<T> view = innerlist.LastViewOf(item);
return view == null ? null : new GuardedList<T>(view, underlying ?? this, true);
}
/// <summary>
/// </summary>
/// <value>The wrapped underlying list of the wrapped view </value>
public IList<T> Underlying { get { return underlying; } }
/// <summary>
///
/// </summary>
/// <value>The offset of the wrapped list as a view.</value>
public int Offset { get { return innerlist.Offset; } }
/// <summary>
///
/// </summary>
/// <value></value>
public virtual bool IsValid { get { return innerlist.IsValid; } }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> if this is a wrapped view and not a view that was made on a wrapper</exception>
/// <param name="offset"></param>
public IList<T> Slide(int offset)
{
if (slidableView)
{
innerlist.Slide(offset);
return this;
}
else
throw new ReadOnlyCollectionException("List is read only");
}
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="offset"></param>
/// <param name="size"></param>
public IList<T> Slide(int offset, int size)
{
if (slidableView)
{
innerlist.Slide(offset, size);
return this;
}
else
throw new ReadOnlyCollectionException("List is read only");
}
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="offset"></param>
/// <returns></returns>
public bool TrySlide(int offset)
{
if (slidableView)
return innerlist.TrySlide(offset);
else
throw new ReadOnlyCollectionException("List is read only");
}
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="offset"></param>
/// <param name="size"></param>
/// <returns></returns>
public bool TrySlide(int offset, int size)
{
if (slidableView)
return innerlist.TrySlide(offset, size);
else
throw new ReadOnlyCollectionException("List is read only");
}
/// <summary>
///
/// </summary>
/// <param name="otherView"></param>
/// <returns></returns>
public IList<T> Span(IList<T> otherView)
{
GuardedList<T> otherGuardedList = otherView as GuardedList<T>;
if (otherGuardedList == null)
throw new IncompatibleViewException();
IList<T> span = innerlist.Span(otherGuardedList.innerlist);
if (span == null)
return null;
return new GuardedList<T>(span, underlying ?? otherGuardedList.underlying ?? this, true);
}
/// <summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// </summary>
public void Reverse() { throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="start"></param>
/// <param name="count"></param>
public void Reverse(int start, int count)
{ throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// Check if wrapped list is sorted according to the default sorting order
/// for the item type T, as defined by the <see cref="T:C5.Comparer`1"/> class
/// </summary>
/// <exception cref="NotComparableException">if T is not comparable</exception>
/// <returns>True if the list is sorted, else false.</returns>
public bool IsSorted() { return innerlist.IsSorted(Comparer<T>.Default); }
/// <summary>
/// Check if wrapped list is sorted
/// </summary>
/// <param name="c">The sorting order to use</param>
/// <returns>True if sorted</returns>
public bool IsSorted(SCG.IComparer<T> c) { return innerlist.IsSorted(c); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
public void Sort()
{ throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="c"></param>
public void Sort(SCG.IComparer<T> c)
{ throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
public void Shuffle()
{ throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="rnd"></param>
public void Shuffle(Random rnd)
{ throw new ReadOnlyCollectionException("List is read only"); }
#endregion
#region IIndexed<T> Members
/// <summary> </summary>
/// <value>A directed collection of the items in the indicated interval of the wrapped collection</value>
public IDirectedCollectionValue<T> this[int start, int end]
{ get { return new GuardedDirectedCollectionValue<T>(innerlist[start, end]); } }
/// <summary>
/// Find the (first) index of an item in the wrapped collection
/// </summary>
/// <param name="item"></param>
/// <returns></returns>
public int IndexOf(T item) { return innerlist.IndexOf(item); }
/// <summary>
/// Find the last index of an item in the wrapped collection
/// </summary>
/// <param name="item"></param>
/// <returns></returns>
public int LastIndexOf(T item) { return innerlist.LastIndexOf(item); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="i"></param>
/// <returns></returns>
public T RemoveAt(int i)
{ throw new ReadOnlyCollectionException("List is read only"); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="start"></param>
/// <param name="count"></param>
public void RemoveInterval(int start, int count)
{ throw new ReadOnlyCollectionException("List is read only"); }
#endregion
#region IDirectedEnumerable<T> Members
IDirectedEnumerable<T> IDirectedEnumerable<T>.Backwards()
{ return Backwards(); }
#endregion
#region IStack<T> Members
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns>-</returns>
public void Push(T item)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns>-</returns>
public T Pop()
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
#endregion
#region IQueue<T> Members
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns>-</returns>
public void Enqueue(T item)
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns>-</returns>
public T Dequeue()
{ throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object"); }
#endregion
#region IDisposable Members
/// <summary>
/// Ignore: this may be called by a foreach or using statement.
/// </summary>
public void Dispose() { }
#endregion
/// <summary>
///
/// </summary>
/// <returns></returns>
public override object Clone()
{
return new GuardedList<T>((IList<T>)(innerlist.Clone()));
}
#region System.Collections.Generic.IList<T> Members
void System.Collections.Generic.IList<T>.RemoveAt(int index)
{
throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object");
}
void System.Collections.Generic.ICollection<T>.Add(T item)
{
throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object");
}
#endregion
#region System.Collections.ICollection Members
bool System.Collections.ICollection.IsSynchronized
{
get { return false; }
}
[Obsolete]
Object System.Collections.ICollection.SyncRoot
{
get { return innerlist.SyncRoot; }
}
void System.Collections.ICollection.CopyTo(Array arr, int index)
{
if (index < 0 || index + Count > arr.Length)
throw new ArgumentOutOfRangeException();
foreach (T item in this)
arr.SetValue(item, index++);
}
#endregion
#region System.Collections.IList Members
Object System.Collections.IList.this[int index]
{
get { return this[index]; }
set
{
throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object");
}
}
int System.Collections.IList.Add(Object o)
{
throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object");
}
bool System.Collections.IList.Contains(Object o)
{
return Contains((T)o);
}
int System.Collections.IList.IndexOf(Object o)
{
return Math.Max(-1, IndexOf((T)o));
}
void System.Collections.IList.Insert(int index, Object o)
{
throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object");
}
void System.Collections.IList.Remove(Object o)
{
throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object");
}
void System.Collections.IList.RemoveAt(int index)
{
throw new ReadOnlyCollectionException("Collection cannot be modified through this guard object");
}
#endregion
}
/// <summary>
/// A read-only wrapper for a generic indexable queue (allows indexing).
///
/// <para>Suitable for wrapping a <see cref="T:C5.CircularQueue`1"/></para>
/// </summary>
/// <typeparam name="T">The item type.</typeparam>
public class GuardedQueue<T> : GuardedDirectedCollectionValue<T>, IQueue<T>
{
#region Fields
IQueue<T> queue;
#endregion
#region Constructor
/// <summary>
/// Wrap a queue in a read-only wrapper
/// </summary>
/// <param name="queue">The queue</param>
public GuardedQueue(IQueue<T> queue) : base(queue) { this.queue = queue; }
#endregion
#region IQueue<T> Members
/// <summary>
///
/// </summary>
/// <value></value>
public bool AllowsDuplicates { get { return queue.AllowsDuplicates; } }
/// <summary>
/// Index into the wrapped queue
/// </summary>
/// <param name="i"></param>
/// <returns></returns>
public T this[int i] { get { return queue[i]; } }
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns>-</returns>
public void Enqueue(T item)
{ throw new ReadOnlyCollectionException("Queue cannot be modified through this guard object"); }
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns>-</returns>
public T Dequeue()
{ throw new ReadOnlyCollectionException("Queue cannot be modified through this guard object"); }
#endregion
}
/// <summary>
/// A read-only wrapper for a dictionary.
///
/// <i>Suitable for wrapping a HashDictionary. <see cref="T:C5.HashDictionary`2"/></i>
/// </summary>
public class GuardedDictionary<K, V> : GuardedCollectionValue<KeyValuePair<K, V>>, IDictionary<K, V>
{
#region Fields
IDictionary<K, V> dict;
#endregion
#region Constructor
/// <summary>
/// Wrap a dictionary in a read-only wrapper
/// </summary>
/// <param name="dict">the dictionary</param>
public GuardedDictionary(IDictionary<K, V> dict) : base(dict) { this.dict = dict; }
#endregion
#region IDictionary<K,V> Members
/// <summary>
///
/// </summary>
/// <value></value>
public SCG.IEqualityComparer<K> EqualityComparer { get { return dict.EqualityComparer; } }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a
/// read-only wrappper if used as a setter</exception>
/// <value>Get the value corresponding to a key in the wrapped dictionary</value>
public V this[K key]
{
get { return dict[key]; }
set { throw new ReadOnlyCollectionException(); }
}
/// <summary>
/// (This is a read-only wrapper)
/// </summary>
/// <value>True</value>
public bool IsReadOnly { get { return true; } }
//TODO: guard with a read-only wrapper? Probably so!
/// <summary> </summary>
/// <value>The collection of keys of the wrapped dictionary</value>
public ICollectionValue<K> Keys
{ get { return dict.Keys; } }
/// <summary> </summary>
/// <value>The collection of values of the wrapped dictionary</value>
public ICollectionValue<V> Values { get { return dict.Values; } }
/// <summary>
///
/// </summary>
public virtual Fun<K, V> Fun { get { return delegate(K k) { return this[k]; }; } }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="key"></param>
/// <param name="val"></param>
public void Add(K key, V val)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="items"></param>
public void AddAll<L, W>(SCG.IEnumerable<KeyValuePair<L, W>> items)
where L : K
where W : V
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="key"></param>
/// <returns></returns>
public bool Remove(K key)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="key"></param>
/// <param name="val"></param>
/// <returns></returns>
public bool Remove(K key, out V val)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
public void Clear()
{ throw new ReadOnlyCollectionException(); }
/// <summary>
///
/// </summary>
/// <value></value>
public Speed ContainsSpeed { get { return dict.ContainsSpeed; } }
/// <summary>
/// Check if the wrapped dictionary contains a specific key
/// </summary>
/// <param name="key">The key</param>
/// <returns>True if it does</returns>
public bool Contains(K key) { return dict.Contains(key); }
/// <summary>
///
/// </summary>
/// <param name="keys"></param>
/// <returns></returns>
public bool ContainsAll<H>(SCG.IEnumerable<H> keys) where H : K { return dict.ContainsAll(keys); }
/// <summary>
/// Search for a key in the wrapped dictionary, reporting the value if found
/// </summary>
/// <param name="key">The key</param>
/// <param name="val">On exit: the value if found</param>
/// <returns>True if found</returns>
public bool Find(K key, out V val) { return dict.Find(key, out val); }
/// <summary>
/// Search for a key in the wrapped dictionary, reporting the value if found
/// </summary>
/// <param name="key">The key</param>
/// <param name="val">On exit: the value if found</param>
/// <returns>True if found</returns>
public bool Find(ref K key, out V val) { return dict.Find(ref key, out val); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="key"></param>
/// <param name="val"></param>
/// <returns></returns>
public bool Update(K key, V val)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="key"></param>
/// <param name="val"></param>
/// <param name="oldval"></param>
/// <returns></returns>
public bool Update(K key, V val, out V oldval)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="key"></param>
/// <param name="val"></param>
/// <returns></returns>
public bool FindOrAdd(K key, ref V val)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="key"></param>
/// <param name="val"></param>
/// <returns></returns>
public bool UpdateOrAdd(K key, V val)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="key"></param>
/// <param name="val"></param>
/// <param name="oldval"></param>
/// <returns></returns>
public bool UpdateOrAdd(K key, V val, out V oldval)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
/// Check the internal consistency of the wrapped dictionary
/// </summary>
/// <returns>True if check passed</returns>
public bool Check() { return dict.Check(); }
#endregion
/// <summary>
///
/// </summary>
/// <returns></returns>
public virtual object Clone()
{
return new GuardedDictionary<K, V>((IDictionary<K, V>)(dict.Clone()));
}
}
/// <summary>
/// A read-only wrapper for a sorted dictionary.
///
/// <i>Suitable for wrapping a Dictionary. <see cref="T:C5.Dictionary`2"/></i>
/// </summary>
public class GuardedSortedDictionary<K, V> : GuardedDictionary<K, V>, ISortedDictionary<K, V>
{
#region Fields
ISortedDictionary<K, V> sorteddict;
#endregion
#region Constructor
/// <summary>
/// Wrap a sorted dictionary in a read-only wrapper
/// </summary>
/// <param name="sorteddict">the dictionary</param>
public GuardedSortedDictionary(ISortedDictionary<K, V> sorteddict)
: base(sorteddict)
{ this.sorteddict = sorteddict; }
#endregion
#region ISortedDictionary<K,V> Members
/// <summary>
/// The key comparer used by this dictionary.
/// </summary>
/// <value></value>
public SCG.IComparer<K> Comparer { get { return sorteddict.Comparer; } }
/// <summary>
///
/// </summary>
/// <value></value>
public new ISorted<K> Keys { get { return null; } }
/// <summary>
/// Find the entry in the dictionary whose key is the
/// predecessor of the specified key.
/// </summary>
/// <param name="key">The key</param>
/// <param name="res">The predecessor, if any</param>
/// <returns>True if key has a predecessor</returns>
public bool TryPredecessor(K key, out KeyValuePair<K, V> res)
{
return sorteddict.TryPredecessor(key, out res);
}
/// <summary>
/// Find the entry in the dictionary whose key is the
/// successor of the specified key.
/// </summary>
/// <param name="key">The key</param>
/// <param name="res">The successor, if any</param>
/// <returns>True if the key has a successor</returns>
public bool TrySuccessor(K key, out KeyValuePair<K, V> res)
{
return sorteddict.TrySuccessor(key, out res);
}
/// <summary>
/// Find the entry in the dictionary whose key is the
/// weak predecessor of the specified key.
/// </summary>
/// <param name="key">The key</param>
/// <param name="res">The predecessor, if any</param>
/// <returns>True if key has a weak predecessor</returns>
public bool TryWeakPredecessor(K key, out KeyValuePair<K, V> res)
{
return sorteddict.TryWeakPredecessor(key, out res);
}
/// <summary>
/// Find the entry in the dictionary whose key is the
/// weak successor of the specified key.
/// </summary>
/// <param name="key">The key</param>
/// <param name="res">The weak successor, if any</param>
/// <returns>True if the key has a weak successor</returns>
public bool TryWeakSuccessor(K key, out KeyValuePair<K, V> res)
{
return sorteddict.TryWeakSuccessor(key, out res);
}
/// <summary>
/// Get the entry in the wrapped dictionary whose key is the
/// predecessor of a specified key.
/// </summary>
/// <exception cref="NoSuchItemException"> if no such entry exists </exception>
/// <param name="key">The key</param>
/// <returns>The entry</returns>
public KeyValuePair<K, V> Predecessor(K key)
{ return sorteddict.Predecessor(key); }
/// <summary>
/// Get the entry in the wrapped dictionary whose key is the
/// successor of a specified key.
/// </summary>
/// <exception cref="NoSuchItemException"> if no such entry exists </exception>
/// <param name="key">The key</param>
/// <returns>The entry</returns>
public KeyValuePair<K, V> Successor(K key)
{ return sorteddict.Successor(key); }
/// <summary>
/// Get the entry in the wrapped dictionary whose key is the
/// weak predecessor of a specified key.
/// </summary>
/// <exception cref="NoSuchItemException"> if no such entry exists </exception>
/// <param name="key">The key</param>
/// <returns>The entry</returns>
public KeyValuePair<K, V> WeakPredecessor(K key)
{ return sorteddict.WeakPredecessor(key); }
/// <summary>
/// Get the entry in the wrapped dictionary whose key is the
/// weak successor of a specified key.
/// </summary>
/// <exception cref="NoSuchItemException"> if no such entry exists </exception>
/// <param name="key">The key</param>
/// <returns>The entry</returns>
public KeyValuePair<K, V> WeakSuccessor(K key)
{ return sorteddict.WeakSuccessor(key); }
/// <summary>
///
/// </summary>
/// <returns></returns>
public KeyValuePair<K, V> FindMin()
{
return sorteddict.FindMin();
}
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns></returns>
public KeyValuePair<K, V> DeleteMin()
{ throw new ReadOnlyCollectionException(); }
/// <summary>
///
/// </summary>
/// <returns></returns>
public KeyValuePair<K, V> FindMax()
{
return sorteddict.FindMax();
}
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <returns></returns>
public KeyValuePair<K, V> DeleteMax()
{ throw new ReadOnlyCollectionException(); }
/// <summary>
///
/// </summary>
/// <param name="c"></param>
/// <param name="lowEntry"></param>
/// <param name="lowIsValid"></param>
/// <param name="highEntry"></param>
/// <param name="highIsValid"></param>
/// <returns></returns>
public bool Cut(IComparable<K> c, out KeyValuePair<K, V> lowEntry, out bool lowIsValid, out KeyValuePair<K, V> highEntry, out bool highIsValid)
{
return sorteddict.Cut(c, out lowEntry, out lowIsValid, out highEntry, out highIsValid); ;
}
/// <summary>
///
/// </summary>
/// <param name="bot"></param>
/// <returns></returns>
public IDirectedEnumerable<KeyValuePair<K, V>> RangeFrom(K bot)
{
return new GuardedDirectedEnumerable<KeyValuePair<K, V>>(sorteddict.RangeFrom(bot));
}
/// <summary>
///
/// </summary>
/// <param name="bot"></param>
/// <param name="top"></param>
/// <returns></returns>
public IDirectedEnumerable<KeyValuePair<K, V>> RangeFromTo(K bot, K top)
{
return new GuardedDirectedEnumerable<KeyValuePair<K, V>>(sorteddict.RangeFromTo(bot, top));
}
/// <summary>
///
/// </summary>
/// <param name="top"></param>
/// <returns></returns>
public IDirectedEnumerable<KeyValuePair<K, V>> RangeTo(K top)
{
return new GuardedDirectedEnumerable<KeyValuePair<K, V>>(sorteddict.RangeTo(top));
}
/// <summary>
///
/// </summary>
/// <returns></returns>
public IDirectedCollectionValue<KeyValuePair<K, V>> RangeAll()
{
return new GuardedDirectedCollectionValue<KeyValuePair<K, V>>(sorteddict.RangeAll());
}
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="items"></param>
public void AddSorted(System.Collections.Generic.IEnumerable<KeyValuePair<K, V>> items)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="low"></param>
public void RemoveRangeFrom(K low)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="low"></param>
/// <param name="hi"></param>
public void RemoveRangeFromTo(K low, K hi)
{ throw new ReadOnlyCollectionException(); }
/// <summary>
///
/// </summary>
/// <exception cref="ReadOnlyCollectionException"> since this is a read-only wrappper</exception>
/// <param name="hi"></param>
public void RemoveRangeTo(K hi)
{ throw new ReadOnlyCollectionException(); }
#endregion
}
}
|