scalax.collection.GraphTraversal

Parameters

case class Parameters(kind: Kind = GraphTraversal.this.BreadthFirst, direction: Direction = GraphTraversal.this.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 limits 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 meaning that it will be continued either until it's canceled by nodeVisitor or until all nodes have been visited.

Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

    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 limits 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 meaning that it will be continued either until it's canceled by nodeVisitor or until all nodes have been visited.

Value Members

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

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

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Parameters to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Parameters, B)

    Implicit information
    This member is added by an implicit conversion from Parameters to ArrowAssoc[Parameters] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val direction: Direction

    Determines which connected nodes the traversal has to follow.

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

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

    Implicit information
    This member is added by an implicit conversion from Parameters to Ensuring[Parameters] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Parameters) ⇒ Boolean): Parameters

    Implicit information
    This member is added by an implicit conversion from Parameters to Ensuring[Parameters] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Parameters

    Implicit information
    This member is added by an implicit conversion from Parameters to Ensuring[Parameters] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Parameters

    Implicit information
    This member is added by an implicit conversion from Parameters to Ensuring[Parameters] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Parameters to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

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

    Definition Classes
    Any
  20. val kind: Kind

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

  21. val maxDepth: Int

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

    A positive value limits 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 meaning that it will be continued either until it's canceled by nodeVisitor or until all nodes have been visited.

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

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  26. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def withDirection(direction: Direction): Parameters

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

  30. def withKind(kind: Kind): Parameters

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

  31. def withMaxDepth(maxDepth: Int): Parameters

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

  32. def [B](y: B): (Parameters, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Parameters to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (parameters: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Parameters to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (parameters: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Parameters

    Implicit information
    This member is added by an implicit conversion from Parameters to ArrowAssoc[Parameters] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (parameters: ArrowAssoc[Parameters]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Parameters

    Implicit information
    This member is added by an implicit conversion from Parameters to Ensuring[Parameters] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (parameters: Ensuring[Parameters]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

Inherited by implicit conversion any2stringfmt from Parameters to StringFormat

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

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

Ungrouped