Packages

trait Constrained[N, E[X] <: EdgeLikeIn[X]] extends ConstraintMethods[N, E] with ConstraintHandlerMethods[N, E]

Template to be mixed in by any constrained graph class.

The user of the dynamically constrained class scalax.collection.constrained.Graph or its mutable counterpart need not to be concerned about this trait because it has been mixed in there. She only needs to pass the companion object for her Constraint implementation.

Implementors of statically constrained graph classes have to mix in this trait in their constrained graph implementations.

See also

ConstraintMethods

Linear Supertypes
ConstraintHandlerMethods[N, E], ConstraintMethods[N, E], AnyRef, Any
Known Subclasses
Graph, GraphLike, UserConstrainedGraph, AdjacencyListGraph, DefaultGraphImpl, Graph, UserConstrainedGraphImpl, AdjacencyListGraph, DefaultGraphImpl, Graph, GraphLike, UserConstrainedGraphImpl
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Constrained
  2. ConstraintHandlerMethods
  3. ConstraintMethods
  4. AnyRef
  5. Any
Implicitly
  1. by anyToNode
  2. by CollectionsHaveToParArray
  3. by EdgeAssoc
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def preAdd(edge: E[N]): PreCheckResult

    This pre-check must return Abort if the addition is to be canceled, PostCheck if postAdd is to be called to decide or Complete if the outer edge is allowed to be added.

    This pre-check must return Abort if the addition is to be canceled, PostCheck if postAdd is to be called to decide or Complete if the outer edge is allowed to be added. If postAdd has been implemented, this method may always return PostCheck. This pre-check may be omitted by letting it always return postCheck and overriding the corresponding post-check commit* method. Use self to access the associated graph.

    edge

    to be added.

    returns

    The results of the pre-check containing the follow-up activity and possibly any intermediate computation result to be used during the post-check. To add computation results PreCheckResult must be extended.

    Definition Classes
    ConstraintMethods
  2. abstract def preAdd(node: N): PreCheckResult

    This pre-check must return Abort if the addition is to be canceled, PostCheck if postAdd is to be called to decide or Complete if the outer node is allowed to be added.

    This pre-check must return Abort if the addition is to be canceled, PostCheck if postAdd is to be called to decide or Complete if the outer node is allowed to be added. If postAdd has been implemented, this method may always return PostCheck. This pre-check may be omitted by letting it always return postCheck and overriding the corresponding post-check commit* method. Use self to access the associated graph.

    node

    to be added

    returns

    The results of the pre-check containing the follow-up activity and possibly any intermediate computation result to be used during the post-check. To add computation results PreCheckResult must be extended.

    Definition Classes
    ConstraintMethods
  3. abstract def preSubtract(edge: Graph.EdgeT, simple: Boolean): PreCheckResult

    This pre-check must return Abort if the subtraction of edge is to be canceled, PostCheck if postSubtract is to be called to decide or Complete if the the edge is allowed to be subtracted.

    This pre-check must return Abort if the subtraction of edge is to be canceled, PostCheck if postSubtract is to be called to decide or Complete if the the edge is allowed to be subtracted. This pre-check may be omitted by letting it always return postCheck and overriding the corresponding post-check commit* method. Use self to access the associated graph.

    edge

    the inner edge to be subtracted.

    simple

    true for standard (edge-only by -), false for ripple (by -!) removal.

    returns

    The results of the pre-check containing the follow-up activity and possibly any intermediate computation result to be used during the post-check. To add computation results PreCheckResult must be extended.

    Definition Classes
    ConstraintMethods
  4. abstract def preSubtract(node: Graph.NodeT, forced: Boolean): PreCheckResult

    This pre-check must return Abort if the subtraction of node is to be canceled, PostCheck if postSubtract is to be called to decide or Complete if the the node is allowed to be subtracted.

    This pre-check must return Abort if the subtraction of node is to be canceled, PostCheck if postSubtract is to be called to decide or Complete if the the node is allowed to be subtracted. This pre-check may be omitted by letting it always return postCheck and overriding the corresponding post-check commit* method. Use self to access the associated graph.

    node

    the inner to be subtracted.

    forced

    true for standard (ripple by -), false for gentle (by -?) removal.

    returns

    The results of the pre-check containing the follow-up activity and possibly any intermediate computation result to be used during the post-check. To add computation results PreCheckResult must be extended.

    Definition Classes
    ConstraintMethods
  5. abstract val self: Graph[N, E]

    When extending Constraint, self will denote the attached constrained graph.

    When extending Constraint, self will denote the attached constrained graph. The factory methods of the companion object scalax.collection.constrained.Graph initialize self to the correct graph instance. When extending Constrained, self will denote this graph.

    Definition Classes
    ConstraintMethods

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 Constrained[N, E] to any2stringadd[Constrained[N, E]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Constrained[N, E], B)
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to ArrowAssoc[Constrained[N, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def allNodes(passedNodes: Traversable[N], passedEdges: Traversable[E[N]]): Set[N]

    Consolidates all outer nodes of the arguments by adding the edge ends of passedEdges to passedNodes.

    Consolidates all outer nodes of the arguments by adding the edge ends of passedEdges to passedNodes.

    Attributes
    protected
    Definition Classes
    ConstraintMethods
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def ensuring(cond: (Constrained[N, E]) ⇒ Boolean, msg: ⇒ Any): Constrained[N, E]
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to Ensuring[Constrained[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Constrained[N, E]) ⇒ Boolean): Constrained[N, E]
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to Ensuring[Constrained[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): Constrained[N, E]
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to Ensuring[Constrained[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Constrained[N, E]
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to Ensuring[Constrained[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to StringFormat[Constrained[N, E]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def isDefined: Boolean
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to OuterNode[Constrained[N, 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 Constrained[N, E] to OuterNode[Constrained[N, 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 Constrained[N, E] to OuterNode[Constrained[N, 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 Constrained[N, E] to OuterNode[Constrained[N, 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 Constrained[N, E] to OuterNode[Constrained[N, E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  25. val n1: Constrained[N, E]
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to EdgeAssoc[Constrained[N, E]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def nodesToAdd(passedNodes: Traversable[N], passedEdges: Traversable[E[N]]): Set[N]
    Attributes
    protected
    Definition Classes
    ConstraintMethods
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. def onAdditionRefused(refusedNodes: Traversable[N], refusedEdges: Traversable[E[N]], graph: Graph[N, E]): Boolean

    This handler is called whenever an addition violates the constraints.

    This handler is called whenever an addition violates the constraints. The provided default implementation is empty.

    refusedNodes

    the nodes passed to preAdd.

    refusedEdges

    the edges passed to preAdd.

    returns

    must be true if the handler has been overridden but it doesn't throw an exception.

    Definition Classes
    ConstraintHandlerMethods
  31. def onSubtractionRefused(refusedNodes: Traversable[Graph.NodeT], refusedEdges: Traversable[Graph.EdgeT], graph: Graph[N, E]): Boolean

    This handler is called whenever a subtraction violates the constraints.

    This handler is called whenever a subtraction violates the constraints. The provided default implementation is empty.

    refusedNodes

    the nodes passed to preSubtract.

    refusedEdges

    the edges passed to preSubtract.

    returns

    must be true if the handler has been overridden but it doesn't throw an exception.

    Definition Classes
    ConstraintHandlerMethods
  32. def postAdd(newGraph: Graph[N, E], passedNodes: Traversable[N], passedEdges: Traversable[E[N]], preCheck: PreCheckResult): Boolean

    This post-check must return whether newGraph should be committed or the add operation is to be rolled back.

    This post-check must return whether newGraph should be committed or the add operation is to be rolled back. Use self to access the associated graph. For immutable graphs, self maintains the state before the addition but for mutable graphs, it is already mutated to the required state.

    newGraph

    the after-addition would-be graph waiting for commit.

    passedNodes

    nodes passed to the running add operation

    passedEdges

    edges passed to the running add operation

    preCheck

    The results of the pre-check containing the follow-up activity and possibly any intermediate computation result to be used during the post-check. To add computation results PreCheckResult must be extended.

    Definition Classes
    ConstraintMethods
  33. def postSubtract(newGraph: Graph[N, E], passedNodes: Traversable[N], passedEdges: Traversable[E[N]], preCheck: PreCheckResult): Boolean

    This post-check must return whether newGraph should be committed or the subtraction is to be rolled back.

    This post-check must return whether newGraph should be committed or the subtraction is to be rolled back. Use self to access the associated graph. For immutable graphs, self maintains the state before the addition but for mutable graphs, it is already mutated to the required state.

    newGraph

    the after-subtraction would-be graph waiting for commit.

    preCheck

    The results of the pre-check containing the follow-up activity and possibly any intermediate computation result to be used during the post-check. To add computation results PreCheckResult must be extended.

    Definition Classes
    ConstraintMethods
  34. def preAdd(elems: InParam[N, E]*): PreCheckResult

    This pre-check must return Abort if the addition of the outer nodes and/or edges in elems is to be canceled, PostCheck if postAdd is to be called to decide or Complete if the the outer nodes and/or edges are allowed to be added.

    This pre-check must return Abort if the addition of the outer nodes and/or edges in elems is to be canceled, PostCheck if postAdd is to be called to decide or Complete if the the outer nodes and/or edges are allowed to be added. If postAdd has been implemented, this method may always return PostCheck. The default implementation calls preAdd(node)/preAdd(edge) element-wise. As for most cases this won't be satisfactory a domain-specific implementation should be provided. Use self to access the associated graph.

    elems

    nodes and/or edges to be added possibly containing duplicates.

    returns

    The results of the pre-check containing the follow-up activity and possibly any intermediate computation result to be used during the post-check. To add computation results PreCheckResult must be extended.

    Definition Classes
    ConstraintMethods
  35. def preCreate(nodes: Traversable[N], edges: Traversable[E[N]]): PreCheckResult

    This pre-check is called on constructing a graph through its companion object.

    This pre-check is called on constructing a graph through its companion object. It must return whether the graph is allowed to be populated with nodes and edges. The default implementation calls preAdd for each node and edge.

    Note that nodes and edges coming from node/edge input streams are not checked. So when utilizing streams the post check postAdd must be served.

    nodes

    the outer nodes the graph is to be populated with; nodes being edge ends may but need not be contained in nodes.

    edges

    the outer edges the graph is to be populated with.

    returns

    The results of the pre-check containing the follow-up activity and possibly any intermediate computation result to be used during the post-check. To add computation results PreCheckResult must be extended.

    Definition Classes
    ConstraintMethods
  36. def preSubtract(nodes: ⇒ Set[Graph.NodeT], edges: ⇒ Set[Graph.EdgeT], simple: Boolean): PreCheckResult

    This pre-check must return Abort if the subtraction of nodes and/or edges is to be canceled, PostCheck if postSubtract is to be called to decide or Complete if nodes and/or edges are allowed to be subtracted.

    This pre-check must return Abort if the subtraction of nodes and/or edges is to be canceled, PostCheck if postSubtract is to be called to decide or Complete if nodes and/or edges are allowed to be subtracted. It is typically triggered by the -- operation. The default implementation element-wise calls preSubtract(node, simple) or preSubtract(edge, simple), respectively. As for most cases this won't be satisfactory a domain-specific implementation should be provided. Use self to access the associated graph.

    nodes

    the inner nodes to be subtracted not necessarily including the ends of edges to be subtracted. Call allNodes to get the complete set of nodes to be subtracted.

    edges

    the inner edges to be subtracted.

    simple

    true for standard (edge-only by -), false for ripple (by -!) removal.

    returns

    The results of the pre-check containing the follow-up activity and possibly any intermediate computation result to be used during the post-check. To add computation results PreCheckResult must be extended.

    Definition Classes
    ConstraintMethods
  37. def stringPrefix: String
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to OuterNode[Constrained[N, E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toParArray: ParArray[T]
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to CollectionsHaveToParArray[Constrained[N, E], T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (Constrained[N, E]) ⇒ GenTraversableOnce[T] is in scope.
    Definition Classes
    CollectionsHaveToParArray
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. val value: Constrained[N, E]
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to OuterNode[Constrained[N, E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    OuterNode → NodeParam
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  45. def ~[N >: N1](n2: N): UnDiEdge[N]
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to EdgeAssoc[Constrained[N, E]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  46. def ~>[N >: N1](n2: N): DiEdge[N]
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to EdgeAssoc[Constrained[N, E]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  47. def →[B](y: B): (Constrained[N, E], B)
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to ArrowAssoc[Constrained[N, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def toString(): String
    Implicit
    This member is added by an implicit conversion from Constrained[N, E] to OuterNode[Constrained[N, 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:
    (constrained: OuterNode[Constrained[N, E]]).toString()
    Definition Classes
    NodeParam → AnyRef → Any

Inherited from ConstraintHandlerMethods[N, E]

Inherited from ConstraintMethods[N, E]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion anyToNode from Constrained[N, E] to OuterNode[Constrained[N, E]]

Inherited by implicit conversion CollectionsHaveToParArray from Constrained[N, E] to CollectionsHaveToParArray[Constrained[N, E], T]

Inherited by implicit conversion EdgeAssoc from Constrained[N, E] to EdgeAssoc[Constrained[N, E]]

Inherited by implicit conversion any2stringadd from Constrained[N, E] to any2stringadd[Constrained[N, E]]

Inherited by implicit conversion StringFormat from Constrained[N, E] to StringFormat[Constrained[N, E]]

Inherited by implicit conversion Ensuring from Constrained[N, E] to Ensuring[Constrained[N, E]]

Inherited by implicit conversion ArrowAssoc from Constrained[N, E] to ArrowAssoc[Constrained[N, E]]

Ungrouped