{"id":3441,"date":"2011-10-21T11:03:00","date_gmt":"2011-10-21T11:03:00","guid":{"rendered":"https:\/\/test.simple-talk.com\/uncategorized\/some-non-generic-collections\/"},"modified":"2016-07-28T10:50:37","modified_gmt":"2016-07-28T10:50:37","slug":"some-non-generic-collections","status":"publish","type":"post","link":"https:\/\/www.red-gate.com\/simple-talk\/blogs\/some-non-generic-collections\/","title":{"rendered":"Some non-generic collections"},"content":{"rendered":"

Although the collections classes introduced in .NET 2, 3.5 and 4 cover most scenarios, there are still some .NET 1 collections that don’t have generic counterparts. In this post, I’ll be examining what they do, why you might use them, and some things you’ll need to bear in mind when doing so.<\/p>\n

BitArray<\/h4>\n

System.Collections.BitArray<\/code> is conceptually the same as a List<bool><\/code>, but whereas List<bool> stores each boolean in a single byte (as that’s what the backing bool[]<\/code> does), BitArray uses a single bit to store each value, and uses various bitmasks to access each bit individually. This means that BitArray is eight times smaller than a List<bool>. Furthermore, BitArray has some useful functions for bitmasks, like And<\/code>, Xor<\/code> and Not<\/code>, and it’s not limited to 32 or 64 bits; a BitArray can hold as many bits as you need.<\/p>\n

However, it’s not all roses and kittens. There are some fundamental limitations you have to bear in mind when using BitArray: <\/p>\n

    \n
  1. \n

    It’s a non-generic collection. The enumerator returns object<\/code> (a boxed boolean), rather than an unboxed bool. This means that if you do this:<\/p>\n

    foreach (bool b in bitArray) { ... }<\/pre>\n
    Every single<\/em> boolean value will be boxed, then unboxed. And if you do this:<\/p>\n
    foreach (var b in bitArray) { ... }<\/pre>\n
    you’ll have to manually unbox b<\/code> on every iteration, as it’ll come out of the enumerator an object<\/code>. Instead, you should manually iterate over the collection using a for loop:<\/p>\n
    for (int i=0; i<bitArray.Length; i++) {\n    bool b = bitArray[i];\n    ...\n}<\/pre>\n<\/li>\n
  2. Following on from that, if you want to use BitArray in the context of an IEnumerable<bool><\/code>, ICollection<bool><\/code> or IList<bool><\/code>, you’ll need to write a wrapper class, or use the Enumerable.Cast<bool><\/code> extension method (although Cast would box and unbox every value you get out of it).<\/li>\n
  3. There is no Add<\/code> or Remove<\/code> method. You specify the number of bits you need in the constructor, and that’s what you get. You can change the length yourself using the Length property setter though.<\/li>\n
  4. It doesn’t implement IList<\/code>. Although not really important if you’re writing a generic wrapper around it, it is something to bear in mind if you’re using it with pre-generic code.<\/li>\n<\/ol>\n
    However, if you use BitArray carefully, it can provide significant gains over a List<bool> for functionality and efficiency of space.<\/p>\n
    OrderedDictionary<\/h4>\n
    System.Collections.Specialized.OrderedDictionary<\/code> does exactly what you would expect – it’s an IDictionary that maintains items in the order they are added. It does this by storing key\/value pairs in a Hashtable (to get O(1) key lookup) and an ArrayList (to maintain the order). You can access values by key or index, and insert or remove items at a particular index. The enumerator returns items in index order.<\/p>\n
    However, the Keys<\/code> and Values<\/code> properties return ICollection, not IList, as you might expect; CopyTo doesn’t maintain the same ordering, as it copies from the backing Hashtable, not ArrayList; and any operations that insert or remove items from the middle of the collection are O(n), just like a normal list.<\/p>\n
    In short; don’t use this class. If you need some sort of ordered dictionary, it would be better to write your own generic dictionary combining a Dictionary<TKey, TValue><\/code> and List<KeyValuePair<TKey, TValue>><\/code> or List<TKey><\/code> for your specific situation.<\/p>\n
    ListDictionary and HybridDictionary<\/h4>\n
    To look at why you might want to use ListDictionary<\/code> or HybridDictionary<\/code>, we need to examine the performance of these dictionaries compared to Hashtable and Dictionary<object, object>. For this test, I added n items to each collection, then randomly accessed n\/2 items:<\/p>\n
      \"Dictionary%20performance.png\"<\/p>\n
    So, what’s going on here? Well, ListDictionary is implemented as a linked list of key\/value pairs; all operations on the dictionary require an O(n) search through the list. However, for small n, the constant factor that big-o notation doesn’t measure is much lower than the hashing overhead of Hashtable or Dictionary.<\/p>\n
    HybridDictionary combines a Hashtable and ListDictionary; for small n, it uses a backing ListDictionary, but switches to a Hashtable when it gets to 9 items (you can see the point it switches from a ListDictionary to Hashtable in the graph). Apart from that, it’s got very similar performance to Hashtable.<\/p>\n
    So why would you want to use either of these? In short, you wouldn’t. Any gain in performance by using ListDictionary over Dictionary<TKey, TValue> would be offset by the generic dictionary not having to cast or box the items you store, something the graphs above don’t measure.<\/p>\n
    Only if the performance of the dictionary is vital, the dictionary will hold less than 30 items, and you don’t need type safety, would you use ListDictionary over the generic Dictionary. And even then, there’s probably more useful performance gains you can make elsewhere.<\/p>\n","protected":false},"excerpt":{"rendered":"
    Although the collections classes introduced in .NET 2, 3.5 and 4 cover most scenarios, there are still some .NET 1 collections that don’t have generic counterparts. In this post, I’ll be examining what they do, why you might use them, and some things you’ll need to bear in mind when doing so. BitArray System.Collections.BitArray is……<\/p>\n","protected":false},"author":186659,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[2],"tags":[],"coauthors":[],"class_list":["post-3441","post","type-post","status-publish","format-standard","hentry","category-blogs"],"acf":[],"_links":{"self":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/3441","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/users\/186659"}],"replies":[{"embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/comments?post=3441"}],"version-history":[{"count":1,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/3441\/revisions"}],"predecessor-version":[{"id":25404,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/3441\/revisions\/25404"}],"wp:attachment":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/media?parent=3441"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/categories?post=3441"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/tags?post=3441"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/coauthors?post=3441"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}