claw.tatsu.xcodeml.abstraction

Class PromotionInfo

java.lang.Object

claw.tatsu.xcodeml.abstraction.PromotionInfo

public class PromotionInfo
extends java.lang.Object

Hold various information about the promotion of a variable.

Author:

clementval

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PromotionInfo.PromotionType

Constructor Summary

Constructors

Constructor and Description
PromotionInfo() Default ctor.
PromotionInfo(java.lang.String id) Constructs a new PromotionInfo object with the identifier of the field associated with this promotion object.
PromotionInfo(java.lang.String id, int baseDimension, int targetDimension, java.lang.String targetType) Constructs a new PromotionInfo object with all its information.
PromotionInfo(java.lang.String id, java.util.List<DimensionDefinition> dimensions) Constructs a new PromotionInfo object with the identifier of the field associated with this promotion and the dimension definition used for promotion.

Method Summary

Modifier and Type	Method and Description
int	diffDimension() Get the number of dimension between the base and the target.
int	getBaseDimension() Get the number of base dimension.
java.util.List<DimensionDefinition>	getDimensions() Get the list of dimension definition used for promotion.
java.lang.String	getFormattedDimensions() Get a formatted String representing the dimensions used in this promotion information object.
java.lang.String	getIdentifier() Get the associated identifier.
PromotionInfo.PromotionType	getPromotionType() Get the promotion type.
int	getTargetDimension() Get the number of target dimension.
java.lang.String	getTargetType() Get the type id after the promotion.
boolean	isAllocateAdapted() Check if the allocate statements associated with this promotion have been adapted already.
boolean	isRefAdapted() Check if the references associated with this promotion have been adapted already.
void	readDimensionsFromString(java.lang.String rawValue) Read the dimension information from a raw string.
void	resterFlags() Reset adapted flags.
void	setAllocateAdapted() Flag that the allocate statements associated with this promotion have been adapted.
void	setBaseDimension(int value) Set the value of the base dimension number.
void	setDimensions(java.util.List<DimensionDefinition> dimensions) Set the list of dimension definitions to be used.
void	setPromotionType(PromotionInfo.PromotionType promotionType) Set the promotion type value.
void	setRefAdapted() Flag that the references associated with this promotion have been adapted.
void	setTargetDimension(int value) Set the value of the target dimension.
void	setTargetType(java.lang.String value) Set the value of the type after promotion.
boolean	wasScalar() Check whether the variable was a scalar before the promotion.

Methods inherited from class java.lang.Object

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

Constructor Detail

PromotionInfo

public PromotionInfo()

Default ctor. Used for global promotion information not attached to a field.

PromotionInfo

public PromotionInfo(java.lang.String id)

Constructs a new PromotionInfo object with the identifier of the field associated with this promotion object.

Parameters:

id - Field identifier.

PromotionInfo

public PromotionInfo(java.lang.String id,
                     java.util.List<DimensionDefinition> dimensions)

Constructs a new PromotionInfo object with the identifier of the field associated with this promotion and the dimension definition used for promotion.

Parameters:

id - Field identifier.

dimensions - List of dimension definitions to use for the promotion.

PromotionInfo

public PromotionInfo(java.lang.String id,
                     int baseDimension,
                     int targetDimension,
                     java.lang.String targetType)

Constructs a new PromotionInfo object with all its information.

Parameters:

id - Identifier of the promoted variable.

baseDimension - Number of dimensions before the promotion.

targetDimension - Number of dimensions after the promotion.

targetType - Type if after the promotion.

Method Detail

getDimensions

public java.util.List<DimensionDefinition> getDimensions()

Get the list of dimension definition used for promotion.

Returns:

List of dimension definitions.

setDimensions

public void setDimensions(java.util.List<DimensionDefinition> dimensions)

Set the list of dimension definitions to be used.

Parameters:

dimensions - List of dimension definitions.

getIdentifier

public java.lang.String getIdentifier()

Get the associated identifier.

Returns:

Identifier.

wasScalar

public boolean wasScalar()

Check whether the variable was a scalar before the promotion.

Returns:

True if the variable was a scalar. False otherwise.

getTargetType

public java.lang.String getTargetType()

Get the type id after the promotion.

Returns:

Type id.

setTargetType

public void setTargetType(java.lang.String value)

Set the value of the type after promotion.

Parameters:

value - Type hash value.

getTargetDimension

public int getTargetDimension()

Get the number of target dimension. After promotion.

Returns:

Number of dimension after promotion.

setTargetDimension

public void setTargetDimension(int value)

Set the value of the target dimension.

Parameters:

value - int value.

getBaseDimension

public int getBaseDimension()

Get the number of base dimension. Before promotion.

Returns:

Number of dimension before promotion.

setBaseDimension

public void setBaseDimension(int value)

Set the value of the base dimension number.

Parameters:

value - New value for the base dimension number.

diffDimension

public int diffDimension()

Get the number of dimension between the base and the target.

Returns:

Number of dimension.

getPromotionType

public PromotionInfo.PromotionType getPromotionType()

Get the promotion type.

Returns:

Current promotion type value.

setPromotionType

public void setPromotionType(PromotionInfo.PromotionType promotionType)

Set the promotion type value.

Parameters:

promotionType - New promotion type value.

getFormattedDimensions

public java.lang.String getFormattedDimensions()

Get a formatted String representing the dimensions used in this promotion information object. String is formatted as follows: - Dimension: dimension_id(lower_bound:upper_bound) - Existing dimensions are represented with : So a promotion information with 1 additional dimension will be formatted like: - New dimension before: "dimension_id(lower_bound:upper_bound),:" - New dimension in middle: ":,dimension_id(lower_bound:upper_bound),:" - New dimension after: ":,dimension_id(lower_bound:upper_bound)"

Returns:

Dimensions information in a formatted string.

isRefAdapted

public boolean isRefAdapted()

Check if the references associated with this promotion have been adapted already.

Returns:

True if the references were adapted. False otherwise.

setRefAdapted

public void setRefAdapted()

Flag that the references associated with this promotion have been adapted.

isAllocateAdapted

public boolean isAllocateAdapted()

Check if the allocate statements associated with this promotion have been adapted already.

Returns:

True if the references were adapted. False otherwise.

setAllocateAdapted

public void setAllocateAdapted()

Flag that the allocate statements associated with this promotion have been adapted.

resterFlags

public void resterFlags()

Reset adapted flags.

readDimensionsFromString

public void readDimensionsFromString(java.lang.String rawValue)

Read the dimension information from a raw string.

Parameters:

rawValue - Raw string representation of the dimension information.