org.btrplace.btrpsl.element

Class DefaultBtrpOperand

java.lang.Object

org.btrplace.btrpsl.element.DefaultBtrpOperand

All Implemented Interfaces:

BtrpOperand, Copyable<BtrpOperand>

Direct Known Subclasses:

BtrpElement, BtrpNumber, BtrpSet, BtrpString, IgnorableOperand

public abstract class DefaultBtrpOperand
extends Object
implements BtrpOperand

An abstract operand.

Author:

Fabien Hermenier

Nested Class Summary

Nested classes/interfaces inherited from interface org.btrplace.btrpsl.element.BtrpOperand

BtrpOperand.Type

Constructor Summary

Constructors

Constructor and Description
DefaultBtrpOperand()

Method Summary

Modifier and Type	Method and Description
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.
static String	prettyType(BtrpOperand o) Generate a pretty type for an operand.
static String	prettyType(int degree, BtrpOperand.Type t) Pretty textual representation of a given 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.btrplace.btrpsl.element.BtrpOperand

degree, type

Methods inherited from interface org.btrplace.Copyable

copy

Constructor Detail

DefaultBtrpOperand

public DefaultBtrpOperand()

Method Detail

label

public String label()

Description copied from interface: BtrpOperand

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

Specified by:

label in interface BtrpOperand

Returns:

a String if the operand is a variable. null otherwise

setLabel

public void setLabel(String lbl)

Description copied from interface: BtrpOperand

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

Specified by:

setLabel in interface BtrpOperand

Parameters:

lbl - the label to use

not

public BtrpOperand not()

Description copied from interface: BtrpOperand

Compute the opposite of the operand.

Specified by:

not in interface BtrpOperand

Returns:

the opposite operand

power

public BtrpOperand power(BtrpOperand nb)

Description copied from interface: BtrpOperand

Computes the power of this operand.

Specified by:

power in interface BtrpOperand

Parameters:

nb - the power coefficient. Must be strictly positive

Returns:

the result of the operation

plus

public BtrpOperand plus(BtrpOperand other)

Description copied from interface: BtrpOperand

Computes the addition of this operand with another one.

Specified by:

plus in interface BtrpOperand

Parameters:

other - the other operand

Returns:

the result of the addition

minus

public BtrpOperand minus(BtrpOperand other)

Description copied from interface: BtrpOperand

Computes the difference between this operand and another one.

Specified by:

minus in interface BtrpOperand

Parameters:

other - the other operand

Returns:

the result of the difference

negate

public BtrpOperand negate()

Description copied from interface: BtrpOperand

Computes the negation of this operand.

Specified by:

negate in interface BtrpOperand

Returns:

the result of the negation

times

public BtrpOperand times(BtrpOperand other)

Description copied from interface: BtrpOperand

Multiply this operand by another one

Specified by:

times in interface BtrpOperand

Parameters:

other - the other operand

Returns:

the result of the negation

div

public BtrpOperand div(BtrpOperand other)

Description copied from interface: BtrpOperand

Divides this operand by another one.

Specified by:

div in interface BtrpOperand

Parameters:

other - the other operand

Returns:

the result of the division

remainder

public BtrpOperand remainder(BtrpOperand other)

Description copied from interface: BtrpOperand

Computes the remainder of this operand division by another one

Specified by:

remainder in interface BtrpOperand

Parameters:

other - the other operand

Returns:

the remainder of the division

eq

public BtrpNumber eq(BtrpOperand other)

Description copied from interface: BtrpOperand

Check if this operand is equals to another one.

Specified by:

eq in interface BtrpOperand

Parameters:

other - the operand to compare to

Returns:

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

geq

public BtrpNumber geq(BtrpOperand other)

Description copied from interface: BtrpOperand

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

Specified by:

geq in interface BtrpOperand

Parameters:

other - the operand to compare to

Returns:

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

gt

public BtrpNumber gt(BtrpOperand other)

Description copied from interface: BtrpOperand

Check if this operand is strictly greater than another one.

Specified by:

gt in interface BtrpOperand

Parameters:

other - the operand to compare to

Returns:

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

prettyType

public String prettyType()

Pretty textual representation of the element type.

Specified by:

prettyType in interface BtrpOperand

Returns:

a String

prettyType

public static String prettyType(BtrpOperand o)

Generate a pretty type for an operand.

Parameters:

o - the operand

Returns:

a string that describes the operand type.

prettyType

public static String prettyType(int degree,
                                BtrpOperand.Type t)

Pretty textual representation of a given element type.

Parameters:

degree - 0 for a literal, 1 for a set, 2 for a set of sets, ...

t - the literal

Returns:

a String