hlt.language.design.types

Class TupleType

java.lang.Object

hlt.language.design.types.Type

hlt.language.design.types.StaticType

hlt.language.design.types.ConstructedType

hlt.language.design.types.TupleType

All Implemented Interfaces:

Valuable

Direct Known Subclasses:

NamedTupleType

public class TupleType
extends ConstructedType

This is the type of tuples whose components are identified by position.

Field Summary

Fields

Modifier and Type	Field and Description
static TupleType	EMPTY

Fields inherited from class hlt.language.design.types.Type

ARRAY, BAG, BOOLEAN, BOXABLE, CHAR, CLASS, COLLECTION, CONSTANT, DEFINED, FUNCTION, INT, INT_RANGE, INT_SORT, LIST, NAMED_TUPLE, OBJECT_SORT, PARAMETER, REAL, REAL_RANGE, REAL_SORT, SET, STRING, TUPLE, VOID, VOID_SORT

Method Summary

Methods

Modifier and Type	Method and Description
void	checkOccurrence(TypeParameter parameter, Type context, TypeChecker typeChecker) Throws a FailedUnificationException if the specified type parameter occurs in this type.
Type	component(int i)
Type[]	components()
Type	copy(java.util.HashMap parameters) Returns a copy of this type with a consistent renaming of all free type parameters, and identyfing bound type parameters with their values.
int	dimension()
int	eqCode() Returns a hash code for this type - the reason for using the name eqCode (rather than overriding hashCode), is that it is important to preserve the implementation of java.lang.Object.hashCode for type parameters (to be compatible with ==).
Type	flatten() Returns a flattened form of this type by uncurrying all the domains of all function types that occur in it.
java.util.HashSet	getParameters(java.util.HashSet set) Returns the specified set augmented with all the unbound type parameters that occur in this type.
Type	instantiate(java.util.HashMap substitution) Returns a copy of this type with all free type parameters bound as per the specified type substitution.
boolean	isEqualTo(Type type) Returns true iff this type is structurally isomorphic to the specified type.
boolean	isEqualTo(Type type, java.util.HashMap parameters) Returns true iff this type is structurally isomorphic to the specified type, under the renaming of type parameters specified by the given HashMap.
byte	kind() This returns the value identifying what kind of type this is.
static TupleType	newTupleType(java.util.AbstractList components)
static TupleType	newTupleType(Type[] components)
int	numberOfTypeComponents() Returns the number of type components making up this type.
void	setTypeRefComponent(int n, Type type) Sets the n-th undereferenced type component of this type to the specified type; throws a NoSuchTypeComponentException otherwise.
java.lang.String	toString()
Type	typeRefComponent(int n) Returns the n-th undereferenced type component in this type, if any; throws a NoSuchTypeComponentException otherwise.
boolean	unify(Type type) This unifies this type with the specified type with no possibility of undoing any effects.
void	unify(Type type, TypeChecker typeChecker) This unifies this type with the specified type in the context of the specified TypeChecker.

Methods inherited from class hlt.language.design.types.Type

actualType, array, array, baseType, baseTypeRef, BOOLEAN, BOXED_BOOLEAN, BOXED_CHAR, BOXED_INT, BOXED_REAL, boxSort, CHAR, copy, curry, equals, findValue, getParameters, getValue, INT, is, isBag, isBoolean, isBoxedType, isChar, isCollection, isGlobalUnsafe, isInt, isList, isPolymorphic, isPrimitive, isReal, isSet, isString, isVoid, kindString, rank, REAL, resetNames, setBoxed, shadowType, sort, standardize, toFullString, toQuantifiedString, toQuantifiedString, typeComponent, unwrapper, value, wrapper

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final TupleType EMPTY

Method Detail

numberOfTypeComponents

public final int numberOfTypeComponents()

Description copied from class: Type

Returns the number of type components making up this type.

Specified by:

numberOfTypeComponents in class Type

typeRefComponent

public final Type typeRefComponent(int n)
                            throws NoSuchTypeComponentException

Description copied from class: Type

Returns the n-th undereferenced type component in this type, if any; throws a NoSuchTypeComponentException otherwise.

