Signature (alto 2.2-SNAPSHOT API)

java.lang.Object
- de.up.ling.irtg.signature.Signature

All Implemented Interfaces:

Serializable
```
public class Signature
extends Object
implements Serializable
```
A ranked signature of symbols. This class maps between the symbols and their numeric symbol IDs, as an Interner would. In addition, it stores, for each symbol f, its arity, i.e. the number of children that a node with label f must have in a well-formed tree. Every symbol must have a unique arity.

Author:

koller

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Signature()
This creates a new, empty signature.

Constructors
Constructor and Description
`Signature()` This creates a new, empty signature.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAllConstants(Tree<HomomorphismSymbol> tree)` Adds all the constants from the tree to the signature.
`Tree<Integer>`	`addAllSymbols(Tree<String> tree)` Adds all the symbols in the tree to the signature and returns a new tree with all the symbols replaced their ids in the signature.
`int`	`addSymbol(String symbol, int arity)` Adds this symbol to the signature with the given arity.
`void`	`clear()` Removes all symbols from this signature.
`Object`	`clone()`
`boolean`	`contains(String symbol)` Returns true if the symbol is known to this signature.
`int`	`getArity(int symbolId)` Returns the arity of the symbol associated with the given id.
`int`	`getArityForLabel(String symbol)` Returns the arity of the given symbol in this signature.
`SignatureMapper`	`getIdentityMapper()` Obtains an identity mapper for this signature (every id is mapped to itself).
`int`	`getIdForSymbol(String symbol)` Obtains the id for the given symbol.
`SignatureMapper`	`getMapperTo(Signature other)` Obtains a signature mapper between this signature on the given other signature.
`int`	`getMaxArity()` Returns the maximum arity of any symbol in this signature.
`int`	`getMaxSymbolId()` Returns the highest symbol ID that has been used in this signature.
`Collection<String>`	`getSymbols()` Obtains a collection of all the symbols known to the signature.
`Map<String,Integer>`	`getSymbolsWithArities()` Returns a map which contains the pairs of symbols and arities known to this signature.
`boolean`	`isWritable()` Can be used to check whether this signature can be printed.
`int[]`	`remap(Signature other)` Returns an arrary x such that the symbol with ID i in this signature is the same as the symbol with ID x[i] in the other signature.
`Tree<String>`	`resolve(Tree<Integer> tree)` Returns a new tree with all the integers replaced by the symbols associated with these integers in this signature.
`String`	`resolveSymbolId(int id)` Returns the symbol associated with the given id, or null if no such symbol exists.
`Collection<String>`	`resolveSymbolIDs(IntCollection ids)` Collects all the symbols for the given list of ints.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Signature
```
public Signature()
```
    This creates a new, empty signature. Each signature can contains as many symbols as there are positive integers.
- Method Detail
  - getMapperTo
```
public SignatureMapper getMapperTo(Signature other)
```
    Obtains a signature mapper between this signature on the given other signature.
    
    Parameters:
    
    other -
    
    Returns:
  - getIdentityMapper
```
public SignatureMapper getIdentityMapper()
```
    Obtains an identity mapper for this signature (every id is mapped to itself).
    
    Returns:
  - clear
```
public void clear()
```
    Removes all symbols from this signature.
  - getSymbols
```
public Collection<String> getSymbols()
```
    Obtains a collection of all the symbols known to the signature.
    
    Returns:
  - getArityForLabel
```
public int getArityForLabel(String symbol)
```
    Returns the arity of the given symbol in this signature. The return value will be -1 if the symbol is not known.
    
    Parameters:
    
    symbol -
    
    Returns:
  - getArity
```
public int getArity(int symbolId)
```
    Returns the arity of the symbol associated with the given id. The return value will be -1 if the id is not known.
    
    Parameters:
    
    symbolId -
    
    Returns:
  - resolveSymbolId
```
public String resolveSymbolId(int id)
```
    Returns the symbol associated with the given id, or null if no such symbol exists.
    
    Parameters:
    
    id -
    
    Returns:
  - resolveSymbolIDs
```
public Collection<String> resolveSymbolIDs(IntCollection ids)
```
    Collects all the symbols for the given list of ints. If an id is not known, then null will be present in the collection.
    
    Parameters:
    
    ids -
    
    Returns:
  - getIdForSymbol
```
public int getIdForSymbol(String symbol)
```
    Obtains the id for the given symbol. Returns 0 if the symbol is not known.
    
    Parameters:
    
    symbol -
    
    Returns:
  - contains
```
public boolean contains(String symbol)
```
    Returns true if the symbol is known to this signature.
    
    Parameters:
    
    symbol -
    
    Returns:
  - addSymbol
```
public int addSymbol(String symbol,
                     int arity)
```
    Adds this symbol to the signature with the given arity. If the symbol is already assigned a different arity, then an UnsupportedOperationException will be thrown.
    
    Parameters:
    
    symbol -
    
    arity -
    
    Returns:
  - isWritable
```
public boolean isWritable()
```
    Can be used to check whether this signature can be printed.
    
    Returns:
  - getMaxSymbolId
```
public int getMaxSymbolId()
```
    Returns the highest symbol ID that has been used in this signature. Iterate over all symbol IDs by iterating from 1 to getMaxSymbolId() (inclusively).
    
    Returns:
  - getSymbolsWithArities
```
public Map<String,Integer> getSymbolsWithArities()
```
    Returns a map which contains the pairs of symbols and arities known to this signature.
    
    Returns:
  - resolve
```
public Tree<String> resolve(Tree<Integer> tree)
```
    Returns a new tree with all the integers replaced by the symbols associated with these integers in this signature. null trees will result in a RuntimeException. If a symbol is unknown then the string "null" will be inserted.
    
    Parameters:
    
    tree -
    
    Returns:
  - addAllSymbols
```
public Tree<Integer> addAllSymbols(Tree<String> tree)
```
    Adds all the symbols in the tree to the signature and returns a new tree with all the symbols replaced their ids in the signature. The arities for the symbols will be the number of children they have in the tree.
    
    Parameters:
    
    tree -
    
    Returns:
  - addAllConstants
```
public void addAllConstants(Tree<HomomorphismSymbol> tree)
```
    Adds all the constants from the tree to the signature. Note that this means that strings representing the int codes from the HomomorphismSymbol will be added. The arities are given by the number of children.
    
    Parameters:
    
    tree -
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - remap
```
public int[] remap(Signature other)
```
    Returns an arrary x such that the symbol with ID i in this signature is the same as the symbol with ID x[i] in the other signature. If the symbol does not exist in the other signature, x[i] will be 0.
    
    Parameters:
    
    other -
    
    Returns:
  - getMaxArity
```
public int getMaxArity()
```
    Returns the maximum arity of any symbol in this signature.
    
    Returns:

Class Signature

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Signature

Method Detail

getMapperTo

getIdentityMapper

clear

getSymbols

getArityForLabel

getArity

resolveSymbolId

resolveSymbolIDs

getIdForSymbol

contains

addSymbol

isWritable

getMaxSymbolId

getSymbolsWithArities

resolve

addAllSymbols

addAllConstants

clone

toString

remap

getMaxArity