at.jku.risc.stout.nau.data.atom

Class FunctionSymbol

java.lang.Object

at.jku.risc.stout.nau.data.atom.FunctionSymbol

All Implemented Interfaces:

HasSort<SortData>

public class FunctionSymbol
extends Object
implements HasSort<SortData>

A FunctionSymbol has a unique name and may be typed by a sort of data. The arity and the sorts of its arguments can be specified explicitly. If the arity is unknown, then the value is set to -1 (see isArityUnknown()).

Author:

Alexander Baumgartner

Constructor Summary

Constructors

Constructor and Description
FunctionSymbol(String name) Instantiates a function symbol of the specified name.

Method Summary

Methods

Modifier and Type	Method and Description
int	getArity() Returns the arity which has been set by the user or could be inferred by the type system.
String	getName()
SortData	getSort()
Sort[]	getSortArgs()
boolean	isArityUnknown() Returns true if the arity has not been set and could not be inferred so far.
void	setArity(int arity) Sets the arity and checks whether it is consistent with the defined sorts of the arguments.
void	setSort(SortData sortRet)
void	setSortArgs(Sort[] sortArgs) Defines the sorts of the arguments and checks whether it is consistent with the defined arity.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FunctionSymbol

public FunctionSymbol(String name)

Instantiates a function symbol of the specified name. Use the NodeFactory to create new FunctionSymbols! The use of NodeFactory guarantees the uniqueness of equal FunctionSymbols. This uniqueness enables very fast equality testing, hash-code generation, comparison of symbols,... and it keeps the memory overhead as small as possible.

Method Detail

getArity

public int getArity()

Returns the arity which has been set by the user or could be inferred by the type system.

getName

public String getName()

getSort

public SortData getSort()

Specified by:

getSort in interface HasSort<SortData>

getSortArgs

public Sort[] getSortArgs()

isArityUnknown

public boolean isArityUnknown()

Returns true if the arity has not been set and could not be inferred so far.

setArity

public void setArity(int arity)
              throws MalformedSortException

Sets the arity and checks whether it is consistent with the defined sorts of the arguments.

Throws:

MalformedSortException

setSort

public void setSort(SortData sortRet)

Specified by:

setSort in interface HasSort<SortData>

setSortArgs

public void setSortArgs(Sort[] sortArgs)
                 throws MalformedSortException

Defines the sorts of the arguments and checks whether it is consistent with the defined arity.

Throws:

MalformedSortException

toString

public String toString()

Overrides:

toString in class Object