Specified by:

typeRefComponent in class Type

Throws:

NoSuchTypeComponentException

setTypeRefComponent

public final void setTypeRefComponent(int n,
                       Type type)
                               throws NoSuchTypeComponentException

Description copied from class: Type

Sets the n-th undereferenced type component of this type to the specified type; throws a NoSuchTypeComponentException otherwise.

Specified by:

setTypeRefComponent in class Type

Throws:

NoSuchTypeComponentException

newTupleType

public static final TupleType newTupleType(Type[] components)

newTupleType

public static final TupleType newTupleType(java.util.AbstractList components)

kind

public byte kind()

Description copied from class: Type

This returns the value identifying what kind of type this is.

Specified by:

kind in class Type

component

public final Type component(int i)

components

public final Type[] components()

dimension

public final int dimension()

unify

public void unify(Type type,
         TypeChecker typeChecker)
           throws FailedUnificationException

Description copied from class: Type

This unifies this type with the specified type in the context of the specified TypeChecker.

Specified by:

unify in class Type

Throws:

FailedUnificationException

unify

public boolean unify(Type type)

Description copied from class: Type

This unifies this type with the specified type with no possibility of undoing any effects. This method is meant to be used on types that are fresh copies independent of any type-checker because it will side-effect the structures it traverses. It returns true iff unification succeeds. NB: This method does not perform the "occurs-check" test.

Specified by:

unify in class Type

checkOccurrence

public final void checkOccurrence(TypeParameter parameter,
                   Type context,
                   TypeChecker typeChecker)
                           throws FailedUnificationException

Description copied from class: Type

Throws a FailedUnificationException if the specified type parameter occurs in this type. The type context is the outermost type enclosing this.

N.B.: The following definition specifies only the default behavior for this method. Specific subclasses are generally expected to override this method.

Overrides:

checkOccurrence in class Type

Throws:

FailedUnificationException

getParameters

public final java.util.HashSet getParameters(java.util.HashSet set)

Description copied from class: Type

Returns the specified set augmented with all the unbound type parameters that occur in this type.

Overrides:

getParameters in class Type

flatten

public final Type flatten()

Description copied from class: Type

Returns a flattened form of this type by uncurrying all the domains of all function types that occur in it. It also trims all binding chains of type parameters that may occur in it. The form returned is the canonical form used for all types of defined symbols and is assumed for type equality tests to work.

N.B.: The following definition specifies only the default behavior for this method. Specific subclasses are generally expected to override this method.

Overrides:

flatten in class Type

copy

public Type copy(java.util.HashMap parameters)

Description copied from class: Type

Returns a copy of this type with a consistent renaming of all free type parameters, and identyfing bound type parameters with their values.

N.B.: The following definition specifies only the default behavior for this method. Specific subclasses are generally expected to override this method.

Overrides:

copy in class Type

instantiate

public Type instantiate(java.util.HashMap substitution)

Description copied from class: Type

Returns a copy of this type with all free type parameters bound as per the specified type substitution.

N.B.: The following definition specifies only the default behavior for this method. Specific subclasses are generally expected to override this method.

Overrides:

instantiate in class Type

eqCode

public final int eqCode()

Description copied from class: Type

Returns a hash code for this type - the reason for using the name eqCode (rather than overriding hashCode), is that it is important to preserve the implementation of java.lang.Object.hashCode for type parameters (to be compatible with ==). All we require with this new code is that it be compatible with type equality as defined by isEqualTo - and it is! Incidentally, the same reason goes for preserving equals for type parameters to be compatible with == - and it is (see TypeParameter).

Specified by:

eqCode in class Type

isEqualTo

public boolean isEqualTo(Type type)

Description copied from class: Type

Returns true iff this type is structurally isomorphic to the specified type. Two type parameters will be considered equal only if they are the same object (i.e., equal pointers).

Specified by:

isEqualTo in class Type

isEqualTo

public boolean isEqualTo(Type type,
                java.util.HashMap parameters)

Description copied from class: Type

Returns true iff this type is structurally isomorphic to the specified type, under the renaming of type parameters specified by the given HashMap.

Specified by:

isEqualTo in class Type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object