ProbabilityDistribution (Tweety (Probabilistic Conditional Logic Library) 1.10 API)

java.lang.Object
- net.sf.tweety.commons.AbstractInterpretation
- - net.sf.tweety.logics.pcl.semantics.ProbabilityDistribution<T>

Type Parameters:

T - The actual interpretation class used for this distribution.

All Implemented Interfaces:

Map<T,net.sf.tweety.math.probability.Probability>, net.sf.tweety.commons.Interpretation
```
public class ProbabilityDistribution<T extends net.sf.tweety.commons.Interpretation>
extends net.sf.tweety.commons.AbstractInterpretation
implements Map<T,net.sf.tweety.math.probability.Probability>
```
This class represents a probability distribution on some logical language

Author:

Matthias Thimm

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ProbabilityDistribution(net.sf.tweety.commons.Signature signature)
Creates a new probability distribution.

Constructors
Constructor and Description
`ProbabilityDistribution(net.sf.tweety.commons.Signature signature)` Creates a new probability distribution.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`net.sf.tweety.math.probability.Probability`	`conditionalProbability(net.sf.tweety.logics.cl.syntax.Conditional c)` Returns the probability of the given conditional
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`static <S extends net.sf.tweety.commons.Interpretation> ProbabilityDistribution<S>`	`convexCombination(double[] factors, ProbabilityDistribution<S>[] creators)` Computes the convex combination of the given probability distributions P1,...,PN with parameters factors, i.e.
`ProbabilityDistribution<T>`	`convexCombination(double d, ProbabilityDistribution<T> other)` Computes the convex combination of this P1 and the given probability distribution P2 with parameter d, i.e.
`double`	`entropy()` Returns the entropy of this probability distribution.
`Set<Map.Entry<T,net.sf.tweety.math.probability.Probability>>`	`entrySet()`
`net.sf.tweety.math.probability.Probability`	`get(Object key)`
`net.sf.tweety.commons.Signature`	`getSignature()` Returns the signature of the underlying language.
`static <S extends net.sf.tweety.commons.Interpretation> ProbabilityDistribution<S>`	`getUniformDistribution(Set<S> interpretations, net.sf.tweety.commons.Signature sig)` Returns the uniform distribution on the given interpretations.
`boolean`	`isEmpty()`
`Set<T>`	`keySet()`
`ProbabilityDistribution<T>`	`linearCombination(double d1, double d2, ProbabilityDistribution<T> other)` Makes a linear combination of this distribution "p1" and the given distribution "other" and the given parameters, i.e.
`protected static void`	`normalize(List<Double> probabilities)` Normalizes the given list of probabilities, i.e.
`net.sf.tweety.math.probability.Probability`	`probability(net.sf.tweety.commons.Formula f)` Returns the probability of the given formula
`net.sf.tweety.math.probability.Probability`	`probability(net.sf.tweety.commons.Interpretation w)` Gets the probability of the given Herbrand interpretation (this is just an alias for get(Object o).
`net.sf.tweety.math.probability.Probability`	`put(T key, net.sf.tweety.math.probability.Probability value)`
`void`	`putAll(Map<? extends T,? extends net.sf.tweety.math.probability.Probability> m)`
`net.sf.tweety.math.probability.Probability`	`remove(Object key)`
`boolean`	`satisfies(net.sf.tweety.commons.BeliefBase beliefBase)`
`boolean`	`satisfies(net.sf.tweety.commons.Formula formula)`
`int`	`size()`
`String`	`toString()`
`Collection<net.sf.tweety.math.probability.Probability>`	`values()`

Methods inherited from class net.sf.tweety.commons.AbstractInterpretation
satisfies

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - ProbabilityDistribution
```
public ProbabilityDistribution(net.sf.tweety.commons.Signature signature)
```
    Creates a new probability distribution.
- Method Detail
  - getSignature
```
public net.sf.tweety.commons.Signature getSignature()
```
    Returns the signature of the underlying language.
    
    Returns:
    
    the signature of the underlying language.
  - satisfies
```
public boolean satisfies(net.sf.tweety.commons.Formula formula)
                  throws IllegalArgumentException
```
    Specified by:
    
    satisfies in interface net.sf.tweety.commons.Interpretation
    
    Throws:
    
    IllegalArgumentException
  - satisfies
```
public boolean satisfies(net.sf.tweety.commons.BeliefBase beliefBase)
                  throws IllegalArgumentException
```
    Specified by:
    
    satisfies in interface net.sf.tweety.commons.Interpretation
    
    Throws:
    
    IllegalArgumentException
  - probability
```
public net.sf.tweety.math.probability.Probability probability(net.sf.tweety.commons.Interpretation w)
                                                       throws IllegalArgumentException
```
    Gets the probability of the given Herbrand interpretation (this is just an alias for get(Object o).
    
    Parameters:
    
    w - a Herbrand interpretation.
    
    Returns:
    
    the probability of the given Herbrand interpretation.
    
    Throws:
    
    IllegalArgumentException
  - probability
```
public net.sf.tweety.math.probability.Probability probability(net.sf.tweety.commons.Formula f)
```
    Returns the probability of the given formula
    
    Parameters:
    
    f - a formula
    
    Returns:
    
    a probability.
  - conditionalProbability
```
public net.sf.tweety.math.probability.Probability conditionalProbability(net.sf.tweety.logics.cl.syntax.Conditional c)
```
    Returns the probability of the given conditional
    
    Parameters:
    
    c - a conditional
    
    Returns:
    
    a probability.
  - normalize
```
protected static void normalize(List<Double> probabilities)
```
    Normalizes the given list of probabilities, i.e. divides each probability by the sum of all probabilities.
  - entropy
```
public double entropy()
```
    Returns the entropy of this probability distribution.
    
    Returns:
    
    the entropy of this probability distribution.
  - convexCombination
```
public ProbabilityDistribution<T> convexCombination(double d,
                                                    ProbabilityDistribution<T> other)
```
    Computes the convex combination of this P1 and the given probability distribution P2 with parameter d, i.e. it returns a P with P(i)=d P1(i) + (1-d) P2(i) for every interpretation i.
    
    Parameters:
    
    d - a double
    
    other - a probability distribution
    
    Returns:
    
    the convex combination of this P1 and the given probability distribution P2 with parameter d.
    
    Throws:
    
    IllegalArgumentException - if either d is not in [0,1] or this and the given probability distribution are not defined on the same set of interpretations.
  - linearCombination
```
public ProbabilityDistribution<T> linearCombination(double d1,
                                                    double d2,
                                                    ProbabilityDistribution<T> other)
```
    Makes a linear combination of this distribution "p1" and the given distribution "other" and the given parameters, i.e. it returns a P with P(i)=d1 P1(i) + d2 P2(i) for every interpretation i. NOTE: P is normalized after combination.
    
    Parameters:
    
    d1 - a double.
    
    d2 - a double.
    
    other - a probability distribution.
    
    Returns:
    
    a probability distribution.
  - convexCombination
```
public static <S extends net.sf.tweety.commons.Interpretation> ProbabilityDistribution<S> convexCombination(double[] factors,
                                                                                                            ProbabilityDistribution<S>[] creators)
                                                                                                     throws IllegalArgumentException
```
    Computes the convex combination of the given probability distributions P1,...,PN with parameters factors, i.e. it returns a P with P(i)=d1 P1(i) + d2 P2(i)+ ... + dN PN(i) for every interpretation i (with d1,...,dN=factors).
    
    Type Parameters:
    
    S - The interpretation class
    
    Parameters:
    
    factors - a vector of doubles.
    
    creators - a vector of probability distributions.
    
    Returns:
    
    the convex combination of the given distributions with parameters factors.
    
    Throws:
    
    IllegalArgumentException - if either the sum of factors d is not in 1, or this and the given probability distributions are not defined on the same set of interpretations, or the lengths of creators and factors differ.
  - getUniformDistribution
```
public static <S extends net.sf.tweety.commons.Interpretation> ProbabilityDistribution<S> getUniformDistribution(Set<S> interpretations,
                                                                                                                 net.sf.tweety.commons.Signature sig)
```
    Returns the uniform distribution on the given interpretations.
    
    Type Parameters:
    
    S - The interpretation class
    
    Parameters:
    
    interpretations - some interpretations.
    
    sig - a signature
    
    Returns:
    
    the uniform distribution on the given interpretations.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - entrySet
```
public Set<Map.Entry<T,net.sf.tweety.math.probability.Probability>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - get
```
public net.sf.tweety.math.probability.Probability get(Object key)
```
    Specified by:
    
    get in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - put
```
public net.sf.tweety.math.probability.Probability put(T key,
                                                      net.sf.tweety.math.probability.Probability value)
```
    Specified by:
    
    put in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - putAll
```
public void putAll(Map<? extends T,? extends net.sf.tweety.math.probability.Probability> m)
```
    Specified by:
    
    putAll in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - remove
```
public net.sf.tweety.math.probability.Probability remove(Object key)
```
    Specified by:
    
    remove in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - values
```
public Collection<net.sf.tweety.math.probability.Probability> values()
```
    Specified by:
    
    values in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>
  - keySet
```
public Set<T> keySet()
```
    Specified by:
    
    keySet in interface Map<T extends net.sf.tweety.commons.Interpretation,net.sf.tweety.math.probability.Probability>

Class ProbabilityDistribution<T extends net.sf.tweety.commons.Interpretation>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class net.sf.tweety.commons.AbstractInterpretation

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ProbabilityDistribution

Method Detail

getSignature

satisfies

satisfies

probability

probability

conditionalProbability

normalize

entropy

convexCombination

linearCombination

convexCombination

getUniformDistribution

toString

clear

containsKey

containsValue

entrySet

get

isEmpty

put

putAll

remove

size

values

keySet