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 Attributes[+N] extends AnyRef

To be mixed in by the custom edge class.

Self Type
Attributes[N] with EdgeLike[N]
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Attributes
  2. AnyRef
  3. Any
Implicitly
  1. by ChainingOps
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type P <: Product

    To be set to <companion object>.P.

Abstract Value Members

  1. abstract def attributes: (Attributes.this)#P

    Must return an instance of Tuple<n> with n being the number of custom attributes.

    Must return an instance of Tuple<n> with n being the number of custom attributes. Custom attributes are defined by the constructor parameters excluding those representing nodes.

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 Attributes[N] toany2stringadd[Attributes[N]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Attributes[N], B)
    Implicit
    This member is added by an implicit conversion from Attributes[N] toArrowAssoc[Attributes[N]] 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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (Attributes[N]) => Boolean, msg: => Any): Attributes[N]
    Implicit
    This member is added by an implicit conversion from Attributes[N] toEnsuring[Attributes[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Attributes[N]) => Boolean): Attributes[N]
    Implicit
    This member is added by an implicit conversion from Attributes[N] toEnsuring[Attributes[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Attributes[N]
    Implicit
    This member is added by an implicit conversion from Attributes[N] toEnsuring[Attributes[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Attributes[N]
    Implicit
    This member is added by an implicit conversion from Attributes[N] toEnsuring[Attributes[N]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def pipe[B](f: (Attributes[N]) => B): B
    Implicit
    This member is added by an implicit conversion from Attributes[N] toChainingOps[Attributes[N]] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  21. val self: Attributes[N]
    Implicit
    This member is added by an implicit conversion from Attributes[N] toChainingOps[Attributes[N]] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def tap[U](f: (Attributes[N]) => U): Attributes[N]
    Implicit
    This member is added by an implicit conversion from Attributes[N] toChainingOps[Attributes[N]] performed by method ChainingOps in scalax.collection.
    Definition Classes
    ChainingOps
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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 Attributes[N] toStringFormat[Attributes[N]] 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): (Attributes[N], B)
    Implicit
    This member is added by an implicit conversion from Attributes[N] toArrowAssoc[Attributes[N]] 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 AnyRef

Inherited from Any

Inherited by implicit conversion ChainingOps fromAttributes[N] to ChainingOps[Attributes[N]]

Inherited by implicit conversion any2stringadd fromAttributes[N] to any2stringadd[Attributes[N]]

Inherited by implicit conversion StringFormat fromAttributes[N] to StringFormat[Attributes[N]]

Inherited by implicit conversion Ensuring fromAttributes[N] to Ensuring[Attributes[N]]

Inherited by implicit conversion ArrowAssoc fromAttributes[N] to ArrowAssoc[Attributes[N]]

Ungrouped