Document that Vec_Sort is stable

Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/91ebce99
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/91ebce99
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/91ebce99

Branch: refs/heads/master
Commit: 91ebce99edb5226a31f8ba1ab734e63ddf20bfdb
Parents: 0390310
Author: Nick Wellnhofer <[email protected]>
Authored: Wed Apr 29 11:37:58 2015 +0200
Committer: Nick Wellnhofer <[email protected]>
Committed: Wed Apr 29 11:37:58 2015 +0200

----------------------------------------------------------------------
 runtime/core/Clownfish/Vector.cfh | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/91ebce99/runtime/core/Clownfish/Vector.cfh
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish/Vector.cfh 
b/runtime/core/Clownfish/Vector.cfh
index e280921..be2abc6 100644
--- a/runtime/core/Clownfish/Vector.cfh
+++ b/runtime/core/Clownfish/Vector.cfh
@@ -96,7 +96,8 @@ public class Clownfish::Vector nickname Vec inherits 
Clownfish::Obj {
     public incremented Vector*
     Clone(Vector *self);
 
-    /** Sort the Vector.
+    /** Sort the Vector.  Sort order is guaranteed to be _stable_: the
+     * relative order of elements which compare as equal will not change.
      */
     public void
     Sort(Vector *self);

Reply via email to