Package org.tweetyproject.logics.fol.syntax

Class AssociativeFolFormula

java.lang.Object

org.tweetyproject.logics.commons.syntax.RelationalFormula

org.tweetyproject.logics.fol.syntax.FolFormula

org.tweetyproject.logics.fol.syntax.AssociativeFolFormula

All Implemented Interfaces:

java.lang.Iterable<RelationalFormula>, java.util.Collection<RelationalFormula>, java.util.List<RelationalFormula>, Formula, AssociativeFormulaSupport.AssociativeSupportBridge, AssociativeFormula<RelationalFormula>, ClassicalFormula, ComplexLogicalFormula, Conjunctable, Disjunctable, Invertable, LogicStructure, ProbabilityAware, QuantifiedFormula, SimpleLogicalFormula

Direct Known Subclasses:

Conjunction, Disjunction, ExclusiveDisjunction

public abstract class AssociativeFolFormula
extends FolFormula
implements AssociativeFormula<RelationalFormula>, AssociativeFormulaSupport.AssociativeSupportBridge

This class captures the common functionalities first order associative formulas like conjunction, disjunction, etc.

Author:

Matthias Thimm, Tim Janus

Constructor Summary

Constructors

Constructor	Description
AssociativeFolFormula()	Creates a new (empty) associative formula.
AssociativeFolFormula(java.util.Collection<? extends RelationalFormula> formulas)	Creates a new associative formula with the given inner formulas.
AssociativeFolFormula(RelationalFormula first, RelationalFormula second)	Creates a new associative formula with the two given formulae

Method Summary

