Package org.tweetyproject.logics.mln.syntax

Class MlnFormula

java.lang.Object
org.tweetyproject.logics.commons.syntax.RelationalFormula
org.tweetyproject.logics.mln.syntax.MlnFormula
All Implemented Interfaces:
Formula, ClassicalFormula, ComplexLogicalFormula, Conjunctable, Disjunctable, Invertable, LogicStructure, ProbabilityAware, QuantifiedFormula, SimpleLogicalFormula
public class MlnFormula extends RelationalFormula
Instances of this class represent first-order formulas with a weight.
Author:
Matthias Thimm, Tim Janus

  • Constructor Details

    • MlnFormula

      public MlnFormula(FolFormula formula)
      Creates a new strict MLN formula with the given formula.
      Parameters:
      formula - the first-order formula.

    • MlnFormula

      public MlnFormula(FolFormula formula, Double weight)
      Creates a new MLN formula with the given formula and weight.
      Parameters:
      formula - the first-order formula.
      weight - the weight of the formula (null means that the formula is strict).

    • MlnFormula

      public MlnFormula(FolFormula formula, Probability p)
      Creates a new MLN formula and estimates its weight w by the given probability p using the formula w = log(p/(1-p)*f) where "f" is the ratio of the number of worlds not satisfying the formula and the worlds satisfying the formula.
      Parameters:
      formula - the first-order formula.
      p - the intended probability of the formula.

  • Method Details

    • combineWithAnd

      public Conjunction combineWithAnd(Conjunctable f)
      Description copied from interface: Conjunctable
      Returns a conjunction of this and the given formula.
      Specified by:
      combineWithAnd in interface Conjunctable
      Specified by:
      combineWithAnd in class RelationalFormula
      Parameters:
      f - a formula to be combined with AND and this.
      Returns:
      a conjunction of this and the given formula.

    • combineWithOr

      public Disjunction combineWithOr(Disjunctable f)
      Specified by:
      combineWithOr in interface Disjunctable
      Specified by:
      combineWithOr in class RelationalFormula
      Parameters:
      f - a formula to be combined with OR and this.
      Returns:
      a disjunction of this and the given formula.

    • complement

      public RelationalFormula complement()
      Specified by:
      complement in interface Invertable
      Specified by:
      complement in class RelationalFormula
      Returns:
      the complement of this formula.

    • getPredicates

      public Set<? extends Predicate> getPredicates()
      Description copied from interface: SimpleLogicalFormula
      Processes the set of all predicates which appear in this formula
      Returns:
      all predicates that appear in this formula

    • getAtoms

      public 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.

    • containsQuantifier

      public boolean containsQuantifier()
      Description copied from interface: QuantifiedFormula
      Checks whether this formula contains any quantification.
      Returns:
      "true" if this formula contains a quantification.

    • substitute

      public RelationalFormula substitute(Term<?> v, Term<?> t) throws IllegalArgumentException
      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 RelationalFormula
      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:
      IllegalArgumentException - if "v" and "t" are of different sorts (NOTE: this exception is only thrown when "v" actually appears in this formula).

    • getUnboundVariables

      public Set<Variable> getUnboundVariables()
      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.
      Returns:
      "true" if this formula is closed, "false" otherwise.

    • isClosed

      public boolean isClosed(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.
      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.
      Returns:
      "true" if this formula is well-bound, "false" otherwise.

    • isWellBound

      public boolean isWellBound(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.
      Parameters:
      boundVariables - the variables assumed to be bound.
      Returns:
      "true" if this formula is well-bound, "false" otherwise.

    • toString

      public String toString()
      Specified by:
      toString in class RelationalFormula

    • getFunctors

      public Set<Functor> getFunctors()
      Specified by:
      getFunctors in class RelationalFormula
      Returns:
      all functors that appear in this formula.

    • getFormula

      public FolFormula getFormula()
      Returns the inner formula.
      Specified by:
      getFormula in interface QuantifiedFormula
      Overrides:
      getFormula in class RelationalFormula
      Returns:
      the inner formula.

    • getWeight

      public Double getWeight()
      Returns the weight.
      Returns:
      the weight.

    • isStrict

      public boolean isStrict()
      Returns "true" iff this formula is strict.
      Returns:
      "true" iff this formula is strict.

    • getUniformProbability

      public Probability getUniformProbability()
      Specified by:
      getUniformProbability in interface ProbabilityAware
      Specified by:
      getUniformProbability in class RelationalFormula
      Returns:
      this formula's probability in the uniform distribution.

    • isLiteral

      public boolean isLiteral()
      Returns:
      true if the formula represents a literal in the language or false otherwise

    • getTerms

      public Set<Term<?>> getTerms()
      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.
      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

    • getQuantifierVariables

      public Set<Variable> getQuantifierVariables()
      Returns:
      a set containing all quantified variables

    • clone

      public RelationalFormula 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 RelationalFormula
      Returns:
      the cloned formula

    • getSignature

      public FolSignature getSignature()
      Description copied from interface: Formula
      Returns the signature of the language of this formula.
      Returns:
      the signature of the language of this formula.