upsimulator.interfaces

Interface Dimensional

All Known Subinterfaces:

Membrane, Name, Obj, Rule

All Known Implementing Classes:

BasicName, BooleanCondition, InhibitorCondition, MembraneCreateResult, MembraneDivisionResult, ObjectCondition, ObjectConditionsWithTarget, ObjectResult, PMembrane, PNumericObject, PObject, PositionResult, PositionResult.Target, PromoterCondition, PRule

public interface Dimensional

Defines the functions of classes which have dimensions

Author:

quan

Method Summary

Modifier and Type	Method and Description
void	addDimension(Dimension dimension) Add new dimensions to an instance of Dimensional.
void	addDimension(java.lang.Long dimension) Add new fixed dimensions to an instance of Dimensional.
void	addDimension(java.lang.String dimension) Add new formula dimensions to an instance of dimension.
Dimensional	deepClone() Deep clone a Dimensional
void	fix(java.util.Map<java.lang.String,java.lang.Object> mappedValues) Fix all the dimension by calculating them using the mapped values
Dimension	get(int i) Get the i-th dimension
java.util.List<Dimension>	getDimensions() Get all the dimensions of an instance
int	getDimensionSize() Return the number of total dimensions
boolean	isFixed() Check if all the dimensions are fixed
java.util.List<java.lang.Long[]>	predictPossibleValue(Membrane membrane, java.util.List<Dimension> dList) Predict the possible values in this membrane

Method Detail

addDimension

void addDimension(Dimension dimension)

Add new dimensions to an instance of Dimensional. For example, a[i+1] have a dimension i+1 and i+1 should be added to a.

Parameters:

dimension - dimensions

addDimension

void addDimension(java.lang.Long dimension)

Add new fixed dimensions to an instance of Dimensional. For example, a[1] have a dimension 1 and 1 should be added to a.

Parameters:

dimension - dimensions

addDimension

void addDimension(java.lang.String dimension)

Add new formula dimensions to an instance of dimension. For example, a[i+1] have a dimension i+1 and i+1 should be added to a.

Parameters:

dimension - dimensions

getDimensions

java.util.List<Dimension> getDimensions()

Get all the dimensions of an instance

Returns:

dimensions

fix

void fix(java.util.Map<java.lang.String,java.lang.Object> mappedValues)

Fix all the dimension by calculating them using the mapped values

Parameters:

mappedValues - mapped values

isFixed

boolean isFixed()

Check if all the dimensions are fixed

Returns:

true if all the dimensions are fixed, and if getDimensionSize()==0 return true, else return false

getDimensionSize

int getDimensionSize()

Return the number of total dimensions

Returns:

the number of total dimensions

get

Dimension get(int i)

Get the i-th dimension

Parameters:

i - index of dimension wanted

Returns:

i-th dimension

deepClone

Dimensional deepClone()

Deep clone a Dimensional

Returns:

cloned Dimensional

predictPossibleValue

java.util.List<java.lang.Long[]> predictPossibleValue(Membrane membrane,
                                                      java.util.List<Dimension> dList)

Predict the possible values in this membrane

Parameters:

membrane - targetMembrane

dList - the list of dimensions which want to be predicted their value

Returns:

possible value list for all dimensions. If dimension is fixed, null will be returned