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.
- Alphabetic
- By Inheritance
- Parameters
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Parameters(kind: Kind = BreadthFirst, direction: Direction = 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 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from Parameters toany2stringadd[Parameters] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (Parameters, B)
- Implicit
- This member is added by an implicit conversion from Parameters toArrowAssoc[Parameters] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val direction: Direction
- def ensuring(cond: (Parameters) => Boolean, msg: => Any): Parameters
- Implicit
- This member is added by an implicit conversion from Parameters toEnsuring[Parameters] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (Parameters) => Boolean): Parameters
- Implicit
- This member is added by an implicit conversion from Parameters toEnsuring[Parameters] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): Parameters
- Implicit
- This member is added by an implicit conversion from Parameters toEnsuring[Parameters] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): Parameters
- Implicit
- This member is added by an implicit conversion from Parameters toEnsuring[Parameters] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val kind: Kind
- val maxDepth: Int
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withDirection(direction: Direction): Parameters
Creates a new
Parametersbased onthisexcept for an updateddirection. - def withKind(kind: Kind): Parameters
Creates a new
Parametersbased onthisexcept for an updatedkind. - def withMaxDepth(maxDepth: Int): Parameters
Creates a new
Parametersbased onthisexcept for an updatedmaxDepth.
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Parameters toStringFormat[Parameters] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Parameters, B)
- Implicit
- This member is added by an implicit conversion from Parameters toArrowAssoc[Parameters] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Welcome to the Graph for Scala API reference. Some suggested entry points:
AnyGraphimmutable.Graphand its inner nodesmutable.Graphand its inner nodes.edgespackage and its subpackageshyperedgespackage and its subpackages.labeled edgespackagemultilabeled edgespackagelabeled hyperedgespackagemultilabeled hyperedgespackageordered labeled hyperedgespackageordered multilabeled hyperedgesobjectgenericpackage.GraphTraversalandTraverserInnerNode.RandomGraph.GraphGen.