Tcons1

java.lang.Object
- apron.Tcons1

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Tcons1
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
Class of level 1 constraints on arbitrary expressions.
A Tcons1 represents a constraint over variables denoted by name in an environment.
A Tcons1 is implemented as a pair containing a Tcons0 and an Environment, manipulated in conjunction. Direct access to the fields is prohibited, to avoid desynchronizing them.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Tcons0`	`cons` Level 0 constraint.
`static int`	`DISEQ` Disquality constraint: expr <> 0.
`protected Environment`	`env` Environment.
`static int`	`EQ` Equality constraint: expr = 0.
`static int`	`EQMOD` Congruence equality constraint modulo a constant: expr = 0 mod scalar.
`static int`	`SUP` Strict inequality constraint: expr > 0.
`static int`	`SUPEQ` Inequality constraint: expr >= 0.

Constructor Summary

Constructors
Constructor and Description
`Tcons1(Environment v, int k, Texpr1Node e)` Constructs a constraint with given kind and e as left member.
`Tcons1(Environment v, int k, Texpr1Node e, Scalar s)` Constructs a constraint with given kind, e as left member, and s as modulo factor.
`Tcons1(Environment e, Tcons0 x)` Creates a new Tcons1 from a Tcons0.
`Tcons1(int k, Texpr1Intern e)` Constructs a constraint with given kind and e as left member.
`Tcons1(int k, Texpr1Intern e, Scalar s)` Constructs a constraint with given kind, e as left member, and s as modulo factor.
`Tcons1(Lincons1 c)` Converts a linear constraint to a comb-line tree expression constraint.
`Tcons1(Tcons1 c)` Constructs a copy of c.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Tcons1`	`clone()` Returns a copy of this.
`boolean`	`equals(java.lang.Object x)` Whether x is a Tcons1 and structurally equal to this.
`void`	`extendEnvironment(Environment e)` Expands the constraint to fit the given environment.
`Tcons1`	`extendEnvironmentCopy(Environment e)` Returns a constraint expanded to fit the given environment.
`int`	`getDepth()` Returns the depth of the expression tree.
`Environment`	`getEnvironment()` Returns the environment of the constraint.
`int`	`getKind()` Returns the constraint kind.
`Scalar`	`getScalar()` Returns the optional modulo factor (may be null).
`int`	`getSize()` Returns the number of internal nodes in the tree.
`Tcons0`	`getTcons0()` Returns a copy of the Tcons0 underlying the constraint.
`Tcons0`	`getTcons0Ref()` Returns a (read-only) reference to the Tcons0 underlying this constraint.
`Var[]`	`getVars()` Returns the list of all occurring variables.
`int`	`hashCode()` Returns a hash of the constraint.
`boolean`	`hasVar(java.lang.String var)`
`boolean`	`hasVar(Var var)` Whether the variable var is present.
`boolean`	`isEqual(Tcons1 x)` Whether x and this are structurally equal.
`boolean`	`isIntervalCst()` Whether the expression is constant.
`boolean`	`isIntervalLinear()` Whether the expression is linear with interval or scalar coefficients, and there is no rounding.
`boolean`	`isIntervalPolyfrac()` Whether the expression is a polynomial fraction, with interval or scalar coefficients, and there is no rounding.
`boolean`	`isIntervalPolynomial()` Whether the expression is polynomial, with interval or scalar coefficients, and there is no rounding.
`boolean`	`isScalar()` Whether all coefficients are scalar (non interval).
`static Tcons1`	`make(Environment v, Tcons0 x)` This function is used internally to construct a level 1 constraint by referencing a level 0 constraint.
`void`	`setKind(int k)` Changes the kind of constraint.
`void`	`setScalar(Scalar s)` Sets the optional modulo factor (may be null).
`void`	`substitute(java.lang.String var, Texpr1Intern t)`
`void`	`substitute(Var var, Texpr1Intern t)` Substitutes all occurrences of the variable var with the expression tree t.
`Tcons1`	`substituteCopy(java.lang.String var, Texpr1Intern t)`
`Tcons1`	`substituteCopy(Var var, Texpr1Intern t)` Returns a copy of this where all occurrences of the variable var are substituted with the expression tree t.
`java.lang.String`	`toString()` Returns a string representation of the constraint.
`Texpr1Node`	`toTexpr1Node()` Converts the expression tree to a concrete Java tree.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - cons
```
protected Tcons0 cons
```
    Level 0 constraint.
  - env
```
protected Environment env
```
    Environment.
  - EQ
```
public static final int EQ
```
    Equality constraint: expr = 0.
    
    See Also:
    
    Constant Field Values
  - SUPEQ
```
public static final int SUPEQ
```
    Inequality constraint: expr >= 0.
    
    See Also:
    
    Constant Field Values
  - SUP
```
public static final int SUP
```
    Strict inequality constraint: expr > 0.
    
    See Also:
    
    Constant Field Values
  - EQMOD
```
public static final int EQMOD
```
    Congruence equality constraint modulo a constant: expr = 0 mod scalar.
    
    See Also:
    
    Constant Field Values
  - DISEQ
```
public static final int DISEQ
```
    Disquality constraint: expr <> 0.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Tcons1
```
public Tcons1(int k,
              Texpr1Intern e)
```
    Constructs a constraint with given kind and e as left member.
    e is copied.
  - Tcons1
```
public Tcons1(int k,
              Texpr1Intern e,
              Scalar s)
```
    Constructs a constraint with given kind, e as left member, and s as modulo factor.
    e is copied, s is referenced.
  - Tcons1
