Skip to content

Commit 10b3596

Browse files
committed
Clean up public API
1 parent ae36110 commit 10b3596

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

graphx/src/main/scala/org/apache/spark/graphx/EdgeRDD.scala

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import org.apache.spark.graphx.impl.EdgePartition
2929
* `EdgeRDD[ED, VD]` extends `RDD[Edge[ED]]` by storing the edges in columnar format on each
3030
* partition for performance. It may additionally store the vertex attributes associated with each
3131
* edge to provide the triplet view. Shipping of the vertex attributes is managed by
32-
* [[org.apache.spark.graphx.impl.ReplicatedVertexView]].
32+
* `impl.ReplicatedVertexView`.
3333
*/
3434
class EdgeRDD[@specialized ED: ClassTag, VD: ClassTag](
3535
val partitionsRDD: RDD[(PartitionID, EdgePartition[ED, VD])])
@@ -103,6 +103,7 @@ class EdgeRDD[@specialized ED: ClassTag, VD: ClassTag](
103103
*/
104104
def reverse: EdgeRDD[ED, VD] = mapEdgePartitions((pid, part) => part.reverse)
105105

106+
/** Removes all edges but those matching `epred` and where both vertices match `vpred`. */
106107
def filter(
107108
epred: EdgeTriplet[VD, ED] => Boolean,
108109
vpred: (VertexId, VD) => Boolean): EdgeRDD[ED, VD] = {

graphx/src/main/scala/org/apache/spark/graphx/VertexRDD.scala

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,10 @@ class VertexRDD[@specialized VD: ClassTag](
299299
new VertexRDD[VD2](parts)
300300
}
301301

302+
/**
303+
* Returns a new `VertexRDD` reflecting a reversal of all edge directions in the corresponding
304+
* [[EdgeRDD]].
305+
*/
302306
def reverseRoutingTables(): VertexRDD[VD] =
303307
this.mapVertexPartitions(vPart => vPart.withRoutingTable(vPart.routingTable.reverse))
304308

graphx/src/main/scala/org/apache/spark/graphx/impl/VertexPartitionBase.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ private[graphx] abstract class VertexPartitionBase[@specialized(Long, Int, Doubl
8383
}
8484

8585
/**
86-
* A typeclass for subclasses of [[VertexPartitionBase]] representing the ability to wrap them in a
86+
* A typeclass for subclasses of `VertexPartitionBase` representing the ability to wrap them in a
8787
* `VertexPartitionBaseOps`.
8888
*/
89-
trait VertexPartitionBaseOpsConstructor[T[X] <: VertexPartitionBase[X]] {
89+
private[graphx] trait VertexPartitionBaseOpsConstructor[T[X] <: VertexPartitionBase[X]] {
9090
def toOps[VD: ClassTag](partition: T[VD]): VertexPartitionBaseOps[VD, T]
9191
}

0 commit comments

Comments
 (0)