Node

Abstract Value Members

abstract val id: Int

The unique id of this node.
abstract def inboundNodes(): Seq[Int]

Returns ids of all nodes pointing to this node.
abstract def outboundNodes(): Seq[Int]

returns
all nodes this node points to.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def containsNode(nodeIds: Seq[Int], queryNodeId: Int): Boolean

The default implementation just walks the array but users likely want to override to provide a more optimized implementation.
The default implementation just walks the array but users likely want to override to provide a more optimized implementation.
returns
a boolean indicating Whether nodeIds contains queryNodeId.

Attributes
protected
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def inboundCount: Int

returns
the total number of inbound edges.
def inboundNodes(max: Int): Seq[Int]

Returns up to max nodes that this node points to.
Returns up to max nodes that this node points to.
max
the max number of nodes it needs
returns
a sequence of inboundNode ids
def isInboundNode(nodeId: Int): Boolean

Returns true if the given nodeId points to this node.
Returns true if the given nodeId points to this node.
nodeId
host node id
returns
a set of random node id
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isNeighbor(dir: GraphDir, nodeId: Int): Boolean

whether nodeId is a neighbor in the allowing direction dir
whether nodeId is a neighbor in the allowing direction dir
dir
the direction (inbound or outbound) that the method is applied to.
nodeId
the target node id.
returns
a boolean indicating whether nodeId is in the home node's neighbors.
def isOutboundNode(nodeId: Int): Boolean

Returns true if the this node point to the given node.
Returns true if the this node point to the given node.
nodeId
home node id
returns
a boolean indicating whether outbound nodes contains nodeId.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def neighborCount(dir: GraphDir): Int

the neighbor count in the allowing direction dir
the neighbor count in the allowing direction dir
dir
the direction (inbound or outbound) that the method is applied to.
returns
the number of neighbors in the direction of dir.
def neighborIds(dir: GraphDir, max: Int): Seq[Int]

A method that returns max nodes of either inbound or outbound allowing direction dir.
A method that returns max nodes of either inbound or outbound allowing direction dir.
dir
the direction (inbound or outbound) that the method is applied to.
max
the maximum number of neighbors needed.
returns
a sequence of inbound or outbound neighbors.
def neighborIds(dir: GraphDir): Seq[Int]

A method that return either inbound or outbound allowing direction dir.
A method that return either inbound or outbound allowing direction dir.
dir
the direction (inbound or outbound) that the method is applied to.
returns
a sequence of inbound or outbound neighbors.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def outboundCount: Int

returns
the total number of outbound edges.
def outboundNodes(max: Int): Seq[Int]

max
the maximum number of outBound nodes needed.
returns
up to max nodes that this node points to.
def randomInboundNode(rnd: Random): Option[Int]

Returns a random node from the set of nodes that points to this node or else None if this node has no inbound edges, using the supplied random number generator rnd.
Returns a random node from the set of nodes that points to this node or else None if this node has no inbound edges, using the supplied random number generator rnd.
rnd
user defined random number generator
returns
a random node id
def randomInboundNode: Option[Int]

Returns a random node from the set of nodes that points to this node or else None if this node has no inbound edges.
Returns a random node from the set of nodes that points to this node or else None if this node has no inbound edges.
The default implementation picks a random node from inboundNodes()* so subclasses should consider overriding this method if the Seq sequence they produce is not a IndexedSeq.
returns
a sequence of random node ids
def randomInboundNodeSet(numResults: Int, rnd: Random): Seq[Int]

Returns a random sample of size at most numResults from the set of nodes that point to this node using the supplied random number generator rnd.
Returns a random sample of size at most numResults from the set of nodes that point to this node using the supplied random number generator rnd.
numResults
max number of random nodes needed
rnd
user defined random number generator
returns
a set of random node id
def randomNeighbor(dir: GraphDir, rnd: Random): Option[Int]

A method that returns a random node in the allowing direction dir, using the supplied random number generator rnd.
A method that returns a random node in the allowing direction dir, using the supplied random number generator rnd.
dir
the direction (inbound or outbound) that the method is applied to.
rnd
a user defined random number generator.
returns
a random neighbor or None if no neighbor is in the direction dir.
def randomNeighbor(dir: GraphDir): Option[Int]

A method that returns a random node in the allowing direction dir.
A method that returns a random node in the allowing direction dir.
dir
the direction (inbound or outbound) that the method is applied to.
returns
a random neighbor or None if no neighbor is in the direction dir.
def randomNeighborSet(numResults: Int, dir: GraphDir, rnd: Random): Seq[Int]

