Packages

  • package root

    Welcome to the Graph for Scala API reference.

    Welcome to the Graph for Scala API reference. Some suggested navigation entry points:

    Definition Classes
    root
  • package scalax
    Definition Classes
    root
  • package collection

    Contains the base traits and objects needed to use Graph for Scala.

    Contains the base traits and objects needed to use Graph for Scala.

    See also the Graph for Scala Core User Guide.

    Definition Classes
    scalax
  • package config
    Definition Classes
    collection
  • package edge

    Predefined edges.

    Predefined edges.

    While basic edge types are defined in the object GraphEdge, the predefined edges in this package cover the following categories (prefixes, shortcuts):

    weighted (W, %), key-weighted (Wk, %#), labeled (L, +), key-labeled (Lk, +#), weighted and labeled (WL, %+), key-weighted and labeled (WkL, %#+), weighted and key-labeled (WLk, %+#) and key-weighted and key-labeled (WkLk, %#+#).

    These predefined edges provide alternatives for any edge extension taking the burden from the user to implement his/her custom edge class - but baring the disadvantage that user edge attributes must be part of a label class as opposed to being part of the edge class directly. It may also serve as a source for looking up how to implement custom edge classes.

    Definition Classes
    collection
  • package generator

    This package helps you to create random graphs with predefined metrics.

    This package helps you to create random graphs with predefined metrics. It is not only possible to create random graph instances but also Scalacheck generators.

    Definition Classes
    collection
  • package generic
    Definition Classes
    collection
  • package immutable
    Definition Classes
    collection
  • package interfaces
    Definition Classes
    collection
  • package mutable
    Definition Classes
    collection
  • Graph
  • GraphBase
  • GraphDegree
  • GraphEdge
  • GraphLike
  • GraphPredef
  • GraphTraversal
  • GraphTraversalImpl
  • State
  • TraverserImpl
o

scalax.collection

GraphPredef

object GraphPredef

This object serves as a container for several Graph-related definitions like parameter-types and implicit conversions.

You will usually simply import all its members along with the members of InnerEdgeParam:

import scalax.collection.GraphPredef._, scalax.collection.InnerEdgeParam._
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GraphPredef
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type DiEdgeLikeIn[+N] = DiEdgeLike[N] with EdgeCopy[DiEdgeLike] with OuterEdge[N, DiEdgeLike]

    Denotes all directed edge types for the E type parameter of a Graph.

    Denotes all directed edge types for the E type parameter of a Graph. Supplying this type as the actual type parameter allows to include any kind of directed edges such as directed hyper-edges and directed edges.

  2. type DiHyperEdgeLikeIn[+N] = DiHyperEdgeLike[N] with EdgeCopy[DiHyperEdgeLike] with OuterEdge[N, DiHyperEdgeLike]

    Denotes all directed edge types for the E type parameter of a Graph.

    Denotes all directed edge types for the E type parameter of a Graph. Supplying this type as the actual type parameter allows to include any kind of directed edges such as directed hyper-edges and directed edges.

  3. implicit final class EdgeAssoc[N1] extends AnyVal
  4. type EdgeLikeIn[+N] = EdgeLike[N] with EdgeCopy[EdgeLike] with OuterEdge[N, EdgeLike]

    The most generic type for the E type parameter of a Graph.

    The most generic type for the E type parameter of a Graph. Supplying this type as the actual type parameter allows to include any kind of edges such as hyper-edges, undirected and directed edges.

  5. sealed trait EdgeParam extends AnyRef
  6. implicit final class HyperEdgeAssoc[NOld] extends AnyVal
  7. sealed trait InParam[+N, +E[X <: N] <: EdgeLike[X]] extends Param[N, E]

    N

    the type of the nodes (vertices) this graph is passed to by the user.

    E

    the kind of the edges (links) this graph is passed to by the user.

  8. trait InnerEdgeParam[+NI, +EI[X <: NI] <: EdgeLike[X], +NO <: InnerNodeParam[NI], +EO[X <: NO] <: EdgeLike[X]] extends OutParam[NI, EI] with EdgeParam

    NI

    the type of the nodes the graph is passed to.

    EI

    the kind of the edges the graph is passed to.

    NO

    the type of the nodes created internally.

    EO

    the kind of the edges created internally.

  9. trait InnerNodeParam[+NI] extends OutParam[NI, Nothing] with NodeParam[NI]

    NI

    the type of the nodes (vertices) this graph is passed to by the user.

  10. trait NodeParam[+N] extends AnyRef
  11. sealed trait OutParam[+NO, +EO[X <: NO] <: EdgeLike[X]] extends Param[NO, EO]
  12. trait OuterEdge[+NI, +EI[X <: NI] <: EdgeLike[X]] extends InParam[NI, EI] with EdgeParam

    Classes implementing EdgeLike must be instantiated mixing in this trait.

    Classes implementing EdgeLike must be instantiated mixing in this trait. This is a precondition for passing edge-instances to a Graph.

    NI

    the type of the nodes (vertices) this graph is passed to by the user.

    EI

    the kind of the edges (links) this graph is passed to by the user.

  13. type OuterElem[N, +E[X <: N] <: EdgeLike[X]] = InParam[N, E]

    Same as InParam.

  14. case class OuterNode[NI](value: NI) extends InParam[NI, Nothing] with NodeParam[NI] with Product with Serializable

    NI

    the type of the nodes (vertices) this graph is passed to by the user.

  15. sealed trait Param[+N, +E[X <: N] <: EdgeLike[X]] extends AnyRef

    This algebraic type includes outer and inner nodes and edges.

    This algebraic type includes outer and inner nodes and edges. As such it serves as the type parameter to SetLike extending Graph.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit def anyToNode[N](n: N): OuterNode[N]
    Annotations
    @inline()
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. implicit def edgeSetToOuter[N, E[X] <: EdgeLikeIn[X]](edges: Graph.EdgeSetT): Iterable[E[N]]
  8. implicit def edgeSetToSeq[N, E[X] <: EdgeLikeIn[X]](edges: Graph.EdgeSetT): Seq[OutParam[N, E]]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def nodePredicate[NI, EI[X <: NI] <: EdgeLike[X], NO <: InnerNodeParam[NI], EO[X <: NO] <: EdgeLike[X]](pred: (NI) ⇒ Boolean): (Param[NI, EI]) ⇒ Boolean
  17. implicit def nodeSetToOuter[N, E[X] <: EdgeLikeIn[X]](nodes: Graph.NodeSetT): Iterable[N]
  18. implicit def nodeSetToSeq[N, E[X] <: EdgeLikeIn[X]](nodes: Graph.NodeSetT): Seq[OutParam[N, E]]
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. implicit def predicateToNodePredicate[NI, EI[X <: NI] <: EdgeLike[X], NO <: InnerNodeParam[NI], EC[X <: NO] <: EdgeLike[X]](p: (NI) ⇒ Boolean): (Param[NI, EI]) ⇒ Boolean
    Annotations
    @inline()
  22. implicit def seqToGraphParam[N, E[X <: N] <: EdgeLikeIn[X]](s: Seq[N]): Seq[InParam[N, E]]
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  28. object InnerEdgeParam
  29. object InnerNodeParam
  30. object Param

Inherited from AnyRef

Inherited from Any

Ungrouped