org.tweetyproject.lp.asp.syntax.ClassicalHead

All Implemented Interfaces:: Iterable<ASPLiteral>, Collection<ASPLiteral>, List<ASPLiteral>, SequencedCollection<ASPLiteral>, Formula, AssociativeFormulaSupport.AssociativeSupportBridge, AssociativeFormula<ASPLiteral>, ComplexLogicalFormula, Disjunctable, LogicStructure, SimpleLogicalFormula

public class ClassicalHead extends ASPHead implements AssociativeFormula<ASPLiteral>, Disjunctable, AssociativeFormulaSupport.AssociativeSupportBridge

This formula represents the head of an disjunctive rule which is a disjunction of literals.

Author:: Tim Janus, Anna Gessler

Constructor Summary

Constructors

Constructor

Description

ClassicalHead()

Empty Constructor.

ClassicalHead(List<ASPLiteral> headElements)

Creates a new head with the given elements.

ClassicalHead(ASPLiteral head)

Creates a new head with a single element.

ClassicalHead(ClassicalHead other)

Copy-Constructor
Method Summary

Modifier and Type

Method

Description

void

add(int index, ASPLiteral element)

boolean

add(ASPLiteral e)

boolean

add(ASPLiteral... formulas)

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

boolean

addAll(int index, Collection<? extends ASPLiteral> c)

boolean

addAll(Collection<? extends ASPLiteral> c)

void

clear()

ClassicalHead

clone()

Creates a deep copy of this formula

SimpleLogicalFormula

combineWithOr(Disjunctable f)

boolean

contains(Object o)

boolean

containsAll(Collection<?> c)

<C extends Term<?>> boolean

containsTermsOfType(Class<C> cls)

Checks if this logical structure contains at least one term of type C.

ClassicalHead

createEmptyFormula()

FolSignature

createEmptySignature()

boolean

equals(Object other)

ClassicalHead

exchange(Term<?> v, Term<?> t)

Substitutes all occurrences of term "v" in this formula by term "t" and at the same time replaces all occurrences of term "t" by term "v" and eventually returns the new formula.

ASPLiteral

get(int index)

Set<ASPAtom>

getAtoms()

Processes the set of all atoms which appear in this formula

String

getEmptySymbol()

List<ASPLiteral>

getFormulas()

<C extends SimpleLogicalFormula> Set<C>

getFormulas(Class<C> cls)

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

SortedSet<ASPLiteral>

getLiterals()

Returns all literals in this element in form of a SortedSet.

String

getOperatorSymbol()

Class<? extends Predicate>

getPredicateCls()

Set<Predicate>

getPredicates()

Processes the set of all predicates which appear in this formula

FolSignature

getSignature()

Returns the signature of the language of this formula.

Set<Term<?>>

getTerms()

<C extends Term<?>> Set<C>

getTerms(Class<C> cls)

Processes the set containing all terms of type C.

int

hashCode()

int

indexOf(Object o)

boolean

isEmpty()

Return true if the head is empty, false otherwise

boolean

isGround()

Checks whether this formula is ground, i.e.

boolean

isLiteral()

boolean

isWellFormed()

Checks if this formula is well formed in the logical langauge.

Iterator<ASPLiteral>

iterator()

int

lastIndexOf(Object o)

ListIterator<ASPLiteral>

listIterator()

ListIterator<ASPLiteral>

listIterator(int index)

String

printToClingo()

Returns a representation of this ASP element in clingo (potassco) syntax.

String

printToDLV()

Returns a representation of this ASP element in DLV syntax.

ASPLiteral

remove(int index)

boolean

remove(Object o)

boolean

removeAll(Collection<?> c)

boolean

retainAll(Collection<?> c)

ASPLiteral

set(int index, ASPLiteral element)

int

size()

List<ASPLiteral>

subList(int fromIndex, int toIndex)

ClassicalHead

substitute(Map<? extends Term<?>,? extends Term<?>> map)

Substitutes all occurrences of all terms "v" in map.keyset() in this formula by map.get(v) and returns the new formula.

ClassicalHead

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

Substitutes all occurrences of term "v" in this formula by term "t" and returns the new formula.

Object[]

toArray()

<T> T[]

toArray(T[] a)

String

toString()

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

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
addFirst, addLast, getFirst, getLast, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Constructor Details
- ClassicalHead
  
  public ClassicalHead()
  
  Empty Constructor.
- ClassicalHead
  
  public ClassicalHead(List<ASPLiteral> headElements)
  
  Creates a new head with the given elements.
  
  Parameters:
  
  headElements - list of literals
- ClassicalHead
  
  public ClassicalHead(ASPLiteral head)
  
  Creates a new head with a single element.
  
  Parameters:
  
  head - an ASP literal
