Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
dlebansais committed Nov 19, 2017
1 parent d467b8b commit ef657ab
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The current implementation of Collection<> and List<> in .NET (4.6.1) can

## Caveats
* Because LargeList doesn't use a single array to store data, and is not integrated with .NET for optimal performance, it is slower than the standard implementation of List<>. However, this is compensated by optimizations resulting from the partition scheme used, that give better performance for many operations such as Insert(), and acceptable overhead for others, as long as the number of elements is large. Therefore, using LargeList is not recommended if the number of elements that will be stored is relatively low (less than 10000), and recommended if it will always be large or if performance when it is low is not a concern.
* Exposed members of the LargeList namespace have been designed to be a copy, as close as possible to the original, of the Collection<> and List<> classes, as well as accompanying interfaces, including documentation. However the original documentation and implementation do not match exactly, and some features of List<> could be regarded as bugs. Therefore, in my own implementation I chose to diverge from the original documentation, and behave slightly differently than the original implementation. But full compatibility is available, see the [STRICT mode](#STRICT-mode) section below.
* Exposed members of the LargeList namespace have been designed to be a copy, as close as possible to the original, of the Collection<> and List<> classes, as well as accompanying interfaces, including documentation. However the original documentation and implementation do not match exactly, and some features of List<> could be regarded as bugs. Therefore, in my own implementation I chose to diverge from the original documentation, and behave slightly differently than the original implementation. But full compatibility is available, see the [STRICT mode](#strict-mode) section below.
* Downcasting a reference to a large collection or list to one of their compatible interface, and then using this interface to access the collection or list has not been tested extensively. It should work, but using the original reference to the object by its class is recommended.
* The sorting algorithm can give a slightly different result for items that are considered equal by a [IComparer](https://msdn.microsoft.com/en-us/library/system.collections.icomparer.aspx) but not by [System.Object.Equals()](https://msdn.microsoft.com/en-us/library/w4hkze5k.aspx).
* Classes of the LargeList namespace offer minimal support for inheritance, for example if one wants to back the data on disk rather than in memory. On the other hand the source code is available to compensate.
Expand Down

0 comments on commit ef657ab

Please sign in to comment.