org.btrplace.btrpsl.element

Interface BtrpOperand

All Superinterfaces:

Copyable<BtrpOperand>

All Known Implementing Classes:

BtrpElement, BtrpNumber, BtrpSet, BtrpString, DefaultBtrpOperand, IgnorableOperand

public interface BtrpOperand
extends Copyable<BtrpOperand>

Interface specifying an operand with its types and the available operation it may be involved into.

Author:

Fabien Hermenier

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BtrpOperand.Type The possible operand type.

Method Summary

Modifier and Type	Method and Description
int	degree() Get the degree of the operand.
BtrpOperand	div(BtrpOperand other) Divides this operand by another one.
BtrpNumber	eq(BtrpOperand other) Check if this operand is equals to another one.
BtrpNumber	geq(BtrpOperand other) Check if this operand is greater or equals to another one.
BtrpNumber	gt(BtrpOperand other) Check if this operand is strictly greater than another one.
String	label() Get the label of the operand.
BtrpOperand	minus(BtrpOperand other) Computes the difference between this operand and another one.
BtrpOperand	negate() Computes the negation of this operand.
BtrpOperand	not() Compute the opposite of the operand.
BtrpOperand	plus(BtrpOperand other) Computes the addition of this operand with another one.
BtrpOperand	power(BtrpOperand nb) Computes the power of this operand.
String	prettyType() Pretty textual representation of the element type.
BtrpOperand	remainder(BtrpOperand other) Computes the remainder of this operand division by another one
void	setLabel(String lbl) Set the label of the operand.
BtrpOperand	times(BtrpOperand other) Multiply this operand by another one
BtrpOperand.Type	type() Get the type of the operand.

Methods inherited from interface org.btrplace.Copyable

copy

Method Detail

not

BtrpOperand not()

Compute the opposite of the operand.

Returns:

the opposite operand

type

BtrpOperand.Type type()

Get the type of the operand.

Returns:

a type

degree

int degree()

Get the degree of the operand. A degree of 0 indicates a single value. A degree of 1 indicates a set of single value. A degree of 2 indicate a set of set of values. Basically. An operand with a degree n is a set of elements with all having the degree n - 1

Returns:

a positive integer

label

String label()

Get the label of the operand. An operand with a label is a variable.

Returns:

a String if the operand is a variable. null otherwise

setLabel

void setLabel(String lbl)

Set the label of the operand. The operand will then be considered as a variable.

Parameters:

lbl - the label to use

power

BtrpOperand power(BtrpOperand nb)

Computes the power of this operand.

Parameters:

nb - the power coefficient. Must be strictly positive

Returns:

the result of the operation

plus

BtrpOperand plus(BtrpOperand other)

Computes the addition of this operand with another one.

Parameters:

other - the other operand

Returns:

the result of the addition

minus

BtrpOperand minus(BtrpOperand other)

Computes the difference between this operand and another one.

Parameters:

other - the other operand

Returns:

the result of the difference

negate

BtrpOperand negate()

Computes the negation of this operand.

Returns:

the result of the negation

times

BtrpOperand times(BtrpOperand other)

Multiply this operand by another one

Parameters:

other - the other operand

Returns:

the result of the negation

div

BtrpOperand div(BtrpOperand other)

Divides this operand by another one.

Parameters:

other - the other operand

Returns:

the result of the division

remainder

BtrpOperand remainder(BtrpOperand other)

Computes the remainder of this operand division by another one

Parameters:

other - the other operand

Returns:

the remainder of the division

eq

BtrpNumber eq(BtrpOperand other)

Check if this operand is equals to another one.

Parameters:

other - the operand to compare to

Returns:

BtrpNumber.TRUE if both operand are equals, BtrpNumber.FALSE otherwise

geq

BtrpNumber geq(BtrpOperand other)

Check if this operand is greater or equals to another one.

Parameters:

other - the operand to compare to

Returns:

BtrpNumber.TRUE if this operand is greater or equals, BtrpNumber.FALSE otherwise

gt

BtrpNumber gt(BtrpOperand other)

Check if this operand is strictly greater than another one.

Parameters:

other - the operand to compare to

Returns:

BtrpNumber.TRUE if this operand is strictly greater, BtrpNumber.FALSE otherwise

prettyType

String prettyType()

Pretty textual representation of the element type.

Returns:

a String