invariants.core.computation

IntVar

class IntVar extends Variable

an intvar is a variable managed by the Model whose type is integer.

Linear Supertypes
Variable, PropagationElement, TarjanNode, DAGNode, Ordered[DAGNode], Comparable[DAGNode], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. IntVar
  2. Variable
  3. PropagationElement
  4. TarjanNode
  5. DAGNode
  6. Ordered
  7. Comparable
  8. AnyRef
  9. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IntVar (model: Model, MinVal: Int, MaxVal: Int, Value: Int, name: String)

    model

    is the model in s-which the variable is declared, can be null if the variable is actually a constant, see IntConst

    MinVal

    is the minimum value of the variable. Some invariants exploit this value to declare fixed size arrays

    MaxVal

    is the maximum value of the variable. Some invariants exploit this value to declare fixed size arrays

    Value

    is the value of the variable

    name

    is the name of the variable, used for pretty printing only

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def ++ : Unit

  5. def :+= (v: Int): Unit

  6. def :-= (v: Int): Unit

  7. def := (v: Int): Unit

  8. def :=: (v: IntVar): Unit

    this operators swaps the value of two IntVar

  9. def < (that: DAGNode): Boolean

    Definition Classes
    Ordered
  10. def <= (that: DAGNode): Boolean

    Definition Classes
    Ordered
  11. def <== (i: IntVar): Unit

  12. def <== (i: IntInvariant): Unit

  13. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  14. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  15. def > (that: DAGNode): Boolean

    Definition Classes
    Ordered
  16. def >= (that: DAGNode): Boolean

    Definition Classes
    Ordered
  17. var DefiningInvariant : Invariant

    Definition Classes
    Variable
  18. var DeterminingElements : List[PropagationElement]

    Definition Classes
    PropagationElement
  19. val DynamicallyListenedElements : PermaFilteredDoublyLinkedList[PropagationElement]

    Definition Classes
    PropagationElement
  20. var DynamicallyListenedElementsFromSameComponent : PermaFilteredDoublyLinkedList[PropagationElement]

    Definition Classes
    PropagationElement
  21. val DynamicallyListeningElements : PermaFilteredDoublyLinkedList[(PropagationElement, Any)]

    Definition Classes
    PropagationElement
  22. var DynamicallyListeningElementsFromSameComponent : PermaFilteredDoublyLinkedList[(PropagationElement, Any)]

    Definition Classes
    PropagationElement
  23. var InOneComponent : Boolean

    Definition Classes
    TarjanNode
  24. var Index : Int

    Definition Classes
    TarjanNode
  25. def InitiateDynamicGraphFromSameComponent (): Unit

    Definition Classes
    PropagationElement
  26. var IsBoundary : Boolean

    set to true if the PropagationElement is one that can break or make dependency cycles in the dynamic dependency graph managed by the PropagationComponent basically, set to true if the determiningElement is not in the same component and if this PropagationElement belongs to a cycle in the static dependency graph

    set to true if the PropagationElement is one that can break or make dependency cycles in the dynamic dependency graph managed by the PropagationComponent basically, set to true if the determiningElement is not in the same component and if this PropagationElement belongs to a cycle in the static dependency graph

    Definition Classes
    PropagationElement
  27. var LowLink : Int

    Definition Classes
    TarjanNode
  28. val MaxVal : Int

    is the maximum value of the variable.

    is the maximum value of the variable. Some invariants exploit this value to declare fixed size arrays

  29. val MinVal : Int

    is the minimum value of the variable.

    is the minimum value of the variable. Some invariants exploit this value to declare fixed size arrays

  30. var OnStack : Boolean

    Definition Classes
    TarjanNode
  31. var Position : Int

    the position in the topological sort

    the position in the topological sort

    Definition Classes
    DAGNode
  32. var StaticallyListenedElements : List[PropagationElement]

    Definition Classes
    PropagationElement
  33. var StaticallyListeningElements : List[PropagationElement]

    Definition Classes
    PropagationElement
  34. var UniqueID : Int

    it gives the unique ID of the PropagationElement.

    it gives the unique ID of the PropagationElement. those uniqueID are expected to start at 0 and to increase continuously An exception is tolerated: UniqueID is set to -1 if the Propagation Element is not mentioned in the propagation structure, such as for constants yet is mentioned in the dependencies of registered propagation elements

    Definition Classes
    DAGNode
  35. var Value : Int

    is the value of the variable

  36. implicit def apply : Int

    Attributes
    implicit
  37. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  38. def checkInternals (): Unit

    This is the debug procedure through which propagation element can redundantly check that the incremental computation they perform through the performPropagation method is correct overriding this method is optional, so an empty body is provided by default

    This is the debug procedure through which propagation element can redundantly check that the incremental computation they perform through the performPropagation method is correct overriding this method is optional, so an empty body is provided by default

    Definition Classes
    IntVarPropagationElement
  39. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  40. def compare (that: DAGNode): Int

    Attributes
    final
    Definition Classes
    PropagationElement → Ordered
  41. def compareTo (that: DAGNode): Int

    Definition Classes
    Ordered → Comparable
  42. var component : StrognlyConnexComponent

    this refers to the propagationComponent that contains the PropagationElement.

    this refers to the propagationComponent that contains the PropagationElement. it is managed by the propagation structure

    Definition Classes
    PropagationElement
  43. def decrementAndAccumulateFront (acc: List[PropagationElement]): List[PropagationElement]

    Definition Classes
    PropagationElement
  44. def decrementSucceedingAndAccumulateFront (acc: List[PropagationElement]): List[PropagationElement]

    Definition Classes
    PropagationElement
  45. def determineBoundary (): Unit

    this sets the value of IsBoundary according to the definition of this variable

    this sets the value of IsBoundary according to the definition of this variable

    returns

    the value of IsBoundary

    Definition Classes
    PropagationElement
  46. def dropStaticGraph (): Unit

    Definition Classes
    PropagationElement
  47. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  48. def equals (arg0: Any): Boolean

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

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  50. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  51. def getClone : IdentityInt

  52. def getDAGPrecedingNodes : Iterable[DAGNode]

    Attributes
    final
    Definition Classes
    PropagationElementDAGNode
  53. def getDAGSucceedingNodes : Iterable[DAGNode]

    Attributes
    final
    Definition Classes
    PropagationElementDAGNode
  54. def getDefiningInvariant : Invariant

    Definition Classes
    Variable
  55. def getDeterminingElements : Iterable[PropagationElement]

    the variable that influence on the dependencies of the proapgation element these are propagated first to constitute the dynamic propagatoin graph

    the variable that influence on the dependencies of the proapgation element these are propagated first to constitute the dynamic propagatoin graph

    Definition Classes
    PropagationElement
  56. def getDomain : Range

  57. def getDotColor : String

    Definition Classes
    Variable
  58. def getDotNode : String

    This returns the dot node to display on the DOT output for the node.

    This returns the dot node to display on the DOT output for the node. Only the argument of the nodes example: "[label= \"toto\" shape=diamond color=red]"

    Definition Classes
    IntVarPropagationElement
  59. def getDynamicallyListenedElements : Iterable[PropagationElement]

    Attributes
    final
    Definition Classes
    PropagationElement
  60. def getDynamicallyListeningElements : Iterable[(PropagationElement, Any)]

    Attributes
    final
    Definition Classes
    PropagationElement
  61. def getPropagationStructure : Model

    returns a reference to the propagationStructure where the PropagationElement is registered

    returns a reference to the propagationStructure where the PropagationElement is registered

    Definition Classes
    VariablePropagationElement
  62. def getStaticallyListenedElements : Iterable[PropagationElement]

    through this method, the PropagationElement must declare which PropagationElement it is listening to in the static dependency graph.

    through this method, the PropagationElement must declare which PropagationElement it is listening to in the static dependency graph. The result must be stable after the call to setupPropagationStructure. to override

    Attributes
    final
    Definition Classes
    PropagationElement
  63. def getStaticallyListeningElements : Iterable[PropagationElement]

    through this method, the PropagationElement must declare which PropagationElement listen to it in the static dependency graph.

    through this method, the PropagationElement must declare which PropagationElement listen to it in the static dependency graph. The result must be stable after the call to setupPropagationStructure. to override

    Attributes
    final
    Definition Classes
    PropagationElement
  64. def getValue (NewValue: Boolean = false): Int

  65. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  66. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  67. var isScheduled : Boolean

    set to true if the PropagationElement is scheduled for propagation, false otherwise.

    set to true if the PropagationElement is scheduled for propagation, false otherwise. this is managed by the PropagationElement

    Definition Classes
    PropagationElement
  68. val name : String

    is the name of the variable, used for pretty printing only

    is the name of the variable, used for pretty printing only

    Definition Classes
    IntVarVariable
  69. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  70. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  71. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  72. def notifyChanged (): Unit

    this method s to be called by any method that internally modifies the value of the variable it schedules the variable for propagation, and performs a basic check of the identify of the executing invariant

    this method s to be called by any method that internally modifies the value of the variable it schedules the variable for propagation, and performs a basic check of the identify of the executing invariant

    Definition Classes
    Variable
  73. def performPropagation (): Unit

    this is the propagation method that should be overridden by propagation elements.

    this is the propagation method that should be overridden by propagation elements. notice that it is only called in a propagation wave if: 1: it has been registered for propagation since the last time it was propagated 2: it is included in the propagation wave: partial propagation wave do not propagate all propagation elements; it only propagates the ones that come in the predecessors of the targeted propagation element overriding this method is optional, so an empty body is provided by default

    Definition Classes
    IntVarPropagationElement
  74. def propagate (): Unit

    Performs the propagation, and some bookkeeping around it.

    Performs the propagation, and some bookkeeping around it.

    Definition Classes
    PropagationElement
  75. def registerDeterminingElement (p: PropagationElement, i: Any): Unit

    must belong to the statically listened elements.

    must belong to the statically listened elements. cannot be added to the dynamically listened ones (it is added through this method, so you cannot remove it)

    p

    the element that determines the dynamic dependencies of the propagation element

    i

    an additional value that is stored in this element together with the reference to this, can be use for notification purposes

    Attributes
    protected final
    Definition Classes
    PropagationElement
  76. def registerDynamicallyListenedElement (p: PropagationElement, i: Any): KeyForElementRemoval

    this registers to the element in the dynbamic propagation graph.

    this registers to the element in the dynbamic propagation graph. this element must have been registered o the static propagation graph before, or be accessible through a bulk

    p

    the element that we register to

    i

    a value that can be exploited by the element to notify its updates. normally, this value should be an int, if other type is used, the invariant should override a dedicated notification method.

    returns

    a key that is needed to unregister the element in the dynamic propagation graph

    Attributes
    protected
    Definition Classes
    PropagationElement
  77. def registerStaticallyListenedElement (p: PropagationElement): Unit

    registers an element in the static dependency graph.

    registers an element in the static dependency graph. Beware that you also need to register elements in the dynamic propagation graph for something to happen.

    p

    the element that we register to

    Attributes
    protected final
    Definition Classes
    PropagationElement
  78. def scheduleForPropagation (): Unit

    to invoque to force inclusion of the propagation element in the current or next propagation wave.

    to invoque to force inclusion of the propagation element in the current or next propagation wave.

    Attributes
    final
    Definition Classes
    PropagationElement
  79. def setCounterToPrecedingCount (): Boolean

    Sets the Position oto the number of element that need to be decremented, not belonging to same connex component for connex component, set it to the number of element that are referenced from othercomponents

    Sets the Position oto the number of element that need to be decremented, not belonging to same connex component for connex component, set it to the number of element that are referenced from othercomponents

    returns

    true if there is a dependency, false otherwise

    Definition Classes
    PropagationElement
  80. def setDefiningInvariant (i: Invariant): Unit

    Definition Classes
    Variable
  81. def setValue (v: Int): Unit

  82. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  83. def toString (): String

    Definition Classes
    IntVar → AnyRef → Any
  84. def unregisterDynamicallyListenedElement (p: KeyForElementRemoval): Unit

    unregisters an element in the dynamic propagation graph.

    unregisters an element in the dynamic propagation graph.

    p

    the key that was given when the eement was registered in the dynamic propagation graph

    Attributes
    protected
    Definition Classes
    PropagationElement
  85. var visited : Boolean

    supposed to be false between each pass of the algorithm

    supposed to be false between each pass of the algorithm

    Definition Classes
    DAGNode
  86. var visited2 : Boolean

    Definition Classes
    DAGNode
  87. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Variable

Inherited from PropagationElement

Inherited from TarjanNode

Inherited from DAGNode

Inherited from Ordered[DAGNode]

Inherited from Comparable[DAGNode]

Inherited from AnyRef

Inherited from Any