Class

scalax.collection.constrained

Constraint

Related Doc: package constrained

Permalink

abstract class Constraint[N, E[X] <: EdgeLikeIn[X]] extends ConstraintMethods[N, E] with ConstraintHandlerMethods[N, E]

Template to be implemented and passed to a dynamically constrained graph class by the user. Note that mutable state will be lost on any operation yielding a new graph. Thus it is essential to either design classes inheriting from Constraint in a pure immutable manner or taking internally care of whether the state has been lost.

See also

ConstraintMethods

Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Constraint
  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

Instance Constructors

  1. new Constraint(self: Graph[N, E])

    Permalink

    self

    denotes the attached constrained graph.

Abstract Value Members

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

    Permalink

    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 possible any intermediate computation results 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

    Permalink

    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 possible any intermediate computation results 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

    Permalink

    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 possible any intermediate computation results 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

    Permalink

    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 possible any intermediate computation results to be used during the post-check. To add computation results PreCheckResult must be extended.

    Definition Classes
    ConstraintMethods

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def &&(that: Constraint[N, E]): ConstraintBinaryOp[N, E]

    Permalink

    Creates a new constraint of the type ConstraintBinaryOp with pre- and post-check methods each of which returning true if both this' and that's corresponding pre- and post-checks return true.

  4. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to any2stringadd[Constraint[N, E]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. def ->[B](y: B): (Constraint[N, E], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to ArrowAssoc[Constraint[N, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  7. def allNodes(innerNodes: Set[Graph.NodeT], innerEdges: Set[Graph.EdgeT]): Set[Graph.NodeT]

    Permalink

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

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

    Attributes
    protected
    Definition Classes
    ConstraintMethods
  8. def allNodes(passedNodes: Traversable[N], passedEdges: Traversable[E[N]]): Set[N]

    Permalink

    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
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (Constraint[N, E]) ⇒ Boolean, msg: ⇒ Any): Constraint[N, E]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to Ensuring[Constraint[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Constraint[N, E]) ⇒ Boolean): Constraint[N, E]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to Ensuring[Constraint[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Constraint[N, E]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to Ensuring[Constraint[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Constraint[N, E]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to Ensuring[Constraint[N, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to StringFormat[Constraint[N, E]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. def isDefined: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to OuterNode[Constraint[N, E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  22. def isEdge: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to OuterNode[Constraint[N, E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  23. def isIn: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to OuterNode[Constraint[N, E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    InParam → Param
  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. def isNode: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to OuterNode[Constraint[N, E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  26. def isOut: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to OuterNode[Constraint[N, E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    InParam → Param
  27. val n1: Constraint[N, E]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to EdgeAssoc[Constraint[N, E]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. def onAdditionRefused(refusedNodes: Traversable[N], refusedEdges: Traversable[E[N]], graph: Graph[N, E]): Boolean

    Permalink

    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
  32. def onSubtractionRefused(refusedNodes: Traversable[Graph.NodeT], refusedEdges: Traversable[Graph.EdgeT], graph: Graph[N, E]): Boolean

    Permalink

    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
  33. def postAdd(newGraph: Graph[N, E], passedNodes: Traversable[N], passedEdges: Traversable[E[N]], preCheck: PreCheckResult): Boolean

    Permalink

    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 except those coming from node/edge input streams.

    passedEdges

    edges passed to the running add operation except those coming from edge input streams.

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

    Permalink

    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.

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

    Permalink

    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 possible any intermediate computation results to be used during the post-check. To add computation results PreCheckResult must be extended.

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

    Permalink

    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 possible any intermediate computation results to be used during the post-check. To add computation results PreCheckResult must be extended.

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

    Permalink

    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 possible any intermediate computation results to be used during the post-check. To add computation results PreCheckResult must be extended.

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

    Permalink

    denotes the attached constrained graph.

    denotes the attached constrained graph.

    Definition Classes
    ConstraintConstraintMethods
  39. def stringPrefix: String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to OuterNode[Constraint[N, E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  40. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  41. def toParArray: ParArray[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to CollectionsHaveToParArray[Constraint[N, E], T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (Constraint[N, E]) ⇒ GenTraversableOnce[T] is in scope.
    Definition Classes
    CollectionsHaveToParArray
  42. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  43. val value: Constraint[N, E]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to OuterNode[Constraint[N, E]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    OuterNode → NodeParam
  44. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. def ||(that: Constraint[N, E]): ConstraintBinaryOp[N, E]

    Permalink

    Creates a new constraint of the type ConstraintBinaryOp with pre- and post-check methods each of which returning true if either this' or other's corresponding pre- and post-checks returns true.

  48. def ~[N >: N1](n2: N): UnDiEdge[N]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to EdgeAssoc[Constraint[N, E]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  49. def ~>[N >: N1](n2: N): DiEdge[N]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to EdgeAssoc[Constraint[N, E]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  50. def [B](y: B): (Constraint[N, E], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to ArrowAssoc[Constraint[N, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def toString(): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Constraint[N, E] to OuterNode[Constraint[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:
    (constraint: OuterNode[Constraint[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 Constraint[N, E] to OuterNode[Constraint[N, E]]

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

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

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

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

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

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

Ungrouped