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 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
  • object CBase

    Base traits for custom edges - hence the C prefix.

    Base traits for custom edges - hence the C prefix. Note that custom edges need only to mix in CBase.Attributes when importing by fromJson.

    Definition Classes
    edge
  • Attributes
  • CEdgeCompanion
  • CEdgeCompanionBase
  • CHyperEdgeCompanion

trait CEdgeCompanion[E[+X] <: CEdgeBound[X]] extends CEdgeCompanionBase[E]

To be mixed in by custom edge companion objects.

Linear Supertypes
CEdgeCompanionBase[E], EdgeCompanionBase[E], Serializable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CEdgeCompanion
  2. CEdgeCompanionBase
  3. EdgeCompanionBase
  4. Serializable
  5. AnyRef
  6. 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. abstract type P <: Product
    Attributes
    protected[collection]
    Definition Classes
    CEdgeCompanionBase

Abstract Value Members

  1. abstract def newEdge[N](nodes: Product, attr: P): E[N] with EdgeCopy[E]

    Must return an instance of the custom edge which is achieved by projecting the elements of attr and passing them as single arguments to the custom edge constructor.

    Must return an instance of the custom edge which is achieved by projecting the elements of attr and passing them as single arguments to the custom edge constructor.

    Attributes
    protected

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 CEdgeCompanion[E] toany2stringadd[CEdgeCompanion[E]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CEdgeCompanion[E], B)
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toArrowAssoc[CEdgeCompanion[E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def apply[N](nodes: (N, N), attr: P): E[N] with EdgeCopy[E]
    Annotations
    @inline()
  7. final def apply[N](node_1: N, node_2: N, attr: P): E[N] with EdgeCopy[E]
    Annotations
    @inline()
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. def ensuring(cond: (CEdgeCompanion[E]) => Boolean, msg: => Any): CEdgeCompanion[E]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toEnsuring[CEdgeCompanion[E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (CEdgeCompanion[E]) => Boolean): CEdgeCompanion[E]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toEnsuring[CEdgeCompanion[E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): CEdgeCompanion[E]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toEnsuring[CEdgeCompanion[E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): CEdgeCompanion[E]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toEnsuring[CEdgeCompanion[E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def from[N](nodes: Product, attr: P): E[N] with EdgeCopy[E]
    Attributes
    protected[collection]
    Annotations
    @inline()
  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 CEdgeCompanion[E] toOuterNode[CEdgeCompanion[E]] 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 CEdgeCompanion[E] toOuterNode[CEdgeCompanion[E]] 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 CEdgeCompanion[E] toOuterNode[CEdgeCompanion[E]] 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 CEdgeCompanion[E] toOuterNode[CEdgeCompanion[E]] 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 CEdgeCompanion[E] toOuterNode[CEdgeCompanion[E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  25. val n1: CEdgeCompanion[E]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toEdgeAssoc[CEdgeCompanion[E]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def pipe[B](f: (CEdgeCompanion[E]) => B): B
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toChainingOps[CEdgeCompanion[E]] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  30. def productElementNames: Iterator[String]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toOuterNode[CEdgeCompanion[E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Product
  31. val self: CEdgeCompanion[E]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toChainingOps[CEdgeCompanion[E]] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  32. def stringPrefix: String
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toOuterNode[CEdgeCompanion[E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def tap[U](f: (CEdgeCompanion[E]) => U): CEdgeCompanion[E]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toChainingOps[CEdgeCompanion[E]] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. val value: CEdgeCompanion[E]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toOuterNode[CEdgeCompanion[E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    OuterNode → NodeParam
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. def ~[N >: N1](n2: N): UnDiEdge[N]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toEdgeAssoc[CEdgeCompanion[E]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  41. def ~>[N >: N1](n2: N): DiEdge[N]
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toEdgeAssoc[CEdgeCompanion[E]] 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 CEdgeCompanion[E] toOuterNode[CEdgeCompanion[E]] 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:
    (cEdgeCompanion: OuterNode[CEdgeCompanion[E]]).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 CEdgeCompanion[E] toStringFormat[CEdgeCompanion[E]] 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): (CEdgeCompanion[E], B)
    Implicit
    This member is added by an implicit conversion from CEdgeCompanion[E] toArrowAssoc[CEdgeCompanion[E]] 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 CEdgeCompanionBase[E]

Inherited from EdgeCompanionBase[E]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion ChainingOps fromCEdgeCompanion[E] to ChainingOps[CEdgeCompanion[E]]

Inherited by implicit conversion EdgeAssoc fromCEdgeCompanion[E] to EdgeAssoc[CEdgeCompanion[E]]

Inherited by implicit conversion anyToNode fromCEdgeCompanion[E] to OuterNode[CEdgeCompanion[E]]

Inherited by implicit conversion any2stringadd fromCEdgeCompanion[E] to any2stringadd[CEdgeCompanion[E]]

Inherited by implicit conversion StringFormat fromCEdgeCompanion[E] to StringFormat[CEdgeCompanion[E]]

Inherited by implicit conversion Ensuring fromCEdgeCompanion[E] to Ensuring[CEdgeCompanion[E]]

Inherited by implicit conversion ArrowAssoc fromCEdgeCompanion[E] to ArrowAssoc[CEdgeCompanion[E]]

Ungrouped