claw.tatsu.xcodeml.abstraction

Class DimensionDefinition

java.lang.Object

claw.tatsu.xcodeml.abstraction.DimensionDefinition

public class DimensionDefinition
extends java.lang.Object

Class holding information about defined dimension.

Author:

clementval

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_DIM
static java.lang.String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
DimensionDefinition(java.lang.String id, java.lang.String lowerBound, java.lang.String upperBound) Constructs a new dimension object from the extracted information.

Method Summary

Modifier and Type	Method and Description
DimensionDefinition	copy() Create a new copy of the current dimension definition.
Xnode	generateAllocateNode(XcodeProgram xcodeml) Generate additional node to be inserted in the allocate statement arrayIndex based on the dimension definition.
Xnode	generateArrayIndex(XcodeML xcodeml) Generate the array index that will be placed in the array reference for this additional dimension.
Xnode	generateIndexRange(XcodeML xcodeml, boolean withStep) Generate the correct indexRange element with lowerBound, upperBound and step from the current dimension.
java.lang.String	getIdentifier() Get the identifier for the current dimension.
InsertionPosition	getInsertionPosition() Get the insertion position value for this dimension definition.
BoundDefinition	getLowerBound() Get lower bound definition.
BoundDefinition	getUpperBound() Get upper bound definition.
void	setInsertionPosition(InsertionPosition position) Set the insertion position value for this dimension definition.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SEPARATOR

public static final java.lang.String SEPARATOR

See Also:

Constant Field Values

BASE_DIM

public static final java.lang.String BASE_DIM

See Also:

Constant Field Values

Constructor Detail

DimensionDefinition

public DimensionDefinition(java.lang.String id,
                           java.lang.String lowerBound,
                           java.lang.String upperBound)

Constructs a new dimension object from the extracted information.

Parameters:

id - Identifier of the defined dimension. Will be used as the array index variable.

lowerBound - Lower bound of the dimension.

upperBound - Upper bound of the dimension. TODO maybe add step information (in the grammar as well)

Method Detail

getLowerBound

public BoundDefinition getLowerBound()

Get lower bound definition.

Returns:

lower bound definition.

getUpperBound

public BoundDefinition getUpperBound()

Get upper bound definition.

Returns:

upper bound definition.

getIdentifier

public java.lang.String getIdentifier()

Get the identifier for the current dimension.

Returns:

The identifier of the current dimension.

getInsertionPosition

public InsertionPosition getInsertionPosition()

Get the insertion position value for this dimension definition.

Returns:

InsertionPosition enum value.

setInsertionPosition

public void setInsertionPosition(InsertionPosition position)

Set the insertion position value for this dimension definition.

Parameters:

position - InsertionPosition enum value.

generateIndexRange

public Xnode generateIndexRange(XcodeML xcodeml,
                                boolean withStep)

Generate the correct indexRange element with lowerBound, upperBound and step from the current dimension.

Parameters:

xcodeml - Current XcodeML program unit in which elements will be created.

withStep - IF true, step element is created.

Returns:

A new indexRange elements.

generateArrayIndex

public Xnode generateArrayIndex(XcodeML xcodeml)

Generate the array index that will be placed in the array reference for this additional dimension.

Parameters:

xcodeml - Current XcodeML program unit.

Returns:

A new arrayIndex element including a var element with the dimension identifier.

generateAllocateNode

public Xnode generateAllocateNode(XcodeProgram xcodeml)

Generate additional node to be inserted in the allocate statement arrayIndex based on the dimension definition.

Parameters:

xcodeml - Current XcodeML program unit.

Returns:

New node to be inserted in arrayIndex of allocate statement.

copy

public DimensionDefinition copy()

Create a new copy of the current dimension definition.

Returns:

A newly created copy of this dimension definition.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object