Modifier and Type	Method	Description
void	add(int index, RelationalFormula element)
boolean	add(RelationalFormula e)
boolean	add(FolFormula... formulas)	Adds the specified elements to the end of this collection (optional operation).
boolean	addAll(int index, java.util.Collection<? extends RelationalFormula> c)
boolean	addAll(java.util.Collection<? extends RelationalFormula> c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
boolean	containsQuantifier()	Checks whether this formula contains any quantification.
Signature	createEmptySignature()
boolean	equals(java.lang.Object obj)
RelationalFormula	get(int index)
java.util.Set<FolAtom>	getAtoms()	Processes the set of all atoms which appear in this formula
java.util.List<RelationalFormula>	getFormulas()
<C extends SimpleLogicalFormula> java.util.Set<C>	getFormulas(java.lang.Class<C> cls)	Process the formulas of type C that are children of this associative formula
java.util.Set<Functor>	getFunctors()
java.util.Set<? extends Predicate>	getPredicates()	Processes the set of all predicates which appear in this formula
java.util.Set<Variable>	getQuantifierVariables()
java.util.Set<Term<?>>	getTerms()
<C extends Term<?>> java.util.Set<C>	getTerms(java.lang.Class<C> cls)	Processes the set containing all terms of type C.
java.util.Set<Variable>	getUnboundVariables()
int	hashCode()
int	indexOf(java.lang.Object o)
boolean	isClosed()	Checks whether this formula is closed, i.e.
boolean	isClosed(java.util.Set<Variable> boundVariables)	Checks whether this formula is closed, i.e.
boolean	isEmpty()
boolean	isLiteral()
boolean	isWellBound()	Checks whether this formula is well-bound, i.e.
boolean	isWellBound(java.util.Set<Variable> boundVariables)	Checks whether this formula is well-bound, i.e.
java.util.Iterator<RelationalFormula>	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator<RelationalFormula>	listIterator()
java.util.ListIterator<RelationalFormula>	listIterator(int index)
RelationalFormula	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
RelationalFormula	set(int index, RelationalFormula element)
int	size()
java.util.List<RelationalFormula>	subList(int fromIndex, int toIndex)
AssociativeFolFormula	substitute(java.util.Map<? extends Term<?>,? extends Term<?>> termMap)	Substitutes all occurrences of all terms "v" in map.keyset() in this formula by map.get(v) and returns the new formula. NOTE: variables bound to quantifiers are not substituted in their inner formulas even if they appear in the map.
AssociativeFolFormula	substitute(Term<?> v, Term<?> t)	Substitutes all occurrences of term "v" in this formula by term "t" and returns the new formula.
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
java.lang.String	toString()

Methods inherited from class org.tweetyproject.logics.fol.syntax.FolFormula

clone, collapseAssociativeFormulas, combineWithAnd, combineWithOr, complement, getSignature, getUniformProbability, isDnf, toDnf, toNnf

Methods inherited from class org.tweetyproject.logics.commons.syntax.RelationalFormula

allGroundInstances, allSubstitutions, containsTermsOfType, exchange, getFormula, getPredicateCls, getSatisfactionRatio, isGround, isWellFormed

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tweetyproject.logics.commons.syntax.AssociativeFormulaSupport.AssociativeSupportBridge

createEmptyFormula, getEmptySymbol, getOperatorSymbol

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.tweetyproject.commons.Formula

getSignature

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface org.tweetyproject.logics.commons.syntax.interfaces.SimpleLogicalFormula

getPredicateCls

Constructor Detail

AssociativeFolFormula

public AssociativeFolFormula()

Creates a new (empty) associative formula.

AssociativeFolFormula

public AssociativeFolFormula(RelationalFormula first,
                             RelationalFormula second)

Creates a new associative formula with the two given formulae

Parameters:

first - a relational formula.

second - a relational formula.

AssociativeFolFormula

public AssociativeFolFormula(java.util.Collection<? extends RelationalFormula> formulas)

Creates a new associative formula with the given inner formulas.

Parameters:

formulas - a collection of formulas.

Method Detail

createEmptySignature

public Signature createEmptySignature()

Specified by:

createEmptySignature in interface AssociativeFormulaSupport.AssociativeSupportBridge

Returns:

An empty signature of the language of the AssociativeFormula implementation

getFunctors

public java.util.Set<Functor> getFunctors()

Specified by:

getFunctors in class RelationalFormula

Returns:

all functors that appear in this formula.

containsQuantifier

public boolean containsQuantifier()

Description copied from interface: QuantifiedFormula

Checks whether this formula contains any quantification.

Specified by:

containsQuantifier in interface QuantifiedFormula

Returns:

"true" if this formula contains a quantification.

getUnboundVariables

public java.util.Set<Variable> getUnboundVariables()

Specified by:

getUnboundVariables in interface QuantifiedFormula

Returns:

a set of of unbound variables

isClosed

public boolean isClosed()

Description copied from interface: QuantifiedFormula

Checks whether this formula is closed, i.e. whether every variables occurring in the formula is bound by a quantifier.

Specified by:

isClosed in interface QuantifiedFormula

Returns:

"true" if this formula is closed, "false" otherwise.

isClosed

public boolean isClosed(java.util.Set<Variable> boundVariables)

Description copied from interface: QuantifiedFormula

Checks whether this formula is closed, i.e. whether every variables occurring in the formula is bound by a quantifier. Every variable in "boundVariables" is already assumed to be bound.

Specified by:

isClosed in interface QuantifiedFormula

Parameters:

boundVariables - the variables assumed to be bound.

Returns:

"true" if this formula is closed wrt. "boundVariables", "false" otherwise.

isWellBound

public boolean isWellBound()

Description copied from interface: QuantifiedFormula

Checks whether this formula is well-bound, i.e. whether no variable bound by a quantifier is again bound by another quantifier within the first quantifier's range.

Specified by:

isWellBound in interface QuantifiedFormula

Returns:

"true" if this formula is well-bound, "false" otherwise.

isWellBound

public boolean isWellBound(java.util.Set<Variable> boundVariables)

Description copied from interface: QuantifiedFormula

Checks whether this formula is well-bound, i.e. whether no variable bound by a quantifier is again bound by another quantifier within the first quantifier range. Every variable in "boundVariables" is assumed to be bound already.

Specified by:

isWellBound in interface QuantifiedFormula

Parameters:

boundVariables - the variables assumed to be bound.

Returns:

"true" if this formula is well-bound, "false" otherwise.

isLiteral

public boolean isLiteral()

Specified by:

isLiteral in interface SimpleLogicalFormula

Returns:

true if the formula represents a literal in the language or false otherwise

getQuantifierVariables

public java.util.Set<Variable> getQuantifierVariables()

Specified by:

getQuantifierVariables in interface QuantifiedFormula

Overrides:

getQuantifierVariables in class FolFormula

Returns:

a set containing all quantified variables

getFormulas

public java.util.List<RelationalFormula> getFormulas()

Specified by:

getFormulas in interface AssociativeFormula<RelationalFormula>

Returns:

all the formulas saved as childs in the associative formula

getFormulas

public <C extends SimpleLogicalFormula> java.util.Set<C> getFormulas(java.lang.Class<C> cls)

Description copied from interface: AssociativeFormula

Process the formulas of type C that are children of this associative formula

Specified by:

getFormulas in interface AssociativeFormula<RelationalFormula>

Type Parameters:

C - the type of formulas

Parameters:

cls - the class structure defining the type of formulas which are searched.

Returns:

A set of formulas of type C which are members of the associative formula

getAtoms

public java.util.Set<FolAtom> getAtoms()

Description copied from interface: SimpleLogicalFormula

Processes the set of all atoms which appear in this formula

Specified by:

getAtoms in interface SimpleLogicalFormula

Specified by:

getAtoms in class RelationalFormula

Returns:

all atoms that appear in this formula.

getTerms

public java.util.Set<Term<?>> getTerms()

Specified by:

getTerms in interface LogicStructure

Returns:

a set containing all terms of this logical structure

getTerms

public <C extends Term<?>> java.util.Set<C> getTerms(java.lang.Class<C> cls)

Description copied from interface: LogicStructure

Processes the set containing all terms of type C. This method uses the equals method of the given Class and therefore does not add terms which are sub classes of type C to the set.

Specified by:

getTerms in interface LogicStructure

Type Parameters:

C - the type of terms

Parameters:

cls - The Class structure containing type information about the searched term

Returns:

A set containing all terms of type C of this logical structure

getPredicates

public java.util.Set<? extends Predicate> getPredicates()

Description copied from interface: SimpleLogicalFormula

Processes the set of all predicates which appear in this formula

Specified by:

getPredicates in interface SimpleLogicalFormula

Returns:

all predicates that appear in this formula

substitute

public AssociativeFolFormula substitute(Term<?> v,
                                        Term<?> t)

Description copied from class: RelationalFormula

Substitutes all occurrences of term "v" in this formula by term "t" and returns the new formula. NOTE: if "v" is a variable and bound to a quantifier then "v" is not substituted in that quantifiers inner formula.

Specified by:

substitute in interface ComplexLogicalFormula

Specified by:

substitute in class FolFormula

Parameters:

v - the term to be substituted.

t - the term to substitute.

Returns:

a formula where every occurrence of "v" is replaced by "t".

substitute

public AssociativeFolFormula substitute(java.util.Map<? extends Term<?>,? extends Term<?>> termMap)

Description copied from class: RelationalFormula

Substitutes all occurrences of all terms "v" in map.keyset() in this formula by map.get(v) and returns the new formula.
NOTE: variables bound to quantifiers are not substituted in their inner formulas even if they appear in the map.

Specified by:

substitute in interface ComplexLogicalFormula

Overrides:

substitute in class RelationalFormula

Parameters:

termMap - a mapping defining which terms to be substituted.

Returns:

a formula where every term in map.keyset() has been replaced by map.get(v).

toString

public java.lang.String toString()

Specified by:

toString in class RelationalFormula

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<RelationalFormula>

Specified by:

hashCode in interface java.util.List<RelationalFormula>

Specified by:

hashCode in interface SimpleLogicalFormula

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Collection<RelationalFormula>

Specified by:

equals in interface java.util.List<RelationalFormula>

Specified by:

equals in interface SimpleLogicalFormula

Overrides:

equals in class java.lang.Object

add

public boolean add(RelationalFormula e)

Specified by:

add in interface java.util.Collection<RelationalFormula>

Specified by:

add in interface java.util.List<RelationalFormula>

add

public boolean add(FolFormula... formulas)

Adds the specified elements to the end of this collection (optional operation).

Parameters:

formulas - to be appended to collection

Returns:

true if all elements were added, false otherwise

addAll

public boolean addAll(java.util.Collection<? extends RelationalFormula> c)

Specified by:

addAll in interface java.util.Collection<RelationalFormula>

Specified by:

addAll in interface java.util.List<RelationalFormula>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<RelationalFormula>

Specified by:

clear in interface java.util.List<RelationalFormula>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<RelationalFormula>

Specified by:

contains in interface java.util.List<RelationalFormula>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<RelationalFormula>

Specified by:

containsAll in interface java.util.List<RelationalFormula>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<RelationalFormula>

Specified by:

isEmpty in interface java.util.List<RelationalFormula>

iterator

public java.util.Iterator<RelationalFormula> iterator()

Specified by:

iterator in interface java.util.Collection<RelationalFormula>

Specified by:

iterator in interface java.lang.Iterable<RelationalFormula>

Specified by:

iterator in interface java.util.List<RelationalFormula>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<RelationalFormula>

Specified by:

remove in interface java.util.List<RelationalFormula>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<RelationalFormula>

Specified by:

removeAll in interface java.util.List<RelationalFormula>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<RelationalFormula>

Specified by:

retainAll in interface java.util.List<RelationalFormula>

size

public int size()

Specified by:

size in interface java.util.Collection<RelationalFormula>

Specified by:

size in interface java.util.List<RelationalFormula>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<RelationalFormula>

Specified by:

toArray in interface java.util.List<RelationalFormula>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<RelationalFormula>

Specified by:

toArray in interface java.util.List<RelationalFormula>

add

public void add(int index,
                RelationalFormula element)

Specified by:

add in interface java.util.List<RelationalFormula>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends RelationalFormula> c)

Specified by:

addAll in interface java.util.List<RelationalFormula>

get

public RelationalFormula get(int index)

Specified by:

get in interface java.util.List<RelationalFormula>

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<RelationalFormula>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<RelationalFormula>

listIterator

public java.util.ListIterator<RelationalFormula> listIterator()

Specified by:

listIterator in interface java.util.List<RelationalFormula>

listIterator

public java.util.ListIterator<RelationalFormula> listIterator(int index)

Specified by:

listIterator in interface java.util.List<RelationalFormula>

remove

public RelationalFormula remove(int index)

Specified by:

remove in interface java.util.List<RelationalFormula>

set

public RelationalFormula set(int index,
                             RelationalFormula element)

Specified by:

set in interface java.util.List<RelationalFormula>

subList

public java.util.List<RelationalFormula> subList(int fromIndex,
                                                 int toIndex)

Specified by:

subList in interface java.util.List<RelationalFormula>