cetus.analysis

Class Section

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Section.ELEMENT>

cetus.analysis.Section

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Section.ELEMENT>, java.util.Collection<Section.ELEMENT>, java.util.List<Section.ELEMENT>, java.util.RandomAccess

public class Section
extends java.util.ArrayList<Section.ELEMENT>
implements java.lang.Cloneable

Class Section represents a list of array subscripts that expresses a subset of the whole array elements. Each element in the list should be an object of Section.ELEMENT.

See Also:

Section.ELEMENT, Section.MAP, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Section.ELEMENT Represents the elements contained in a section.
static class	Section.MAP Class MAP represents map from variables to their sections.

Constructor Summary

Constructors

Constructor and Description
Section(ArrayAccess acc) Constructs a section with the specified array access.
Section(int dimension) Constructs a section with the specified dimension.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(Section.ELEMENT elem) Adds a new element in the section.
Section	clone() Clones a section object.
boolean	containsSymbols(java.util.Set<Symbol> vars) Checks if the section contains the specified variables.
Section	differenceFrom(Section other, RangeDomain rd) Performs difference operation between two sections with the specified range domain.
void	expandMay(RangeDomain rd, java.util.Set<Symbol> vars) Expand every section under the constraints given by the range domain.
void	expandMust(RangeDomain rd, java.util.Set<Symbol> ivs, java.util.Set<Symbol> vars) Expand every section under the constraints given by the range domain.
int	getDimension() returns a dimension
Section	intersectWith(Section other, RangeDomain rd) Performs intersection operation between two sections with the specified range domain.
boolean	isArray() Checks if the section is for an array variable.
boolean	isScalar() Checks if the section is for a scalar variable.
void	removeAffected(Symbol var) Removes section elements that contain the specified variable.
void	removeSideAffected(FunctionCall fc) Removes section elements that is affected by the specified function call.
void	substituteForward(RangeDomain rd, java.util.Set<Symbol> avoid) Substitutes any variables having symbolic constant values in the section avoiding cases that produces expression having a variable in the "avoid" set.
java.lang.String	toString() Converts this section to a string.
Section	unionWith(Section other, RangeDomain rd) Performs union operation between two sections with the specified range domain.

Methods inherited from class java.util.ArrayList

add, addAll, addAll, clear, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Constructor Detail

Section

public Section(int dimension)

Constructs a section with the specified dimension.

Parameters:

dimension - the dimension of the array. -1 for scalar variables.

Section

public Section(ArrayAccess acc)

Constructs a section with the specified array access.

Parameters:

acc - the array access expression.

Method Detail

clone

public Section clone()

Clones a section object.

Overrides:

clone in class java.util.ArrayList<Section.ELEMENT>

Returns:

the cloned section.

add

public boolean add(Section.ELEMENT elem)

Adds a new element in the section.

Specified by:

add in interface java.util.Collection<Section.ELEMENT>

Specified by:

add in interface java.util.List<Section.ELEMENT>

Overrides:

add in class java.util.ArrayList<Section.ELEMENT>

Parameters:

elem - the new element to be added.

Returns:

true (as per the general contract of Collection.add).

getDimension

public int getDimension()

returns a dimension

isScalar

public boolean isScalar()

Checks if the section is for a scalar variable.

isArray

public boolean isArray()

Checks if the section is for an array variable.

containsSymbols

public boolean containsSymbols(java.util.Set<Symbol> vars)

Checks if the section contains the specified variables.

expandMay

public void expandMay(RangeDomain rd,
             java.util.Set<Symbol> vars)

Expand every section under the constraints given by the range domain.

Parameters:

rd - the given range domain.

vars - the set of symbols to be expanded.

expandMust

public void expandMust(RangeDomain rd,
              java.util.Set<Symbol> ivs,
              java.util.Set<Symbol> vars)

Expand every section under the constraints given by the range domain.

Parameters:

rd - the given range domain.

ivs - the set of symbols to be expanded.

vars - the set of symbols that should not be part of the expansion.

substituteForward

public void substituteForward(RangeDomain rd,
                     java.util.Set<Symbol> avoid)

Substitutes any variables having symbolic constant values in the section avoiding cases that produces expression having a variable in the "avoid" set.

intersectWith

public Section intersectWith(Section other,
                    RangeDomain rd)

Performs intersection operation between two sections with the specified range domain.

Parameters:

other - the section being intersected with.

rd - the supporting range domain.

Returns:

the resulting section.

unionWith

public Section unionWith(Section other,
                RangeDomain rd)

Performs union operation between two sections with the specified range domain.

Parameters:

other - the section being unioned with.

rd - the supporting range domain.

Returns:

the resulting section.

differenceFrom

public Section differenceFrom(Section other,
                     RangeDomain rd)

Performs difference operation between two sections with the specified range domain.

Parameters:

other - the other section from which this section is differenced.

rd - the supporting range domain.

Returns:

the resulting section.

removeAffected

public void removeAffected(Symbol var)

Removes section elements that contain the specified variable.

removeSideAffected

public void removeSideAffected(FunctionCall fc)

Removes section elements that is affected by the specified function call.

toString

public java.lang.String toString()

Converts this section to a string.

Overrides:

toString in class java.util.AbstractCollection<Section.ELEMENT>

Returns:

the string representation of the section.