A method that returns a set of either inbound or outbound nodes of size numResults, in the allowing direction dir, using the supplied random number generator rnd.
A method that returns a set of either inbound or outbound nodes of size numResults, in the allowing direction dir, using the supplied random number generator rnd.
numResults
maximum number of neighbors needed.
dir
the direction (inbound or outbound) that the method is applied to.
rnd
a user defined random number generator.
returns
a set of random neighbors.
def randomNeighborSet(numResults: Int, dir: GraphDir): Seq[Int]

A method that returns a random node of size numResults in the allowing direction dir, using the supplied random number generator rnd.
A method that returns a random node of size numResults in the allowing direction dir, using the supplied random number generator rnd.
numResults
maximum number of neighbors needed.
dir
the direction (inbound or outbound) that the method is applied to.
returns
a set of random neighbors.
def randomNode(nodeIds: Seq[Int], rnd: Random): Option[Int]

rnd
a user defined random number generator.
returns
a random node from nodeIds using a supplied random number generator rnd.

Attributes
protected
def randomNodeSet(nodeIds: Seq[Int], numResults: Int, rnd: Random): Array[Int]

Random sampling with replacement.
Random sampling with replacement. Choose a set of random nodes of size numResults from nodeIds using a supplied random number generator rnd.
numResults
maximum number of nodes needed.
rnd
a user defined random number generator.
returns
a random node from nodeIds using a supplied random number generator rnd.

Attributes
protected
def randomOutboundNode(rnd: Random): Option[Int]

Returns a random node from the set of nodes that this node points to or else None if this node has no outbound edges, using the supplied random number generator rnd.
Returns a random node from the set of nodes that this node points to or else None if this node has no outbound edges, using the supplied random number generator rnd.
rnd
a user defined random number generator.
returns
a random node that this node points to.
def randomOutboundNode: Option[Int]

Returns a random node from the set of nodes that this node points to or else None if this node has no outbound edges.
Returns a random node from the set of nodes that this node points to or else None if this node has no outbound edges.
The default implementation picks a random node from outboundNodes()* so subclasses should consider overriding this method if the Seq sequence they produce is not a lazy IndexedSeq.
returns
a random node that this node points to.
def randomOutboundNodeSet(numResults: Int, rnd: Random): Seq[Int]

Returns a random sample of size at most numResults from the set of nodes that this node points to using the supplied random number generator rnd.
Returns a random sample of size at most numResults from the set of nodes that this node points to using the supplied random number generator rnd.
rnd
a user defined random number generator.
returns
a set of random nodes that this node points to.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Override toString to make debugging easier.
Override toString to make debugging easier. It prints max of 10 neighbors in each direction.

Definition Classes
Node → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait Node extends AnyRef

Abstract Value Members

abstract val id: Int

abstract def inboundNodes(): Seq[Int]

abstract def outboundNodes(): Seq[Int]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def containsNode(nodeIds: Seq[Int], queryNodeId: Int): Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def inboundCount: Int

def inboundNodes(max: Int): Seq[Int]

def isInboundNode(nodeId: Int): Boolean

final def isInstanceOf[T0]: Boolean

def isNeighbor(dir: GraphDir, nodeId: Int): Boolean

def isOutboundNode(nodeId: Int): Boolean

final def ne(arg0: AnyRef): Boolean

def neighborCount(dir: GraphDir): Int

def neighborIds(dir: GraphDir, max: Int): Seq[Int]

def neighborIds(dir: GraphDir): Seq[Int]

final def notify(): Unit

final def notifyAll(): Unit

def outboundCount: Int

def outboundNodes(max: Int): Seq[Int]

def randomInboundNode(rnd: Random): Option[Int]

def randomInboundNode: Option[Int]

def randomInboundNodeSet(numResults: Int, rnd: Random): Seq[Int]

def randomNeighbor(dir: GraphDir, rnd: Random): Option[Int]

def randomNeighbor(dir: GraphDir): Option[Int]

def randomNeighborSet(numResults: Int, dir: GraphDir, rnd: Random): Seq[Int]

def randomNeighborSet(numResults: Int, dir: GraphDir): Seq[Int]

def randomNode(nodeIds: Seq[Int], rnd: Random): Option[Int]

def randomNodeSet(nodeIds: Seq[Int], numResults: Int, rnd: Random): Array[Int]

def randomOutboundNode(rnd: Random): Option[Int]

def randomOutboundNode: Option[Int]

def randomOutboundNodeSet(numResults: Int, rnd: Random): Seq[Int]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped