abstract class LUnDiEdge[+N, L] extends AnyUnDiEdge[N] with SingleLabel[L] with LUnDiEdgeToString
Template for generic undirected edges with a single label field.
Equality is based solely on the nodes so this trait is not suitable for multigraphs.
Mix in GenericEdgeMapper to get your derived edge also mappable.
- Alphabetic
- By Inheritance
- LUnDiEdge
- LUnDiEdgeToString
- UnDiEdgeToString
- LEdgeToString
- EdgeToString
- SingleLabel
- AnyUnDiEdge
- EqUnDi
- AnyEdge
- AnyHyperEdge
- EqHyper
- Eq
- Edge
- Equals
- AnyRef
- Any
- by DiEdgeImplicits
- by UnDiEdgeImplicits
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new LUnDiEdge()
Abstract Value Members
- abstract def label: L
- Definition Classes
- SingleLabel
- abstract def source: N
- Definition Classes
- AnyUnDiEdge
- abstract def target: N
- Definition Classes
- AnyUnDiEdge
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (LUnDiEdge[N, L], B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def _1: N
The first node of this edge.
The first node of this edge.
- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- Annotations
- @inline()
- final def _2: N
The second node of this edge.
The second node of this edge.
- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- Annotations
- @inline()
- final def arity: Int
Number of the endpoints of this edge.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def baseEquals(other: Edge[_]): Boolean
- def baseHashCode: Int
- def canEqual(that: Any): Boolean
- Definition Classes
- Edge → Equals
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def contains[M >: N](node: M): Boolean
Same as
isAt.Same as
isAt.- Definition Classes
- Edge
- Annotations
- @inline()
- def customMsgPrefix: String
- Attributes
- protected
- Definition Classes
- Edge
- def ends: Several[N]
The endpoints of this edge, in other words the nodes this edge connects.
- def ensuring(cond: (LUnDiEdge[N, L]) => Boolean, msg: => Any): LUnDiEdge[N, L]
- def ensuring(cond: (LUnDiEdge[N, L]) => Boolean): LUnDiEdge[N, L]
- def ensuring(cond: Boolean, msg: => Any): LUnDiEdge[N, L]
- def ensuring(cond: Boolean): LUnDiEdge[N, L]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(other: Edge[_]): Boolean
Preconditions:
this.directed == that.directed &&this.isInstanceOf[Keyed] == that.isInstanceOf[Keyed]Preconditions:
this.directed == that.directed &&this.isInstanceOf[Keyed] == that.isInstanceOf[Keyed]- Attributes
- protected
- Definition Classes
- Eq
- def equals(other: Any): Boolean
- Definition Classes
- Eq → AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def hasSource(pred: (N) => Boolean): Boolean
trueif any source end of this edge fulfillspred.trueif any source end of this edge fulfillspred.- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- final def hasSource[M >: N](node: M): Boolean
trueifnodeis a source of this edge.trueifnodeis a source of this edge. In case this edge is undirected this method maps toisAt.- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- final def hasTarget(pred: (N) => Boolean): Boolean
trueif any target end of this edge fulfillspred.trueif any target end of this edge fulfillspred.- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- final def hasTarget[M >: N](node: M): Boolean
trueifnodeis a target of this edge.trueifnodeis a target of this edge. In case this edge is undirected this method maps toisAt.- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- def hashCode(): Int
- Definition Classes
- Eq → AnyRef → Any
- final def isAt(pred: (N) => Boolean): Boolean
trueif any end of this edge fulfillspred. - final def isAt[M >: N](node: M): Boolean
trueifnodeis incident with this edge. - def isDirected: Boolean
Whether this edge is directed.
Whether this edge is directed.
- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- final def isHyperEdge: Boolean
Whether this edge's type is hyperedge meaning that it may have more than two ends.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isLabeled: Boolean
- Definition Classes
- Edge
- final def isLooping: Boolean
Whether this edge produces a self-loop.
Whether this edge produces a self-loop. In case of a non-hyperedge, a loop is given if the incident nodes are equal. In case of a directed hyperedge, a loop is given if any of the targets is included in the sources. In case of an undirected hyperedge, a loop is given if any of the ends is a duplicate.
- Definition Classes
- AnyUnDiEdge → AnyEdge → AnyHyperEdge → Edge
- final def isUndirected: Boolean
Whether this edge is undirected.
Whether this edge is undirected.
- Definition Classes
- Edge
- Annotations
- @inline()
- def labelSeparator: String
The part to be printed after the edge ends and before the label.
The part to be printed after the edge ends and before the label.
- Attributes
- protected
- Definition Classes
- LEdgeToString
- def labelToString: String
- Attributes
- protected
- Definition Classes
- SingleLabel
- def matches(p1: (N) => Boolean, p2: (N) => Boolean): Boolean
trueif
a) two distinct ends of this undirected edge exist for whichp1andp2hold or
b)p1holds for a source andp2for a target of this directed edge.trueif
a) two distinct ends of this undirected edge exist for whichp1andp2hold or
b)p1holds for a source andp2for a target of this directed edge.- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- def matches[M >: N](n1: M, n2: M): Boolean
trueiftrueif- being an undirected edge, both
n1andn2are at this edge - being a directed edge,
n1is a source andn2a target of this edge.
- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- being an undirected edge, both
- final def matches(fList: List[(N) => Boolean]): Boolean
- Attributes
- protected
- Definition Classes
- AnyHyperEdge
- val n1: LUnDiEdge[N, L]
- Implicit
- This member is added by an implicit conversion from LUnDiEdge[N, L] toUnDiEdgeImplicits[LUnDiEdge[N, L]] performed by method UnDiEdgeImplicits in scalax.collection.edges.
- Definition Classes
- UnDiEdgeImplicits → AbstractEdgeImplicits
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def node(n: Int): N
The n'th node of this edge.
- def nodesToString: String
- Attributes
- protected
- Definition Classes
- EdgeToString
- def nodesToStringSeparator: String
- Attributes
- protected
- Definition Classes
- UnDiEdgeToString → EdgeToString
- final def nonHyperEdge: Boolean
Whether this edge has exactly two ends.
Whether this edge has exactly two ends.
- Definition Classes
- Edge
- Annotations
- @inline()
- final def nonLooping: Boolean
Same as
! looping.Same as
! looping.- Definition Classes
- Edge
- Annotations
- @inline()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def sources: OneOrMore[N]
All source ends of this edge.
All source ends of this edge.
- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- Annotations
- @inline()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def targets: OneOrMore[N]
All target ends of this edge.
All target ends of this edge.
- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- Annotations
- @inline()
- def toString(): String
Implemented in terms of the protected methods
nodesToString,labelSeparatorandlabelToString.Implemented in terms of the protected methods
nodesToString,labelSeparatorandlabelToString.- Definition Classes
- LEdgeToString → EdgeToString → AnyRef → Any
- final def unDiBaseEquals(n1: Any, n2: Any): Boolean
- Attributes
- protected
- Definition Classes
- EqUnDi
- Annotations
- @inline()
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def weight: Double
The weight of this edge with a default of 1.
The weight of this edge with a default of 1.
Note that
weightis normally not part of the edge key (hashCode). As a result, edges with different weights connecting the same nodes will be evaluated as equal and thus added once and only once to the graph. In case you need multi-edges based on different weights you should define a custom edge class that mixes inExtendedKeyand addsweighttokeyAttributes.- Definition Classes
- Edge
- final def withSources[U](f: (N) => U): Unit
Applies
fto all source ends of this edge without any memory allocation.Applies
fto all source ends of this edge without any memory allocation.- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- final def withTargets[U](f: (N) => U): Unit
Applies
fto the target ends of this edge without any memory allocation.Applies
fto the target ends of this edge without any memory allocation.- Definition Classes
- AnyUnDiEdge → AnyHyperEdge → Edge
- def ~[NN >: N](n2: NN): UnDiEdge[NN]
- Implicit
- This member is added by an implicit conversion from LUnDiEdge[N, L] toUnDiEdgeImplicits[LUnDiEdge[N, L]] performed by method UnDiEdgeImplicits in scalax.collection.edges.
- Definition Classes
- AbstractEdgeImplicits
- def ~>[NN >: N](target: NN): DiEdge[NN]
- Implicit
- This member is added by an implicit conversion from LUnDiEdge[N, L] toDiEdgeImplicits[LUnDiEdge[N, L]] performed by method DiEdgeImplicits in scalax.collection.edges.
- Definition Classes
- AbstractDiEdgeImplicits
Shadowed Implicit Value Members
- val source: LUnDiEdge[N, L]
- Implicit
- This member is added by an implicit conversion from LUnDiEdge[N, L] toDiEdgeImplicits[LUnDiEdge[N, L]] performed by method DiEdgeImplicits in scalax.collection.edges.
- 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:(lUnDiEdge: DiEdgeImplicits[LUnDiEdge[N, L]]).source
- Definition Classes
- DiEdgeImplicits → AbstractDiEdgeImplicits
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from LUnDiEdge[N, L] toStringFormat[LUnDiEdge[N, L]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (LUnDiEdge[N, L], B)
- Implicit
- This member is added by an implicit conversion from LUnDiEdge[N, L] toArrowAssoc[LUnDiEdge[N, L]] 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.
Welcome to the Graph for Scala API reference. Some suggested entry points:
AnyGraphimmutable.Graphand its inner nodesmutable.Graphand its inner nodes.edgespackage and its subpackageshyperedgespackage and its subpackages.labeled edgespackagemultilabeled edgespackagelabeled hyperedgespackagemultilabeled hyperedgespackageordered labeled hyperedgespackageordered multilabeled hyperedgesobjectgenericpackage.GraphTraversalandTraverserInnerNode.RandomGraph.GraphGen.