From 26c3581f17f475fab2f3b5301b8f253ff2fa6438 Mon Sep 17 00:00:00 2001
From: Wieland Hoffmann <themineo@gmail.com>
Date: Mon, 30 Nov 2015 09:32:48 +0000
Subject: [PATCH] [DOC] Explicitly state that top maintains the order of
elements
Top is implemented in terms of takeOrdered, which already maintains the
order, so top should, too.
Author: Wieland Hoffmann <themineo@gmail.com>
Closes #10013 from mineo/top-order.
---
.../main/scala/org/apache/spark/api/java/JavaRDDLike.scala | 4 ++--
core/src/main/scala/org/apache/spark/rdd/RDD.scala | 3 ++-
2 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/core/src/main/scala/org/apache/spark/api/java/JavaRDDLike.scala b/core/src/main/scala/org/apache/spark/api/java/JavaRDDLike.scala
index 871be0b1f3..1e9d4f1803 100644
--- a/core/src/main/scala/org/apache/spark/api/java/JavaRDDLike.scala
+++ b/core/src/main/scala/org/apache/spark/api/java/JavaRDDLike.scala
@@ -556,7 +556,7 @@ trait JavaRDDLike[T, This <: JavaRDDLike[T, This]] extends Serializable {
/**
* Returns the top k (largest) elements from this RDD as defined by
- * the specified Comparator[T].
+ * the specified Comparator[T] and maintains the order.
* @param num k, the number of top elements to return
* @param comp the comparator that defines the order
* @return an array of top elements
@@ -567,7 +567,7 @@ trait JavaRDDLike[T, This <: JavaRDDLike[T, This]] extends Serializable {
/**
* Returns the top k (largest) elements from this RDD using the
- * natural ordering for T.
+ * natural ordering for T and maintains the order.
* @param num k, the number of top elements to return
* @return an array of top elements
*/
diff --git a/core/src/main/scala/org/apache/spark/rdd/RDD.scala b/core/src/main/scala/org/apache/spark/rdd/RDD.scala
index 2aeb5eeaad..8b3731d935 100644
--- a/core/src/main/scala/org/apache/spark/rdd/RDD.scala
+++ b/core/src/main/scala/org/apache/spark/rdd/RDD.scala
@@ -1327,7 +1327,8 @@ abstract class RDD[T: ClassTag](
/**
* Returns the top k (largest) elements from this RDD as defined by the specified
- * implicit Ordering[T]. This does the opposite of [[takeOrdered]]. For example:
+ * implicit Ordering[T] and maintains the ordering. This does the opposite of
+ * [[takeOrdered]]. For example:
* {{{
* sc.parallelize(Seq(10, 4, 2, 12, 3)).top(1)
* // returns Array(12)
--
GitLab