final case class HyperEdge[+N] extends AbstractGenericHyperEdge[N, HyperEdge] with OrderedEndpoints with HyperEdgeToString with Product with Serializable
Undirected hyperedge with ends having sequence semantic with respect to equality.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- HyperEdge
- Serializable
- Product
- HyperEdgeToString
- EdgeToString
- OrderedEndpoints
- AbstractGenericHyperEdge
- GenericHyperEdgeMapper
- HyperEdgeMapper
- GenericMapper
- Mapper
- AbstractHyperEdge
- AnyHyperEdge
- EqHyper
- Eq
- Edge
- Equals
- AnyRef
- Any
- by OrderedHyperFromEdge
- by OrderedHyperFromAny
- by HyperFromAny
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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): (HyperEdge[N], B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def _1: N
The first node of this edge.
The first node of this edge.
- Definition Classes
- AnyHyperEdge → Edge
- def _2: N
The second node of this edge.
The second node of this edge.
- Definition Classes
- AnyHyperEdge → Edge
- def arity: Int
Number of the endpoints of this edge.
Number of the endpoints of this edge. At least two nodes are joined. In case of a hook, the two nodes are identical. Hyperedges may link more than two nodes.
- Definition Classes
- AnyHyperEdge → 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
- val e1: HyperEdge[N]
- Implicit
- This member is added by an implicit conversion from HyperEdge[N] toOrderedHyperFromEdge[N] performed by method OrderedHyperFromEdge in scalax.collection.hyperedges.ordered.
- Definition Classes
- OrderedHyperFromEdge → FromEdge
- val ends: Several[N]
The endpoints of this edge, in other words the nodes this edge connects.
The endpoints of this edge, in other words the nodes this edge connects.
- Definition Classes
- HyperEdge → AbstractHyperEdge → Edge
- def ensuring(cond: (HyperEdge[N]) => Boolean, msg: => Any): HyperEdge[N]
- def ensuring(cond: (HyperEdge[N]) => Boolean): HyperEdge[N]
- def ensuring(cond: Boolean, msg: => Any): HyperEdge[N]
- def ensuring(cond: Boolean): HyperEdge[N]
- 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()
- def hasSource(pred: (N) => Boolean): Boolean
trueif any source end of this edge fulfillspred.trueif any source end of this edge fulfillspred.- Definition Classes
- AnyHyperEdge → Edge
- 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
- AnyHyperEdge → Edge
- def hasTarget(pred: (N) => Boolean): Boolean
trueif any target end of this edge fulfillspred.trueif any target end of this edge fulfillspred.- Definition Classes
- AnyHyperEdge → Edge
- 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
- AnyHyperEdge → Edge
- def hashCode(): Int
- Definition Classes
- Eq → AnyRef → Any
- def isAt(pred: (N) => Boolean): Boolean
trueif any end of this edge fulfillspred.trueif any end of this edge fulfillspred.- Definition Classes
- AnyHyperEdge → Edge
- def isAt[M >: N](node: M): Boolean
trueifnodeis incident with this edge.trueifnodeis incident with this edge.- Definition Classes
- AnyHyperEdge → Edge
- def isDirected: Boolean
Whether this edge is directed.
Whether this edge is directed.
- Definition Classes
- AnyHyperEdge → Edge
- def isHyperEdge: Boolean
Whether this edge's type is hyperedge meaning that it may have more than two ends.
Whether this edge's type is hyperedge meaning that it may have more than two ends.
- Definition Classes
- AnyHyperEdge → Edge
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isLabeled: Boolean
- Definition Classes
- Edge
- 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
- AnyHyperEdge → Edge
- final def isUndirected: Boolean
Whether this edge is undirected.
Whether this edge is undirected.
- Definition Classes
- Edge
- Annotations
- @inline()
- def map[N](ends: Several[N]): HyperEdge[N]
- Definition Classes
- HyperEdge → GenericHyperEdgeMapper
- 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
- 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
- AnyHyperEdge → Edge
- being an undirected edge, both
- final def matches(fList: List[(N) => Boolean]): Boolean
- Attributes
- protected
- Definition Classes
- AnyHyperEdge
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def node(n: Int): N
The n'th node of this edge.
The n'th node of this edge.
- Definition Classes
- AnyHyperEdge → Edge
- Exceptions thrown
IllegalArgumentExceptionifndoes not meet0 <= n < arity.
- def nodesToString: String
- Attributes
- protected
- Definition Classes
- EdgeToString
- def nodesToStringSeparator: String
- Attributes
- protected
- Definition Classes
- HyperEdgeToString → 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()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def sources: OneOrMore[N]
All source ends of this edge.
All source ends of this edge.
- Definition Classes
- AnyHyperEdge → Edge
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def targets: OneOrMore[N]
All target ends of this edge.
All target ends of this edge.
- Definition Classes
- AnyHyperEdge → Edge
- def toString(): String
Implementation in term of the protected method
nodesToString.Implementation in term of the protected method
nodesToString.- Definition Classes
- EdgeToString → AnyRef → Any
- 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
- 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
- AnyHyperEdge → Edge
- 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
- AnyHyperEdge → Edge
- def ~~[NN >: N](n: NN): HyperEdge[NN]
- Implicit
- This member is added by an implicit conversion from HyperEdge[N] toOrderedHyperFromEdge[N] performed by method OrderedHyperFromEdge in scalax.collection.hyperedges.ordered.
- Definition Classes
- FromEdge
- def ~~[NN >: N](n2: NN): HyperEdge[NN]
- Implicit
- This member is added by an implicit conversion from HyperEdge[N] toOrderedHyperFromAny[HyperEdge[N]] performed by method OrderedHyperFromAny in scalax.collection.hyperedges.ordered.
- Definition Classes
- FromAny
- def ~~[NN >: N](n2: NN): hyperedges.HyperEdge[NN]
- Implicit
- This member is added by an implicit conversion from HyperEdge[N] toHyperFromAny[HyperEdge[N]] performed by method HyperFromAny in scalax.collection.hyperedges.
- Definition Classes
- FromAny
Shadowed Implicit Value Members
- val n1: HyperEdge[N]
- Implicit
- This member is added by an implicit conversion from HyperEdge[N] toOrderedHyperFromAny[HyperEdge[N]] performed by method OrderedHyperFromAny in scalax.collection.hyperedges.ordered.
- Shadowing
- This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:(hyperEdge: OrderedHyperFromAny[HyperEdge[N]]).n1
- Definition Classes
- OrderedHyperFromAny → FromAny
- val n1: HyperEdge[N]
- Implicit
- This member is added by an implicit conversion from HyperEdge[N] toHyperFromAny[HyperEdge[N]] performed by method HyperFromAny in scalax.collection.hyperedges.
- Shadowing
- This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:(hyperEdge: HyperFromAny[HyperEdge[N]]).n1
- Definition Classes
- HyperFromAny → FromAny
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 HyperEdge[N] toStringFormat[HyperEdge[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 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): (HyperEdge[N], B)
- Implicit
- This member is added by an implicit conversion from HyperEdge[N] toArrowAssoc[HyperEdge[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.
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.