```
public Tcons1(Environment v,
              int k,
              Texpr1Node e)
```
    Constructs a constraint with given kind and e as left member.
  - Tcons1
```
public Tcons1(Environment v,
              int k,
              Texpr1Node e,
              Scalar s)
```
    Constructs a constraint with given kind, e as left member, and s as modulo factor.
  - Tcons1
```
public Tcons1(Tcons1 c)
```
    Constructs a copy of c.
    The left member expression and the optional scalar are copied.
  - Tcons1
```
public Tcons1(Lincons1 c)
```
    Converts a linear constraint to a comb-line tree expression constraint.
  - Tcons1
```
public Tcons1(Environment e,
              Tcons0 x)
```
    Creates a new Tcons1 from a Tcons0.
    All coefficients are copied.
    The environment must be large enough for all variables in x.
- Method Detail
  - make
```
public static Tcons1 make(Environment v,
                          Tcons0 x)
```
    This function is used internally to construct a level 1 constraint by referencing a level 0 constraint.
    The level 0 constraint should no longer be used afterwards.
  - getEnvironment
```
public Environment getEnvironment()
```
    Returns the environment of the constraint.
  - getKind
```
public int getKind()
```
    Returns the constraint kind.
  - getScalar
```
public Scalar getScalar()
```
    Returns the optional modulo factor (may be null).
  - toTexpr1Node
```
public Texpr1Node toTexpr1Node()
```
    Converts the expression tree to a concrete Java tree.
  - getTcons0
```
public Tcons0 getTcons0()
```
    Returns a copy of the Tcons0 underlying the constraint.
  - getTcons0Ref
```
public Tcons0 getTcons0Ref()
```
    Returns a (read-only) reference to the Tcons0 underlying this constraint.
    Warning: it is dangerous to add, remove, or permute dimensions as it may desynchrnonize the Tcons0 dimensions form the environment.
  - getDepth
```
public int getDepth()
```
    Returns the depth of the expression tree.
  - getSize
```
public int getSize()
```
    Returns the number of internal nodes in the tree.
  - hasVar
```
public boolean hasVar(java.lang.String var)
```
  - hasVar
```
public boolean hasVar(Var var)
```
    Whether the variable var is present.
  - getVars
```
public Var[] getVars()
```
    Returns the list of all occurring variables.
    The ordering is that of dimensions.
  - isIntervalCst
```
public boolean isIntervalCst()
```
    Whether the expression is constant.
  - isIntervalLinear
```
public boolean isIntervalLinear()
```
    Whether the expression is linear with interval or scalar coefficients, and there is no rounding.
  - isIntervalPolynomial
```
public boolean isIntervalPolynomial()
```
    Whether the expression is polynomial, with interval or scalar coefficients, and there is no rounding.
  - isIntervalPolyfrac
```
public boolean isIntervalPolyfrac()
```
    Whether the expression is a polynomial fraction, with interval or scalar coefficients, and there is no rounding.
  - isScalar
```
public boolean isScalar()
```
    Whether all coefficients are scalar (non interval).
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the constraint.
    
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Returns a hash of the constraint.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - setKind
```
public void setKind(int k)
```
    Changes the kind of constraint.
  - setScalar
```
public void setScalar(Scalar s)
```
    Sets the optional modulo factor (may be null).
  - substitute
```
public void substitute(java.lang.String var,
                       Texpr1Intern t)
```
  - substitute
```
public void substitute(Var var,
                       Texpr1Intern t)
```
    Substitutes all occurrences of the variable var with the expression tree t.
    this and t must be defined on the same environment.
  - substituteCopy
```
public Tcons1 substituteCopy(java.lang.String var,
                             Texpr1Intern t)
```
  - substituteCopy
```
public Tcons1 substituteCopy(Var var,
                             Texpr1Intern t)
```
    Returns a copy of this where all occurrences of the variable var are substituted with the expression tree t.
    this and t must be defined on the same environment.
    this is not modified.
  - extendEnvironment
```
public void extendEnvironment(Environment e)
```
    Expands the constraint to fit the given environment.
    e must be a super-environment of that of this.
  - extendEnvironmentCopy
```
public Tcons1 extendEnvironmentCopy(Environment e)
```
    Returns a constraint expanded to fit the given environment.
    e must be a super-environment of that of this.
    this is not modified.
  - clone
```
public Tcons1 clone()
```
    Returns a copy of this.
    
    Overrides:
    
    clone in class java.lang.Object
  - isEqual
```
public boolean isEqual(Tcons1 x)
```
    Whether x and this are structurally equal.
  - equals
```
public boolean equals(java.lang.Object x)
```
    Whether x is a Tcons1 and structurally equal to this.
    
    Overrides:
    
    equals in class java.lang.Object

Class Tcons1

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cons

env

EQ

SUPEQ

SUP

EQMOD

DISEQ

Constructor Detail

Tcons1

Tcons1

Tcons1

Tcons1

Tcons1

Tcons1

Tcons1

Method Detail

make

getEnvironment

getKind

getScalar

toTexpr1Node

getTcons0

getTcons0Ref

getDepth

getSize

hasVar

hasVar

getVars

isIntervalCst

isIntervalLinear

isIntervalPolynomial

isIntervalPolyfrac

isScalar

toString

hashCode

setKind

setScalar

substitute

substitute

substituteCopy

substituteCopy

extendEnvironment

extendEnvironmentCopy

clone

isEqual

equals