Package net.sf.tweety.lp.asp.syntax
Class ASPAtom
- java.lang.Object
-
- net.sf.tweety.lp.asp.syntax.ASPElement
-
- net.sf.tweety.lp.asp.syntax.ASPBodyElement
-
- net.sf.tweety.lp.asp.syntax.ASPLiteral
-
- net.sf.tweety.lp.asp.syntax.ASPAtom
-
- All Implemented Interfaces:
java.lang.Comparable<ASPLiteral>
,Formula
,Atom
,ComplexLogicalFormula
,Invertable
,LogicStructure
,SimpleLogicalFormula
public class ASPAtom extends ASPLiteral
This class models an atom, which is a basic structure for building literals and rules for logic programs.- Author:
- Tim Janus, Thomas Vengels, Matthias Thimm, Anna Gessler
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.sf.tweety.logics.commons.syntax.interfaces.Atom
Atom.AtomImpl, Atom.RETURN_SET_PREDICATE
-
-
Constructor Summary
Constructors Constructor Description ASPAtom()
Empty constructor.ASPAtom(java.lang.String name)
Creates a new atom with the given predicate name and no terms.ASPAtom(java.lang.String symbol, Term<?>... terms)
Creates an atom with the given predicate as name and the given terms as argumentASPAtom(Predicate p)
Creates a new ASPAtom with the given predicate.ASPAtom(Predicate p, java.util.List<Term<?>> terms)
Creates a new atom with the given predicate and terms.ASPAtom(FolAtom other)
Copy-Constructor: Generates a deep copy of the given FOL atom.ASPAtom(ASPAtom other)
Copy-Constructor: Generates a deep copy of the given ASP atom.
-
Method Summary
Modifier and Type Method Description void
addArgument(Term<?> arg)
Adds an argument to the atom's argument listASPAtom
clone()
Creates a deep copy of this formulaASPAtom
cloneWithAddedTerm(Term<?> term)
Creates a copy of the literal and adds the given term as argument to the end of the argument list.int
compareTo(ASPLiteral o)
ASPLiteral
complement()
boolean
equals(java.lang.Object o)
java.util.List<? extends Term<?>>
getArguments()
ASPAtom
getAtom()
java.util.Set<ASPAtom>
getAtoms()
Processes the set of all atoms which appear in this formulajava.util.SortedSet<ASPLiteral>
getLiterals()
Returns all literals in this element in form of a SortedSet.java.lang.String
getName()
Predicate
getPredicate()
java.util.Set<Predicate>
getPredicates()
Processes the set of all predicates which appear in this formulaFolSignature
getSignature()
Returns the signature of the language of this formula.Term<?>
getTerm(int i)
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.int
hashCode()
boolean
isComplete()
Atom.RETURN_SET_PREDICATE
setPredicate(Predicate newer)
Changes the predicate of the atom.ASPAtom
substitute(Term<?> v, Term<?> t)
Substitutes all occurrences of term "v" in this formula by term "t" and returns the new formula.java.lang.String
toString()
-
Methods inherited from class net.sf.tweety.lp.asp.syntax.ASPLiteral
isLiteral
-
Methods inherited from class net.sf.tweety.lp.asp.syntax.ASPElement
containsTermsOfType, exchange, getPredicateCls, isGround, isWellFormed, substitute
-
Methods inherited from interface net.sf.tweety.logics.commons.syntax.interfaces.SimpleLogicalFormula
getPredicateCls
-
-
-
-
Constructor Detail
-
ASPAtom
public ASPAtom()
Empty constructor.
-
ASPAtom
public ASPAtom(Predicate p, java.util.List<Term<?>> terms)
Creates a new atom with the given predicate and terms.- Parameters:
p
- a predicateterms
- arguments of the atom
-
ASPAtom
public ASPAtom(java.lang.String name)
Creates a new atom with the given predicate name and no terms.- Parameters:
name
- a name
-
ASPAtom
public ASPAtom(FolAtom other)
Copy-Constructor: Generates a deep copy of the given FOL atom.- Parameters:
other
- The FOL atom acting as source for the deep copy
-
ASPAtom
public ASPAtom(ASPAtom other)
Copy-Constructor: Generates a deep copy of the given ASP atom.- Parameters:
other
- The atom acting as source for the deep copy
-
ASPAtom
public ASPAtom(java.lang.String symbol, Term<?>... terms)
Creates an atom with the given predicate as name and the given terms as argument- Parameters:
symbol
- The name of the atomterms
- A list of Term<?> defining the arguments of the term
-
ASPAtom
public ASPAtom(Predicate p)
Creates a new ASPAtom with the given predicate.- Parameters:
p
- a predicate
-
-
Method Detail
-
getName
public java.lang.String getName()
- Returns:
- the name of the predicate
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getLiterals
public java.util.SortedSet<ASPLiteral> getLiterals()
Description copied from class:ASPBodyElement
Returns all literals in this element in form of a SortedSet. Literals are atoms or strict negations of atoms.- Specified by:
getLiterals
in classASPBodyElement
- Returns:
- all the literals used in the rule element
-
getPredicates
public java.util.Set<Predicate> getPredicates()
Description copied from interface:SimpleLogicalFormula
Processes the set of all predicates which appear in this formula- Specified by:
getPredicates
in interfaceSimpleLogicalFormula
- Specified by:
getPredicates
in classASPElement
- Returns:
- all predicates that appear in this formula
-
getAtoms
public java.util.Set<ASPAtom> getAtoms()
Description copied from interface:SimpleLogicalFormula
Processes the set of all atoms which appear in this formula- Specified by:
getAtoms
in interfaceSimpleLogicalFormula
- Specified by:
getAtoms
in classASPElement
- Returns:
- The set of all atoms
-
getSignature
public FolSignature getSignature()
Description copied from interface:Formula
Returns the signature of the language of this formula.- Specified by:
getSignature
in interfaceFormula
- Specified by:
getSignature
in classASPElement
- Returns:
- the signature of the language of this formula.
-
clone
public ASPAtom clone()
Description copied from interface:SimpleLogicalFormula
Creates a deep copy of this formula- Specified by:
clone
in interfaceComplexLogicalFormula
- Specified by:
clone
in interfaceSimpleLogicalFormula
- Specified by:
clone
in classASPElement
- Returns:
- the cloned formula
-
getTerms
public java.util.Set<Term<?>> getTerms()
- 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.- 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
-
getPredicate
public Predicate getPredicate()
- Returns:
- the predicate of the atom
-
setPredicate
public Atom.RETURN_SET_PREDICATE setPredicate(Predicate newer)
Description copied from interface:Atom
Changes the predicate of the atom. Given an old Predicate po and a new predicate pn with their list of arguments types at(po) and at(pn) and the arguments of this Atom: arg(this) this method distinguishes between three cases: 1. The predicate only differ in the names, returning RSP_SUCCESS 2. The old predicates argument types is a sub-list of the new argument types then the method returns RSP_INCOMPLETE and the atoms isComplete() method returns false 3. The new predicates argument types is a sub-list of the old argument types then the method returns RSP_TRUNCATED and the arguments of this atom are truncated too and isComplete() returns true. 4. The old and new predicates' argument types differ then the list of arguments of the atom get cleared and isComplete() returns false.- Parameters:
newer
- some predicate- Returns:
- Depends on the cases described above: 1. RSP_SUCCESS 2. RSP_INCOMPLETE 3. RSP_TRUNCATED 4. RSP_CLEARED
-
addArgument
public void addArgument(Term<?> arg) throws LanguageException
Description copied from interface:Atom
Adds an argument to the atom's argument list- Parameters:
arg
- The next argument- Throws:
LanguageException
- If the language does not support arguments for their constructs.
-
getArguments
public java.util.List<? extends Term<?>> getArguments()
- Returns:
- A list containing all the arguments of this specific atom
-
isComplete
public boolean isComplete()
- Returns:
- true if the size of the argument list is equal to the arity of the predicate
-
compareTo
public int compareTo(ASPLiteral o)
-
cloneWithAddedTerm
public ASPAtom cloneWithAddedTerm(Term<?> term)
Description copied from class:ASPLiteral
Creates a copy of the literal and adds the given term as argument to the end of the argument list.- Specified by:
cloneWithAddedTerm
in classASPLiteral
- Parameters:
term
- the new argument.- Returns:
- A copy of the literal containing the given term as new argument.
-
getAtom
public ASPAtom getAtom()
- Specified by:
getAtom
in classASPLiteral
- Returns:
- The atom representing the literal.
-
complement
public ASPLiteral complement()
- Specified by:
complement
in interfaceInvertable
- Specified by:
complement
in classASPLiteral
- Returns:
- the complement of this formula.
-
substitute
public ASPAtom substitute(Term<?> v, Term<?> t) throws java.lang.IllegalArgumentException
Description copied from interface:ComplexLogicalFormula
Substitutes all occurrences of term "v" in this formula by term "t" and returns the new formula.- Specified by:
substitute
in interfaceComplexLogicalFormula
- Specified by:
substitute
in classASPBodyElement
- Parameters:
v
- the term to be substituted.t
- the term to substitute.- Returns:
- a formula where every occurrence of "v" is replaced by "t".
- Throws:
java.lang.IllegalArgumentException
- if "v" and "t" are of different sorts
-
getTerm
public Term<?> getTerm(int i)
-
equals
public boolean equals(java.lang.Object o)
- Specified by:
equals
in interfaceSimpleLogicalFormula
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfaceSimpleLogicalFormula
- Overrides:
hashCode
in classjava.lang.Object
-
-