- ClassicalHead
  
  public ClassicalHead(ClassicalHead other)
  
  Copy-Constructor
  
  Parameters:
  
  other - another ASPHead
Method Details
- isGround
  
  public boolean isGround()
  
  Description copied from interface: ComplexLogicalFormula
  
  Checks whether this formula is ground, i.e. whether there appears no variable in this formula.
  
  Specified by:
  
  isGround in interface ComplexLogicalFormula
  
  Overrides:
  
  isGround in class ASPElement
  
  Returns:
  
  "true" if this formula is ground.
- isWellFormed
  
  public boolean isWellFormed()
  
  Description copied from interface: ComplexLogicalFormula
  
  Checks if this formula is well formed in the logical langauge. What well- formed means is highly language dependent and the documentation of implementing sub classes shall describe the well formed term for the language they model.
  
  Specified by:
  
  isWellFormed in interface ComplexLogicalFormula
  
  Overrides:
  
  isWellFormed in class ASPElement
  
  Returns:
  
  true if the formula is well-formed, false otherwise
- getPredicateCls
  
  public Class<? extends Predicate> getPredicateCls()
  
  Specified by:
  
  getPredicateCls in interface SimpleLogicalFormula
  
  Overrides:
  
  getPredicateCls in class ASPElement
  
  Returns:
  
  The class description of the predicate used by this formula.
- isLiteral
  
  public boolean isLiteral()
  
  Specified by:
  
  isLiteral in interface SimpleLogicalFormula
  
  Returns:
  
  true if the formula represents a literal in the language or false otherwise
- getTerms
  
  public Set<Term<?>> getTerms()
  
  Specified by:
  
  getTerms in interface LogicStructure
  
  Returns:
  
  a set containing all terms of this logical structure
