Skip to content
Snippets Groups Projects
Commit d1362659 authored by Sean Owen's avatar Sean Owen Committed by Patrick Wendell
Browse files

SPARK-1344 [DOCS] Scala API docs for top methods

Use "k" in javadoc of top and takeOrdered to avoid confusion with type K in pair RDDs. I think this resolves the discussion in SPARK-1344.

Author: Sean Owen <sowen@cloudera.com>

Closes #3168 from srowen/SPARK-1344 and squashes the following commits:

6963fcc [Sean Owen] Use "k" in javadoc of top and takeOrdered to avoid confusion with type K in pair RDDs
parent 8c99a47a
No related branches found
No related tags found
No related merge requests found
...@@ -493,9 +493,9 @@ trait JavaRDDLike[T, This <: JavaRDDLike[T, This]] extends Serializable { ...@@ -493,9 +493,9 @@ trait JavaRDDLike[T, This <: JavaRDDLike[T, This]] extends Serializable {
} }
/** /**
* Returns the top K elements from this RDD as defined by * Returns the top k (largest) elements from this RDD as defined by
* the specified Comparator[T]. * the specified Comparator[T].
* @param num the number of top elements to return * @param num k, the number of top elements to return
* @param comp the comparator that defines the order * @param comp the comparator that defines the order
* @return an array of top elements * @return an array of top elements
*/ */
...@@ -507,9 +507,9 @@ trait JavaRDDLike[T, This <: JavaRDDLike[T, This]] extends Serializable { ...@@ -507,9 +507,9 @@ trait JavaRDDLike[T, This <: JavaRDDLike[T, This]] extends Serializable {
} }
/** /**
* Returns the top K elements from this RDD using the * Returns the top k (largest) elements from this RDD using the
* natural ordering for T. * natural ordering for T.
* @param num the number of top elements to return * @param num k, the number of top elements to return
* @return an array of top elements * @return an array of top elements
*/ */
def top(num: Int): JList[T] = { def top(num: Int): JList[T] = {
...@@ -518,9 +518,9 @@ trait JavaRDDLike[T, This <: JavaRDDLike[T, This]] extends Serializable { ...@@ -518,9 +518,9 @@ trait JavaRDDLike[T, This <: JavaRDDLike[T, This]] extends Serializable {
} }
/** /**
* Returns the first K elements from this RDD as defined by * Returns the first k (smallest) elements from this RDD as defined by
* the specified Comparator[T] and maintains the order. * the specified Comparator[T] and maintains the order.
* @param num the number of top elements to return * @param num k, the number of elements to return
* @param comp the comparator that defines the order * @param comp the comparator that defines the order
* @return an array of top elements * @return an array of top elements
*/ */
...@@ -552,9 +552,9 @@ trait JavaRDDLike[T, This <: JavaRDDLike[T, This]] extends Serializable { ...@@ -552,9 +552,9 @@ trait JavaRDDLike[T, This <: JavaRDDLike[T, This]] extends Serializable {
} }
/** /**
* Returns the first K elements from this RDD using the * Returns the first k (smallest) elements from this RDD using the
* natural ordering for T while maintain the order. * natural ordering for T while maintain the order.
* @param num the number of top elements to return * @param num k, the number of top elements to return
* @return an array of top elements * @return an array of top elements
*/ */
def takeOrdered(num: Int): JList[T] = { def takeOrdered(num: Int): JList[T] = {
......
...@@ -1096,7 +1096,7 @@ abstract class RDD[T: ClassTag]( ...@@ -1096,7 +1096,7 @@ abstract class RDD[T: ClassTag](
} }
/** /**
* Returns the top K (largest) elements from this RDD as defined by the specified * 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]. This does the opposite of [[takeOrdered]]. For example:
* {{{ * {{{
* sc.parallelize(Seq(10, 4, 2, 12, 3)).top(1) * sc.parallelize(Seq(10, 4, 2, 12, 3)).top(1)
...@@ -1106,14 +1106,14 @@ abstract class RDD[T: ClassTag]( ...@@ -1106,14 +1106,14 @@ abstract class RDD[T: ClassTag](
* // returns Array(6, 5) * // returns Array(6, 5)
* }}} * }}}
* *
* @param num the number of top elements to return * @param num k, the number of top elements to return
* @param ord the implicit ordering for T * @param ord the implicit ordering for T
* @return an array of top elements * @return an array of top elements
*/ */
def top(num: Int)(implicit ord: Ordering[T]): Array[T] = takeOrdered(num)(ord.reverse) def top(num: Int)(implicit ord: Ordering[T]): Array[T] = takeOrdered(num)(ord.reverse)
/** /**
* Returns the first K (smallest) elements from this RDD as defined by the specified * Returns the first k (smallest) elements from this RDD as defined by the specified
* implicit Ordering[T] and maintains the ordering. This does the opposite of [[top]]. * implicit Ordering[T] and maintains the ordering. This does the opposite of [[top]].
* For example: * For example:
* {{{ * {{{
...@@ -1124,7 +1124,7 @@ abstract class RDD[T: ClassTag]( ...@@ -1124,7 +1124,7 @@ abstract class RDD[T: ClassTag](
* // returns Array(2, 3) * // returns Array(2, 3)
* }}} * }}}
* *
* @param num the number of top elements to return * @param num k, the number of elements to return
* @param ord the implicit ordering for T * @param ord the implicit ordering for T
* @return an array of top elements * @return an array of top elements
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment