AstUtil (chocosolver 0.1-SNAPSHOT API)

java.lang.Object
- org.clafer.ast.AstUtil

```
public class AstUtil
extends Object
```
Various static utility functions for working with AST.

Author:

jimmy

Method Summary

Methods
Modifier and Type	Method and Description
`static List<AstAbstractClafer>`	`getAbstractClafersInSubOrder(AstModel model)` Find the abstract Clafers such that the subclafers appear before the super clafers.
`static List<AstClafer>`	`getClafers(AstModel model)` Find all the nested Clafers in no specific order.
`static List<Set<AstClafer>>`	`getClafersInParentAndSubOrder(AstModel model)` Find the Clafers such that the parents appear before the children, and the subclafers appear before the superclafers.
`static List<AstConcreteClafer>`	`getConcreteClafers(AstModel model)` Find all the nested concrete Clafers in no specific order.
`static List<AstConcreteClafer>`	`getConcreteClafersInParentOrder(AstModel model)` Find the concrete Clafers such that the parents appear before the children.
`static List<AstConcreteClafer>`	`getConcreteSubs(AstClafer clafer)` Find all the concrete subtypes of the supplied Clafer, including itself if it is concrete.
`static AstRef`	`getInheritedRef(AstClafer clafer)` Find the reference belonging to the Clafer or the reference it inherited.
`static AstClafer`	`getLowestCommonSupertype(AstClafer... unionType)` Finds the lowest common supertype.
`static AstClafer`	`getLowestCommonSupertype(Iterable<AstClafer> unionType)` Finds the lowest common supertype.
`static String[]`	`getNames(AstVar... vars)` Retrieve the names of the variables.
`static List<String>`	`getNames(Iterable<? extends AstVar> vars)` Retrieve the names of the Clafers.
`static List<AstClafer>`	`getNestedClafers(AstClafer clafer)` Find all the Clafers below the supplied one, including itself.
`static List<AstConstraint>`	`getNestedConstraints(AstModel model)` Find all the constraints in the model.
`static List<AstClafer>`	`getSuperHierarchy(AstClafer clafer)` Finds the supertype hierarchy of the Clafer.
`static List<AstAbstractClafer>`	`getSupers(AstClafer clafer)` Finds all the supertypes of the Clafer in order of lowest to highest.
`static AstClafer`	`getTopParent(AstClafer clafer)` Find the highest non-root Clafer above the supplied one.
`static boolean`	`hasInheritedRef(AstClafer clafer)`
`static boolean`	`hasNonEmptyIntersectionType(AstClafer t1, AstClafer t2)` Detects if a set of `t1` can share elements with a set of `t2`.
`static boolean`	`isAssignable(AstClafer from, AstClafer to)` Detects if a set of `from` is also a set of `to`.
`static boolean`	`isRoot(AstConcreteClafer clafer)` Detects if the Clafer is the implicit root of the model.
`static boolean`	`isTop(AstClafer clafer)` Detects if the Clafer is directly under the root.
`static boolean`	`isTypeRoot(AstAbstractClafer clafer)` Detects if the Clafer is the implicit type root of the model.
`static boolean`	`isUnionType(AstClafer union, AstClafer[] partitions)` Detects if the union type is fully covered by the partitions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getClafers
```
public static List<AstClafer> getClafers(AstModel model)
```
    Find all the nested Clafers in no specific order.
    
    Parameters:
    model - the Clafer model
    
    Returns:
    the Clafers in the model
  - getConcreteClafers
```
public static List<AstConcreteClafer> getConcreteClafers(AstModel model)
```
    Find all the nested concrete Clafers in no specific order.
    
    Parameters:
    model - the Clafer model
    
    Returns:
    the concrete Clafers in the model excluding the root
  - getClafersInParentAndSubOrder
```
public static List<Set<AstClafer>> getClafersInParentAndSubOrder(AstModel model)
```
    Find the Clafers such that the parents appear before the children, and the subclafers appear before the superclafers.
    
    Parameters:
    model - the Clafer model
    
    Returns:
    the Clafers in the above order
  - getAbstractClafersInSubOrder
```
public static List<AstAbstractClafer> getAbstractClafersInSubOrder(AstModel model)
```
    Find the abstract Clafers such that the subclafers appear before the super clafers.
    
    Parameters:
    model - the Clafer model
    
    Returns:
    the abstract Clafers in the above order
  - getConcreteClafersInParentOrder
```
public static List<AstConcreteClafer> getConcreteClafersInParentOrder(AstModel model)
```
    Find the concrete Clafers such that the parents appear before the children.
    
    Parameters:
    model - the Clafer model
    
    Returns:
    the concrete Clafers in the above order
  - isRoot
```
public static boolean isRoot(AstConcreteClafer clafer)
```
    Detects if the Clafer is the implicit root of the model.
    
    Parameters:
    clafer - the Clafer
    
    Returns:
    true if and only if the Clafer is the root, false otherwise
  - isTypeRoot
```
public static boolean isTypeRoot(AstAbstractClafer clafer)
```
    Detects if the Clafer is the implicit type root of the model.
    
    Parameters:
    clafer - the Clafer
    
    Returns:
    true if and only if the Clafer is the type root, false otherwise
  - isTop
```
public static boolean isTop(AstClafer clafer)
```
    Detects if the Clafer is directly under the root.
    
    Parameters:
    clafer - the Clafer
    
    Returns:
    true if and only if the Clafer is a top Clafer, false otherwise
  - getTopParent
```
public static AstClafer getTopParent(AstClafer clafer)
```
    Find the highest non-root Clafer above the supplied one.
    
    Parameters:
    clafer - the Clafer
    
    Returns:
    the highest non-root ancestor
  - getNestedClafers
```
public static List<AstClafer> getNestedClafers(AstClafer clafer)
```
    Find all the Clafers below the supplied one, including itself.
    
    Parameters:
    clafer - the Clafer
    
    Returns:
    the nested Clafers
  - getConcreteSubs
```
public static List<AstConcreteClafer> getConcreteSubs(AstClafer clafer)
```
    Find all the concrete subtypes of the supplied Clafer, including itself if it is concrete.
    
    Parameters:
    clafer - the Clafer
    
    Returns:
    the concrete sub-Clafers.
  - getNestedConstraints
```
public static List<AstConstraint> getNestedConstraints(AstModel model)
```
    Find all the constraints in the model.
    
    Parameters:
    model - the model
    
    Returns:
    the nested constraints
  - getSupers
```
public static List<AstAbstractClafer> getSupers(AstClafer clafer)
```
    Finds all the supertypes of the Clafer in order of lowest to highest.
    
    Parameters:
    clafer - the Clafer
    
    Returns:
    the supertypes
  - getSuperHierarchy
```
public static List<AstClafer> getSuperHierarchy(AstClafer clafer)
                                         throws AnalysisException
```
    Finds the supertype hierarchy of the Clafer. Equivalent to the Haskell code clafer : getSupers clafer.
    
    Parameters:
    clafer - the Clafer
    
    Returns:
    the supertype hierarchy
    
    Throws:
    
    AnalysisException - a cycle in the type hierarchy
  - isAssignable
```
public static boolean isAssignable(AstClafer from,
                   AstClafer to)
```
    Detects if a set of from is also a set of to.
    
    Parameters:
    from - the subtype
    to - the supertype
    
    Returns:
    true if and only if to is a supertype of from, false otherwise
  - hasNonEmptyIntersectionType
```
public static boolean hasNonEmptyIntersectionType(AstClafer t1,
                                  AstClafer t2)
```
    Detects if a set of t1 can share elements with a set of t2.
    
    Parameters:
    t1 - first type
    t2 - second type
    
    Returns:
    true if and only if the first and second type intersect, false otherwise
  - isUnionType
```
public static boolean isUnionType(AstClafer union,
                  AstClafer[] partitions)
```
    Detects if the union type is fully covered by the partitions. For example, isUnionType(Animal, Arrays.asList(Primate, Human, Dolphin)) would return true if and only if primates, humans, and dolphins are the only animals. If humans are primates, the result would still hold.
    
    Parameters:
    union - the union type
    partitions - the partition of the union type
    
    Returns:
    true if and only if the partitions fully cover the union type, false otherwise
  - getLowestCommonSupertype
```
public static AstClafer getLowestCommonSupertype(Iterable<AstClafer> unionType)
```
    Finds the lowest common supertype.
    
    Parameters:
    unionType - the union type
    
    Returns:
    the lowest common supertype of unionType
  - getLowestCommonSupertype
```
public static AstClafer getLowestCommonSupertype(AstClafer... unionType)
```
    Finds the lowest common supertype.
    
    Parameters:
    unionType - the union type
    
    Returns:
    the lowest common supertype of unionType
  - hasInheritedRef
```
public static boolean hasInheritedRef(AstClafer clafer)
```
  - getInheritedRef
```
public static AstRef getInheritedRef(AstClafer clafer)
```
    Find the reference belonging to the Clafer or the reference it inherited.
    
    Parameters:
    clafer - the Clafer
    
    Returns:
    the reference, or null if none exist
  - getNames
```
public static String[] getNames(AstVar... vars)
```
    Retrieve the names of the variables. Use the names for error messages rather than Object.toString().
    
    Parameters:
    vars - the variables
    
    Returns:
    the names of the variables
  - getNames
```
public static List<String> getNames(Iterable<? extends AstVar> vars)
```
    Retrieve the names of the Clafers. Use the names for error messages rather than Object.toString().
    
    Parameters:
    vars - the variables
    
    Returns:
    the names of the variables

Class AstUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getClafers

getConcreteClafers

getClafersInParentAndSubOrder

getAbstractClafersInSubOrder

getConcreteClafersInParentOrder

isRoot

isTypeRoot

isTop

getTopParent

getNestedClafers

getConcreteSubs

getNestedConstraints

getSupers

getSuperHierarchy

isAssignable

hasNonEmptyIntersectionType

isUnionType

getLowestCommonSupertype

getLowestCommonSupertype

hasInheritedRef

getInheritedRef

getNames

getNames