[4/4] git commit: adding initial documentation on sorting.

[mh...@apache.org]

adding initial documentation on sorting.


Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/2c8e873b
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/2c8e873b
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/2c8e873b

Branch: refs/heads/pcl
Commit: 2c8e873b43d55ede354dc7366a5ff69d4f6c884b
Parents: 0fbb29e
Author: Michael Herndon <mh...@michaelherndon.com>
Authored: Fri Aug 1 13:32:09 2014 -0400
Committer: Michael Herndon <mh...@michaelherndon.com>
Committed: Fri Aug 1 13:32:09 2014 -0400

----------------------------------------------------------------------
 docs/sorting.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/2c8e873b/docs/sorting.md
----------------------------------------------------------------------
diff --git a/docs/sorting.md b/docs/sorting.md
new file mode 100644
index 0000000..1b26773
--- /dev/null
+++ b/docs/sorting.md
@@ -0,0 +1,11 @@
+#Sorting
+
+The system libraries in Java and C# have differences in the default sorting mechanism for their respective frameworks.
+
+[Array.Sort](http://msdn.microsoft.com/en-us/library/kwx6zbd4\(v=vs.110\).aspx)in C# uses [Quick Sort](http://algs4.cs.princeton.edu/23quicksort) as the default algorithm for soring.
+
+[Array.sort](http://docs.oracle.com/javase/7/docs/api/java/util/Arrays.html#sort(T\[\],%20java.util.Comparator) in in Java uses the [Tim Sort](http://svn.python.org/projects/python/trunk/Objects/listsort.txt) as the default sorting algorithm as of Java 7.
+
+The differences in sorting methods could account for the discrepencies between running ported tests for the various sorting algorithms in Lucene core.
+
+The base sorter test class uses Array.sort in order to test the ordinal order of elements in the array. Because of the differences of sorting alogrithm in the languages, this may break the tests that test for the oridinal positions.
\ No newline at end of file