net.automatalib.words.abstractimpl

Class AbstractVPDAlphabet<I>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<I>

net.automatalib.words.abstractimpl.AbstractAlphabet<I>

net.automatalib.words.abstractimpl.AbstractVPDAlphabet<I>

All Implemented Interfaces:

Serializable, Iterable<I>, Collection<I>, Comparator<I>, IntFunction<I>, ToIntFunction<I>, List<I>, ArrayWritable<I>, Alphabet<I>, VPDAlphabet<I>

Direct Known Subclasses:

DefaultVPDAlphabet, GrowingVPDAlphabet

public abstract class AbstractVPDAlphabet<I>
extends AbstractAlphabet<I>
implements VPDAlphabet<I>

Abstract utility class that implements functionality shared across different subtypes.

Author:

frohme

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface net.automatalib.words.VPDAlphabet

VPDAlphabet.SymbolType

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
AbstractVPDAlphabet(Alphabet<I> internalAlphabet, Alphabet<I> callAlphabet, Alphabet<I> returnAlphabet)

Method Summary

Modifier and Type	Method and Description
boolean	containsSymbol(I symbol) Checks whether the given symbol is part of the alphabet.
Alphabet<I>	getCallAlphabet()
I	getCallSymbol(int index) The Alphabet.getSymbol(int) variant for the call alphabet.
int	getCallSymbolIndex(I symbol) The Alphabet.getSymbolIndex(Object) variant for the call alphabet.
Alphabet<I>	getInternalAlphabet()
I	getInternalSymbol(int index) The Alphabet.getSymbol(int) variant for the internal alphabet.
int	getInternalSymbolIndex(I symbol) The Alphabet.getSymbolIndex(Object) variant for the internal alphabet.
int	getNumCalls()
int	getNumInternals()
int	getNumReturns()
Alphabet<I>	getReturnAlphabet()
I	getReturnSymbol(int index) The Alphabet.getSymbol(int) variant for the return alphabet.
int	getReturnSymbolIndex(I symbol) The Alphabet.getSymbolIndex(Object) variant for the return alphabet.
I	getSymbol(int index) Returns the symbol with the given index in this alphabet.
int	getSymbolIndex(I symbol) Returns the index of the given symbol in the alphabet.
VPDAlphabet.SymbolType	getSymbolType(I symbol) Returns the symbol type of the given alphabet symbol.
int	size() The size of this container.

Methods inherited from class net.automatalib.words.abstractimpl.AbstractAlphabet

get

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.automatalib.words.VPDAlphabet

callReturnBalance, isCallMatched, isCallSymbol, isInternalSymbol, isReturnMatched, isReturnSymbol, isWellMatched, longestWellMatchedPrefix, longestWellMatchedSuffix

Methods inherited from interface net.automatalib.words.Alphabet

apply, applyAsInt, compare, translateFrom, writeToArray

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Constructor Detail

AbstractVPDAlphabet

public AbstractVPDAlphabet(Alphabet<I> internalAlphabet,
                           Alphabet<I> callAlphabet,
                           Alphabet<I> returnAlphabet)

Method Detail

getCallAlphabet

public Alphabet<I> getCallAlphabet()

Specified by:

getCallAlphabet in interface VPDAlphabet<I>

getCallSymbol

public I getCallSymbol(int index)

Description copied from interface: VPDAlphabet

The Alphabet.getSymbol(int) variant for the call alphabet.

Specified by:

getCallSymbol in interface VPDAlphabet<I>

Parameters:

index - the index of the symbol

getCallSymbolIndex

public int getCallSymbolIndex(I symbol)

Description copied from interface: VPDAlphabet

The Alphabet.getSymbolIndex(Object) variant for the call alphabet.

Specified by:

getCallSymbolIndex in interface VPDAlphabet<I>

Parameters:

symbol - the symbol whose index should be determined

getNumCalls

public int getNumCalls()

Specified by:

getNumCalls in interface VPDAlphabet<I>

getInternalAlphabet

public Alphabet<I> getInternalAlphabet()

Specified by:

getInternalAlphabet in interface VPDAlphabet<I>

getInternalSymbol

public I getInternalSymbol(int index)

Description copied from interface: VPDAlphabet

The Alphabet.getSymbol(int) variant for the internal alphabet.

Specified by:

getInternalSymbol in interface VPDAlphabet<I>

Parameters:

index - the index of the symbol

getInternalSymbolIndex

public int getInternalSymbolIndex(I symbol)

Description copied from interface: VPDAlphabet

The Alphabet.getSymbolIndex(Object) variant for the internal alphabet.

Specified by:

getInternalSymbolIndex in interface VPDAlphabet<I>

Parameters:

symbol - the symbol whose index should be determined

getNumInternals

public int getNumInternals()

Specified by:

getNumInternals in interface VPDAlphabet<I>

getReturnAlphabet

public Alphabet<I> getReturnAlphabet()

Specified by:

getReturnAlphabet in interface VPDAlphabet<I>

getReturnSymbol

public I getReturnSymbol(int index)

Description copied from interface: VPDAlphabet

The Alphabet.getSymbol(int) variant for the return alphabet.

Specified by:

getReturnSymbol in interface VPDAlphabet<I>

Parameters:

index - the index of the symbol

getReturnSymbolIndex

public int getReturnSymbolIndex(I symbol)

Description copied from interface: VPDAlphabet

The Alphabet.getSymbolIndex(Object) variant for the return alphabet.

Specified by:

getReturnSymbolIndex in interface VPDAlphabet<I>

Parameters:

symbol - the symbol whose index should be determined

getNumReturns

public int getNumReturns()

Specified by:

getNumReturns in interface VPDAlphabet<I>

getSymbolType

public VPDAlphabet.SymbolType getSymbolType(I symbol)

Description copied from interface: VPDAlphabet

Returns the symbol type of the given alphabet symbol.

Specified by:

getSymbolType in interface VPDAlphabet<I>

Parameters:

symbol - the symbol whose type should be returned

Returns:

the symbol type of the given alphabet symbol.

size

public int size()

Description copied from interface: ArrayWritable

The size of this container.

Specified by:

size in interface Collection<I>

Specified by:

size in interface List<I>

Specified by:

size in interface ArrayWritable<I>

Specified by:

size in class AbstractCollection<I>

getSymbol

public I getSymbol(int index)

Description copied from interface: Alphabet

Returns the symbol with the given index in this alphabet.

Specified by:

getSymbol in interface Alphabet<I>

Parameters:

index - the index of the requested symbol.

Returns:

symbol with the given index.

getSymbolIndex

public int getSymbolIndex(I symbol)

Description copied from interface: Alphabet

Returns the index of the given symbol in the alphabet.

Specified by:

getSymbolIndex in interface Alphabet<I>

Parameters:

symbol - the symbol whose index should be determined

containsSymbol

public boolean containsSymbol(I symbol)

Description copied from interface: Alphabet

Checks whether the given symbol is part of the alphabet.

Caution: the default implementation is rather inefficient and should be overridden, if possible.

Specified by:

containsSymbol in interface Alphabet<I>

Parameters:

symbol - the symbol to check

Returns:

true iff the symbol is part of the alphabet