Packages

trait GraphCompanion[+CC[N, E[+X] <: EdgeLikeIn[X]] <: Graph[N, E[X]] with GraphLike[N, E[X], CC]] extends GraphCompanionCanBuildFrom[CC]

Methods common to Graph companion objects in the core module.

CC

the kind of type of the graph that is to become the companion class/trait of the object extending this trait.

Linear Supertypes
GraphCompanionCanBuildFrom[CC], AnyRef, Any
Known Subclasses
Graph, GraphCoreCompanion, ImmutableGraphCompanion, MutableGraphCompanion, DefaultGraphImpl, Graph, DefaultGraphImpl, Graph
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GraphCompanion
  2. GraphCompanionCanBuildFrom
  3. AnyRef
  4. Any
Implicitly
  1. by ChainingOps
  2. by EdgeAssoc
  3. by anyToNode
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Coll = CC[Nothing, Nothing]
    Attributes
    protected
  2. abstract type Config <: GraphConfig

    Type of configuration required for a specific Graph companion.

  3. class GraphCanBuildFrom[N, E[+X] <: EdgeLikeIn[X]] extends BuildFrom[Coll, Param[N, E], CC[N, E]]
    Definition Classes
    GraphCompanionCanBuildFrom

Abstract Value Members

  1. abstract def defaultConfig: Config

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

  2. abstract def empty[N, E[+X] <: EdgeLikeIn[X]](implicit edgeT: ClassTag[E[N]], config: Config): CC[N, E]

    Creates an empty Graph instance.

  3. abstract def from[N, E[+X] <: EdgeLikeIn[X]](nodes: Iterable[N] = Nil, edges: Iterable[E[N]])(implicit edgeT: ClassTag[E[N]], config: Config): CC[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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toany2stringadd[GraphCompanion[CC]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GraphCompanion[CC], B)
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toArrowAssoc[GraphCompanion[CC]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def apply[N, E[+X] <: EdgeLikeIn[X]](elems: Param[N, E]*)(implicit edgeT: ClassTag[E[N]], config: Config): CC[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.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def ensuring(cond: (GraphCompanion[CC]) => Boolean, msg: => Any): GraphCompanion[CC]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toEnsuring[GraphCompanion[CC]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (GraphCompanion[CC]) => Boolean): GraphCompanion[CC]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toEnsuring[GraphCompanion[CC]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): GraphCompanion[CC]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toEnsuring[GraphCompanion[CC]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): GraphCompanion[CC]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toEnsuring[GraphCompanion[CC]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def fill[N, E[+X] <: EdgeLikeIn[X]](nr: Int)(elem: => Param[N, E])(implicit edgeT: ClassTag[E[N]], config: Config): CC[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.

  16. def from[N, E[+X] <: EdgeLikeIn[X]](elems: IterableOnce[Param[N, E]])(implicit edgeT: ClassTag[E[N]], config: Config): CC[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.

  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def isDefined: Boolean
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toOuterNode[GraphCompanion[CC]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  20. final def isEdge: Boolean
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toOuterNode[GraphCompanion[CC]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  21. def isIn: Boolean
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toOuterNode[GraphCompanion[CC]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    InParam → Param
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def isNode: Boolean
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toOuterNode[GraphCompanion[CC]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  24. final def isOut: Boolean
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toOuterNode[GraphCompanion[CC]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  25. val n1: GraphCompanion[CC]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toEdgeAssoc[GraphCompanion[CC]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def newBuilder[N, E[+X] <: EdgeLikeIn[X]](implicit edgeT: ClassTag[E[N]], config: Config): Builder[Param[N, E], CC[N, E]]
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def pipe[B](f: (GraphCompanion[CC]) => B): B
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toChainingOps[GraphCompanion[CC]] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  31. def productElementNames: Iterator[String]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toOuterNode[GraphCompanion[CC]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Product
  32. val self: GraphCompanion[CC]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toChainingOps[GraphCompanion[CC]] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  33. def stringPrefix: String
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toOuterNode[GraphCompanion[CC]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def tap[U](f: (GraphCompanion[CC]) => U): GraphCompanion[CC]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toChainingOps[GraphCompanion[CC]] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. val value: GraphCompanion[CC]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toOuterNode[GraphCompanion[CC]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    OuterNode → NodeParam
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. def ~[N >: N1](n2: N): UnDiEdge[N]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toEdgeAssoc[GraphCompanion[CC]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  42. def ~>[N >: N1](n2: N): DiEdge[N]
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toEdgeAssoc[GraphCompanion[CC]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()

Shadowed Implicit Value Members

  1. def toString(): String
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toOuterNode[GraphCompanion[CC]] performed by method anyToNode in scalax.collection.GraphPredef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (graphCompanion: OuterNode[GraphCompanion[CC]]).toString()
    Definition Classes
    NodeParam → AnyRef → Any

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toStringFormat[GraphCompanion[CC]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (GraphCompanion[CC], B)
    Implicit
    This member is added by an implicit conversion from GraphCompanion[CC] toArrowAssoc[GraphCompanion[CC]] 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.

Inherited from GraphCompanionCanBuildFrom[CC]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion ChainingOps fromGraphCompanion[CC] to ChainingOps[GraphCompanion[CC]]

Inherited by implicit conversion EdgeAssoc fromGraphCompanion[CC] to EdgeAssoc[GraphCompanion[CC]]

Inherited by implicit conversion anyToNode fromGraphCompanion[CC] to OuterNode[GraphCompanion[CC]]

Inherited by implicit conversion any2stringadd fromGraphCompanion[CC] to any2stringadd[GraphCompanion[CC]]

Inherited by implicit conversion StringFormat fromGraphCompanion[CC] to StringFormat[GraphCompanion[CC]]

Inherited by implicit conversion Ensuring fromGraphCompanion[CC] to Ensuring[GraphCompanion[CC]]

Inherited by implicit conversion ArrowAssoc fromGraphCompanion[CC] to ArrowAssoc[GraphCompanion[CC]]

Ungrouped