model

Class AbstractOperator

java.lang.Object

model.AbstractOperator

All Implemented Interfaces:

Clause, PCExpression

Direct Known Subclasses:

And, Not

public abstract class AbstractOperator
extends Object
implements Clause

This class is the abstract class that gathers all the operator classes. It implements Clause.

Author:

Alexandre Camus

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Clause>	operands

Constructor Summary

Constructors

Constructor and Description
AbstractOperator(Clause... operands) Constructor of the class.
AbstractOperator(List<Clause> operands) Constructor of the class.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract AbstractOperator	create(List<Clause> operands) Generic constructor of sub-objects.
Clause	getFirstOperand() Gets the first positive operand of the operator.
Clause	getOperand(int index) Gets the operand number index.
List<Clause>	getOperands() Gets all the operands of the operator.
Clause	getOperatorTail() Gets the tail of the operator.
boolean	isEmpty() Checks if the operator has operands or not.
int	operandCount() Gets the size of the operator in terms of operands.
AbstractOperator	replaceVariables(SubstitutionSet s) Replaces all the variables in the clause according to the specified bindings.
void	setOperands(List<Clause> operands) Sets all the operands to the specified operands.
AbstractOperator	standardizeVariablesApart(Hashtable<Variable,Variable> newVars) Standardizes the variables in order to be sure that there won't be any variable clashes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface model.Clause

getSolver

Field Detail

operands

protected List<Clause> operands

Constructor Detail

AbstractOperator

public AbstractOperator(Clause... operands)

Constructor of the class.

Parameters:

operands - the operands of the operator in an array or as independent variables.

AbstractOperator

public AbstractOperator(List<Clause> operands)

Constructor of the class.

Parameters:

operands - the operands of the operator in an List object.

Method Detail

setOperands

public void setOperands(List<Clause> operands)

Sets all the operands to the specified operands.

Parameters:

operands - the new operands in an List object.

operandCount

public int operandCount()

Gets the size of the operator in terms of operands.

Returns:

the number of operands of the operator.

getOperand

public Clause getOperand(int index)

Gets the operand number index.

Parameters:

index - of the operand to get.

Returns:

return the operand number index.

getFirstOperand

public Clause getFirstOperand()

Gets the first positive operand of the operator.

Returns:

the first operand.

getOperatorTail

public Clause getOperatorTail()

Gets the tail of the operator. An operator is seen as its head (the first operand) and its tail (all the other operands).

Returns:

the tail of the operator as an object of the same class if there are several tail operands or as the operand itself if there is only one.

getOperands

public List<Clause> getOperands()

Gets all the operands of the operator.

Returns:

an List object containing all the operands of the operator.

isEmpty

public boolean isEmpty()

Checks if the operator has operands or not.

Returns:

true if the operator is empty.

create

protected abstract AbstractOperator create(List<Clause> operands)

Generic constructor of sub-objects. It allows the methods of the abstract class to create correct sub-objects very easily.

See Also:

And.create(java.util.List), Not.create(java.util.List)

replaceVariables

public AbstractOperator replaceVariables(SubstitutionSet s)

Replaces all the variables in the clause according to the specified bindings.

This method is recursive over all PCExpression implementations.

Specified by:

replaceVariables in interface PCExpression

Parameters:

s - the SubstitutionSet that contains the bindings of the variables so far.

Returns:

an object of the same class representing the bound clause.

See Also:

PCExpression.replaceVariables(model.SubstitutionSet)

standardizeVariablesApart

public AbstractOperator standardizeVariablesApart(Hashtable<Variable,Variable> newVars)

Standardizes the variables in order to be sure that there won't be any variable clashes.

This method is recursive over all PCExpression implementations.

Specified by:

standardizeVariablesApart in interface PCExpression

Parameters:

newVars - is a parameter to save over the recursion all the variable replacements done so far.

Returns:

an object of the same class representing the standardized clause.

See Also:

PCExpression.standardizeVariablesApart(java.util.Hashtable)