- getTerms
  
  public <C extends Term<?>> Set<C> getTerms(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
- containsTermsOfType
  
  public <C extends Term<?>> boolean containsTermsOfType(Class<C> cls)
  
  Description copied from interface: LogicStructure
  
  Checks if this logical structure contains at least one term of type C. This method is a shortcut for !getTerms(TermImplementation.class).isEmpty().
  
  Specified by:
  
  containsTermsOfType in interface LogicStructure
  
  Overrides:
  
  containsTermsOfType in class ASPElement
  
  Type Parameters:
  
  C - the type of terms
  
  Parameters:
  
  cls - The class structure representing the type C of the term.
  
  Returns:
  
  True if this logical structure contains at least one term of type C or false otherwise.
- getPredicates
  
  public Set<Predicate> getPredicates()
  
  Description copied from interface: SimpleLogicalFormula
  
  Processes the set of all predicates which appear in this formula
  
  Specified by:
  
  getPredicates in interface SimpleLogicalFormula
  
  Specified by:
  
  getPredicates in class ASPElement
  
  Returns:
  
  all predicates that appear in this formula
- getAtoms
  
  public Set<ASPAtom> 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 ASPElement
  
  Returns:
  
  The set of all atoms
- substitute
  
  public ClassicalHead substitute(Term<?> t, Term<?> v)
  
  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 interface ComplexLogicalFormula
  
  Specified by:
  
  substitute in class ASPElement
  
  Parameters:
  
  t - the term to be substituted.
  
  v - the term to substitute.
  
  Returns:
  
  a formula where every occurrence of "v" is replaced by "t".
- getSignature
  
  public FolSignature getSignature()
  
  Description copied from interface: Formula
  
  Returns the signature of the language of this formula.
  
  Specified by:
  
  getSignature in interface Formula
  
  Specified by:
  
  getSignature in class ASPElement
  
  Returns:
  
  the signature of the language of this formula.
- clone
  
  public ClassicalHead clone()
  
  Description copied from interface: SimpleLogicalFormula
  
  Creates a deep copy of this formula
  
  Specified by:
  
  clone in interface ComplexLogicalFormula
  
  Specified by:
  
  clone in interface SimpleLogicalFormula
  
  Specified by:
  
  clone in class ASPElement
  
  Returns:
  
  the cloned formula
- add
  
  public boolean add(ASPLiteral e)
  
  Specified by:
  
  add in interface Collection<ASPLiteral>
  
  Specified by:
  
  add in interface List<ASPLiteral>
- add
  
  public void add(int index, ASPLiteral element)
  
  Specified by:
  
  add in interface List<ASPLiteral>
- addAll
  
  public boolean addAll(Collection<? extends ASPLiteral> c)
  
  Specified by:
  
  addAll in interface Collection<ASPLiteral>
  
  Specified by:
  
  addAll in interface List<ASPLiteral>
- addAll
  
  public boolean addAll(int index, Collection<? extends ASPLiteral> c)
  
  Specified by:
  
  addAll in interface List<ASPLiteral>
- add
  
  public boolean add(ASPLiteral... 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
- clear
  
  public void clear()
  
  Specified by:
  
  clear in interface Collection<ASPLiteral>
  
  Specified by:
  
  clear in interface List<ASPLiteral>
- contains
  
  public boolean contains(Object o)
  
  Specified by:
  
  contains in interface Collection<ASPLiteral>
  
  Specified by:
  
  contains in interface List<ASPLiteral>
- containsAll
  
  public boolean containsAll(Collection<?> c)
  
  Specified by:
  
  containsAll in interface Collection<ASPLiteral>
  
  Specified by:
  
  containsAll in interface List<ASPLiteral>
- get
  
  public ASPLiteral get(int index)
  
  Specified by:
  
  get in interface List<ASPLiteral>
- indexOf
  
  public int indexOf(Object o)
  
  Specified by:
  
  indexOf in interface List<ASPLiteral>
- isEmpty
  
  public boolean isEmpty()
  
  Description copied from class: ASPHead
  
  Return true if the head is empty, false otherwise
  
  Specified by:
  
  isEmpty in interface Collection<ASPLiteral>
  
  Specified by:
  
  isEmpty in interface List<ASPLiteral>
  
  Specified by:
  
  isEmpty in class ASPHead
  
  Returns:
  
  true if the head is empty, false otherwise
- iterator
  
  public Iterator<ASPLiteral> iterator()
  
  Specified by:
  
  iterator in interface Collection<ASPLiteral>
  
  Specified by:
  
  iterator in interface Iterable<ASPLiteral>
  
  Specified by:
  
  iterator in interface List<ASPLiteral>
- lastIndexOf
  
  public int lastIndexOf(Object o)
  
  Specified by:
  
  lastIndexOf in interface List<ASPLiteral>
- listIterator
  
  public ListIterator<ASPLiteral> listIterator()
  
  Specified by:
  
  listIterator in interface List<ASPLiteral>
- listIterator
  
  public ListIterator<ASPLiteral> listIterator(int index)
  
  Specified by:
  
  listIterator in interface List<ASPLiteral>
- remove
  
  public boolean remove(Object o)
  
  Specified by:
  
  remove in interface Collection<ASPLiteral>
  
  Specified by:
  
  remove in interface List<ASPLiteral>
- remove
  
  public ASPLiteral remove(int index)
  
  Specified by:
  
  remove in interface List<ASPLiteral>
- removeAll
  
  public boolean removeAll(Collection<?> c)
  
  Specified by:
  
  removeAll in interface Collection<ASPLiteral>
  
  Specified by:
  
  removeAll in interface List<ASPLiteral>
- retainAll
  
  public boolean retainAll(Collection<?> c)
  
  Specified by:
  
  retainAll in interface Collection<ASPLiteral>
  
  Specified by:
  
  retainAll in interface List<ASPLiteral>
- set
  
  public ASPLiteral set(int index, ASPLiteral element)
  
  Specified by:
  
  set in interface List<ASPLiteral>
- size
  
  public int size()
  
  Specified by:
  
  size in interface Collection<ASPLiteral>
  
  Specified by:
  
  size in interface List<ASPLiteral>
- subList
  
  public List<ASPLiteral> subList(int fromIndex, int toIndex)
  
  Specified by:
  
  subList in interface List<ASPLiteral>
- toArray
  
  public Object[] toArray()
  
  Specified by:
  
  toArray in interface Collection<ASPLiteral>
  
  Specified by:
  
  toArray in interface List<ASPLiteral>
- toArray
  
  public <T> T[] toArray(T[] a)
  
  Specified by:
  
  toArray in interface Collection<ASPLiteral>
  
  Specified by:
  
  toArray in interface List<ASPLiteral>
- getFormulas
  
  public List<ASPLiteral> getFormulas()
  
  Specified by:
  
  getFormulas in interface AssociativeFormula<ASPLiteral>
  
  Returns:
  
  all the formulas saved as childs in the associative formula
- getFormulas
  
  public <C extends SimpleLogicalFormula> Set<C> getFormulas(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<ASPLiteral>
  
  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
- createEmptyFormula
  
  public ClassicalHead createEmptyFormula()
  
  Specified by:
  
  createEmptyFormula in interface AssociativeFormulaSupport.AssociativeSupportBridge
  
  Returns:
  
  an empty version of the AssociativeFormula
- createEmptySignature
  
  public FolSignature createEmptySignature()
  
  Specified by:
  
  createEmptySignature in interface AssociativeFormulaSupport.AssociativeSupportBridge
  
  Returns:
  
  An empty signature of the language of the AssociativeFormula implementation
- getOperatorSymbol
  
  public String getOperatorSymbol()
  
  Specified by:
  
  getOperatorSymbol in interface AssociativeFormulaSupport.AssociativeSupportBridge
  
  Returns:
  
  A String representing the operator which connects two items of the associative formula.
- getEmptySymbol
  
  public String getEmptySymbol()
  
  Specified by:
  
  getEmptySymbol in interface AssociativeFormulaSupport.AssociativeSupportBridge
  
  Returns:
  
  A String representing an empty version of the Associative Formula implementation
- combineWithOr
  
  public SimpleLogicalFormula combineWithOr(Disjunctable f)
  
  Specified by:
  
  combineWithOr in interface Disjunctable
  
  Parameters:
  
  f - a formula to be combined with OR and this.
  
  Returns:
  
  a disjunction of this and the given formula.
- substitute
  
  public ClassicalHead substitute(Map<? extends Term<?>,? extends Term<?>> map) throws IllegalArgumentException
  
  Description copied from interface: ComplexLogicalFormula
  
  Substitutes all occurrences of all terms "v" in map.keyset() in this formula by map.get(v) and returns the new formula.
  
  Specified by:
  
  substitute in interface ComplexLogicalFormula
  
  Overrides:
  
  substitute in class ASPElement
  
  Parameters:
  
  map - a mapping defining which terms to be substituted.
  
  Returns:
  
  a formula where every term in map.keyset() has been replaced by map.get(v).
  
  Throws:
  
  IllegalArgumentException - if any term and its mapping are of different sorts
- exchange
  
  public ClassicalHead exchange(Term<?> v, Term<?> t) throws IllegalArgumentException
  
  Description copied from interface: ComplexLogicalFormula
  
  Substitutes all occurrences of term "v" in this formula by term "t" and at the same time replaces all occurrences of term "t" by term "v" and eventually returns the new formula.
  
  Specified by:
  
  exchange in interface ComplexLogicalFormula
  
  Overrides:
  
  exchange in class ASPElement
  
  Parameters:
  
  v - a term.
  
  t - a term.
  
  Returns:
  
  a new logical formula with both "v" and "t" exchanged.
  
  Throws:
  
  IllegalArgumentException - if "v" and "t" are of different sorts
- getLiterals
  
  public SortedSet<ASPLiteral> getLiterals()
  
  Returns all literals in this element in form of a SortedSet. Literals are atoms or strict negations of atoms.
  
  Specified by:
  
  getLiterals in class ASPHead
  
  Returns:
  
  all the literals used in the rule element
- equals
  
  public boolean equals(Object other)
  
  Specified by:
  
  equals in interface Collection<ASPLiteral>
  
  Specified by:
  
  equals in interface List<ASPLiteral>
  
  Specified by:
  
  equals in interface SimpleLogicalFormula
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Specified by:
  
  hashCode in interface Collection<ASPLiteral>
  
  Specified by:
  
  hashCode in interface List<ASPLiteral>
  
  Specified by:
  
  hashCode in interface SimpleLogicalFormula
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- printToClingo
  
  public String printToClingo()
  
  Description copied from class: ASPElement
  
  Returns a representation of this ASP element in clingo (potassco) syntax. See https://potassco.org/ for more information.
  
  Overrides:
  
  printToClingo in class ASPElement
  
  Returns:
  
  String representation in clingo syntax
- printToDLV
  
  public String printToDLV()
  
  Description copied from class: ASPElement
  
  Returns a representation of this ASP element in DLV syntax. See http://www.dlvsystem.com/html/DLV_User_Manual.html for more information.
  
  Overrides:
  
  printToDLV in class ASPElement
  
  Returns:
  
  String representation in DLV syntax

Class ClassicalHead

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.List

Constructor Details

ClassicalHead

ClassicalHead

ClassicalHead

ClassicalHead

Method Details

isGround

isWellFormed

getPredicateCls

isLiteral

getTerms

getTerms

containsTermsOfType

getPredicates

getAtoms

substitute

getSignature

clone

add

add

addAll

addAll

add

clear

contains

containsAll

get

indexOf

isEmpty

iterator

lastIndexOf

listIterator

listIterator

remove

remove

removeAll

retainAll

set

size

subList

toArray

toArray

getFormulas

getFormulas

createEmptyFormula

createEmptySignature

getOperatorSymbol

getEmptySymbol

combineWithOr

substitute

exchange

getLiterals

equals

hashCode

toString

printToClingo

printToDLV