Class/Object

scalax.collection.GraphTraversal

Parameters

Related Docs: object Parameters | package GraphTraversal

Permalink

case class Parameters(kind: Kind = BreadthFirst, direction: Direction = Successors, maxDepth: Int = 0) extends Product with Serializable

Parameters to control traversals.

kind

The kind of traversal including breadth-first and depth-fist search.

direction

Determines which connected nodes the traversal has to follow. The default value is Successors.

maxDepth

A positive value to limit the number of layers for BFS respectively the number of consecutive child visits before siblings are visited for DFS. 0 - the default - indicates that the traversal should have an unlimited depth.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Parameters
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Parameters(kind: Kind = BreadthFirst, direction: Direction = Successors, maxDepth: Int = 0)

    Permalink

    kind

    The kind of traversal including breadth-first and depth-fist search.

    direction

    Determines which connected nodes the traversal has to follow. The default value is Successors.

    maxDepth

    A positive value to limit the number of layers for BFS respectively the number of consecutive child visits before siblings are visited for DFS. 0 - the default - indicates that the traversal should have an unlimited depth.

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Parameters to any2stringadd[Parameters] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Parameters, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Parameters to ArrowAssoc[Parameters] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val direction: Direction

    Permalink

    Determines which connected nodes the traversal has to follow.

    Determines which connected nodes the traversal has to follow. The default value is Successors.

  9. def ensuring(cond: (Parameters) ⇒ Boolean, msg: ⇒ Any): Parameters

    Permalink
    Implicit information
    This member is added by an implicit conversion from Parameters to Ensuring[Parameters] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (Parameters) ⇒ Boolean): Parameters

    Permalink
    Implicit information
    This member is added by an implicit conversion from Parameters to Ensuring[Parameters] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): Parameters

    Permalink
    Implicit information
    This member is added by an implicit conversion from Parameters to Ensuring[Parameters] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): Parameters

    Permalink
    Implicit information
    This member is added by an implicit conversion from Parameters to Ensuring[Parameters] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Permalink
    Definition Classes
    AnyRef

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Parameters to StringFormat[Parameters] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. val kind: Kind

    Permalink

    The kind of traversal including breadth-first and depth-fist search.

  19. val maxDepth: Int

    Permalink

    A positive value to limit the number of layers for BFS respectively the number of consecutive child visits before siblings are visited for DFS.

    A positive value to limit the number of layers for BFS respectively the number of consecutive child visits before siblings are visited for DFS. 0 - the default - indicates that the traversal should have an unlimited depth.

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  24. final def wait(): Unit

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

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

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

  26. final def wait(arg0: Long): Unit

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

  27. def withDirection(direction: Direction): Parameters

    Permalink

    Creates a new Parameters based on this except for an updated direction.

  28. def withKind(kind: Kind): Parameters

    Permalink

    Creates a new Parameters based on this except for an updated kind.

  29. def withMaxDepth(maxDepth: Int): Parameters

    Permalink

    Creates a new Parameters based on this except for an updated maxDepth.

  30. def →[B](y: B): (Parameters, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Parameters to ArrowAssoc[Parameters] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Parameters to any2stringadd[Parameters]

Inherited by implicit conversion StringFormat from Parameters to StringFormat[Parameters]

Inherited by implicit conversion Ensuring from Parameters to Ensuring[Parameters]

Inherited by implicit conversion ArrowAssoc from Parameters to ArrowAssoc[Parameters]

Ungrouped