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

object Graph extends GraphCoreCompanion[Graph] with Serializable

The main companion object for immutable graphs.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Graph
  2. Serializable
  3. Serializable
  4. GraphCoreCompanion
  5. GraphCompanion
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Coll = Graph[_, Nothing]
    Attributes
    protected[this]
    Definition Classes
    GraphCompanion
  2. type Config = CoreConfig

    Type of configuration required for a specific Graph companion.

    Type of configuration required for a specific Graph companion.

    Definition Classes
    GraphCoreCompanionGraphCompanion
  3. class GraphCanBuildFrom[N, E[X] <: EdgeLikeIn[X]] extends CanBuildFrom[Coll, Param[N, E], CC[N, E]]
    Definition Classes
    GraphCompanion

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. def apply[N, E[X] <: EdgeLikeIn[X]](elems: Param[N, E]*)(implicit edgeT: ClassTag[E[N]], config: Config = defaultConfig): Graph[N, E]

    Creates a Graph with a node set built from all nodes in elems including edge ends and with an edge set containing all edges in elems.

    Creates a Graph with a node set built from all nodes in elems including edge ends and with an edge set containing all edges in elems. Duplicate exclusion takes place on the basis of values returned by hashCode of the supplied nodes and edges. The hash-code value of an edge is determined by its ends and optionally by other edge components such as weight or label. To include non-node edge components in the hash-code of an edge make use of any of the predefined key-weighted/key-labeled edges or mix ExtendedKey into your custom edge class.

    elems

    sequence of nodes and/or edges in an arbitrary order

    returns

    A new graph instance containing the nodes and edges derived from elems.

    Definition Classes
    GraphCoreCompanionGraphCompanion
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. implicit def cbfDi[N, E[X] <: EdgeLikeIn[X]](implicit edgeT: ClassTag[E[N]], config: Config = defaultConfig): GraphCanBuildFrom[N, E] with CanBuildFrom[Graph[_, DiEdge], Param[N, E], Graph[N, E]]
  7. implicit def cbfUnDi[N, E[X] <: EdgeLikeIn[X]](implicit edgeT: ClassTag[E[N]], config: Config = defaultConfig): GraphCanBuildFrom[N, E] with CanBuildFrom[Graph[_, UnDiEdge], Param[N, E], Graph[N, E]]
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def defaultConfig: CoreConfig

    The default configuration to be used in absence of a user-supplied configuration.

    The default configuration to be used in absence of a user-supplied configuration.

    Definition Classes
    GraphCoreCompanionGraphCompanion
  10. def empty[N, E[X] <: EdgeLikeIn[X]](implicit edgeT: ClassTag[E[N]], config: Config = defaultConfig): Graph[N, E]

    Creates an empty Graph instance.

    Creates an empty Graph instance.

    Definition Classes
    GraphGraphCoreCompanionGraphCompanion
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def fill[N, E[X] <: EdgeLikeIn[X]](nr: Int)(elem: ⇒ Param[N, E])(implicit edgeT: ClassTag[E[N]], config: Config = defaultConfig): Graph[N, E]

    Produces a graph containing the results of some element computation a number of times.

    Produces a graph containing the results of some element computation a number of times. Duplicate exclusion takes place on the basis of values returned by hashCode of the supplied nodes and edges. The hash-code value of an edge is determined by its ends and optionally by other edge components such as weight or label. To include non-node edge components in the hash-code of an edge make use of any of the predefined key-weighted/key-labeled edges or mix ExtendedKey into your custom edge class.

    nr

    the number of elements to be contained in the graph.

    elem

    the element computation returning nodes or edges nr times.

    returns

    A graph that contains the results of nr evaluations of elem.

    Definition Classes
    GraphCoreCompanionGraphCompanion
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def from[N, E[X] <: EdgeLikeIn[X]](nodes: Traversable[N] = Nil, edges: Traversable[E[N]])(implicit edgeT: ClassTag[E[N]], config: Config = defaultConfig): Graph[N, E]

    Produces a graph with a node set containing all nodes and edge ends in edges and with an edge set containing all edges but duplicates.

    Produces a graph with a node set containing all nodes and edge ends in edges and with an edge set containing all edges but duplicates. Duplicate exclusion takes place on the basis of values returned by hashCode of the supplied nodes and edges. The hash-code value of an edge is determined by its ends and optionally by other edge components such as weight or label. To include non-node edge components in the hash-code of an edge make use of any of the predefined key-weighted/key-labeled edges or mix ExtendedKey into your custom edge class.

    nodes

    the isolated and optionally any other non-isolated nodes to be included in the node set of the graph to be created.

    edges

    all edges to be included in the edge set of the graph to be created. Edge ends will be added to the node set automatically.

    returns

    A new graph instance containing nodes and all edge ends and edges.

    Definition Classes
    GraphGraphCoreCompanionGraphCompanion
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def newBuilder[N, E[X] <: EdgeLikeIn[X]](implicit edgeT: ClassTag[E[N]], config: Config): Builder[Param[N, E], immutable.Graph[N, E]]
    Definition Classes
    GraphGraphCompanion
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  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( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from GraphCoreCompanion[Graph]

Inherited from GraphCompanion[Graph]

Inherited from AnyRef

Inherited from Any

Ungrouped