Class

com.twitter.cassovary.graph.GraphUtils

RandomWalkParams

Related Doc: package GraphUtils

Permalink

case class RandomWalkParams(numSteps: Long, resetProbability: Double, maxNumEdgesThresh: Option[Int] = None, numTopPathsPerNode: Option[Int] = None, maxDepth: Option[Int] = None, visitSameNodeOnce: Boolean = false, dir: GraphDir = GraphDir.OutDir, stable: Boolean = false, filterHomeNodeByNumEdges: Boolean = false) extends Product with Serializable

Parameters of a walk (such as a random walk, or a breadth first walk).

numSteps

number of steps to take in the walk

resetProbability

the probability with which to reset back to startNodeId. Must lie between 0.0 and 1.0, both inclusive. Ignored for non-random walks

maxNumEdgesThresh

Max number of edges allowed for a node beyond which the next random step is startNodeId regardless of anything else

numTopPathsPerNode

the number of top paths to node to maintain, None if we don't want to maintain them at all

maxDepth

the maximum depth to visit in depth-related search (e.g. startNodeId has depth 0, its immediate neighbors have depth 1, etc.). None if we don't want to maintain them at all

visitSameNodeOnce

if true, the walk would only visit the same node once and will likely restart to a start node when visiting the same node twice

dir

traverse out-direction or in-direction

stable

if true, use a fixed random number generator in the random walk

filterHomeNodeByNumEdges

if true, home node will be checked for maxNumEdgesThresh when visited during random walk

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RandomWalkParams
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RandomWalkParams(numSteps: Long, resetProbability: Double, maxNumEdgesThresh: Option[Int] = None, numTopPathsPerNode: Option[Int] = None, maxDepth: Option[Int] = None, visitSameNodeOnce: Boolean = false, dir: GraphDir = GraphDir.OutDir, stable: Boolean = false, filterHomeNodeByNumEdges: Boolean = false)

    Permalink

    numSteps

    number of steps to take in the walk

    resetProbability

    the probability with which to reset back to startNodeId. Must lie between 0.0 and 1.0, both inclusive. Ignored for non-random walks

    maxNumEdgesThresh

    Max number of edges allowed for a node beyond which the next random step is startNodeId regardless of anything else

    numTopPathsPerNode

    the number of top paths to node to maintain, None if we don't want to maintain them at all

    maxDepth

    the maximum depth to visit in depth-related search (e.g. startNodeId has depth 0, its immediate neighbors have depth 1, etc.). None if we don't want to maintain them at all

    visitSameNodeOnce

    if true, the walk would only visit the same node once and will likely restart to a start node when visiting the same node twice

    dir

    traverse out-direction or in-direction

    stable

    if true, use a fixed random number generator in the random walk

    filterHomeNodeByNumEdges

    if true, home node will be checked for maxNumEdgesThresh when visited during random walk

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val dir: GraphDir

    Permalink

    traverse out-direction or in-direction

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. val filterHomeNodeByNumEdges: Boolean

    Permalink

    if true, home node will be checked for maxNumEdgesThresh when visited during random walk

  9. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. val maxDepth: Option[Int]

    Permalink

    the maximum depth to visit in depth-related search (e.g.

    the maximum depth to visit in depth-related search (e.g. startNodeId has depth 0, its immediate neighbors have depth 1, etc.). None if we don't want to maintain them at all

  13. val maxNumEdgesThresh: Option[Int]

    Permalink

    Max number of edges allowed for a node beyond which the next random step is startNodeId regardless of anything else

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. val numSteps: Long

    Permalink

    number of steps to take in the walk

  18. val numTopPathsPerNode: Option[Int]

    Permalink

    the number of top paths to node to maintain, None if we don't want to maintain them at all

  19. val pruneFn: (Node) ⇒ Boolean

    Permalink

    The pruning function that guides the pruning of a random walk.

    The pruning function that guides the pruning of a random walk. If the random walk reached a node, it resets to the starting node if pruneFn returns true for that node. Can be overridden by subclasses.

  20. lazy val randNumGen: Random

    Permalink
  21. val resetProbability: Double

    Permalink

    the probability with which to reset back to startNodeId.

    the probability with which to reset back to startNodeId. Must lie between 0.0 and 1.0, both inclusive. Ignored for non-random walks

  22. val stable: Boolean

    Permalink

    if true, use a fixed random number generator in the random walk

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

    Permalink
    Definition Classes
    AnyRef
  24. val visitSameNodeOnce: Boolean

    Permalink

    if true, the walk would only visit the same node once and will likely restart to a start node when visiting the same node twice

  25. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped