TruthValue (OpenNARS 3.0.4-SNAPSHOT API)

java.lang.Object
- org.opennars.entity.TruthValue

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

TruthFunctions.EternalizedTruthValue
```
public class TruthValue
extends Object
implements Cloneable, Serializable
```
Truth is a tuple of frequency and confidence as defined by NARS theory

Author:

Pei Wang, Patrick Hammer

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`analytic`	Whether the truth value is derived from a definition
`private double`	`confidence`	confidence factor of the truth value
`private static char`	`DELIMITER`	character that marks the two ends of a truth value
`private float`	`frequency`	frequency factor of the truth value
`private Parameters`	`narParameters`
`private static char`	`SEPARATOR`	character that separates the factors in a truth value
`(package private) static Term`	`Truth_FALSE`
`(package private) static Term`	`Truth_TRUE`
`(package private) static Term`	`Truth_UNSURE`

Constructor Summary

Constructors
Constructor	Description
`TruthValue(float f, double c, boolean isAnalytic, Parameters narParameters)`	Constructor
`TruthValue(float f, double c, Parameters narParameters)`	Constructor
`TruthValue(TruthValue v)`	Constructor with a TruthValue to clone
`TruthValue(Parameters narParameters)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`StringBuilder`	`appendString(StringBuilder sb, boolean external)`	A simplified String representation of a TruthValue
`TruthValue`	`clone()`
`boolean`	`equals(Object that)`	Compare two truth values
`static TruthValue`	`fromWordTerm(Parameters narParameters, Term term)`
`boolean`	`getAnalytic()`
`double`	`getConfidence()`	returns the confidence value
`float`	`getExpDifAbs(TruthValue t)`	Calculate the absolute difference of the expectation value and that of a given truth value
`float`	`getExpectation()`	Calculate the expectation value of the truth value
`float`	`getFrequency()`	returns the frequency value
`int`	`hashCode()`	The hash code of a TruthValue
`static boolean`	`isEqual(double a, double b, double epsilon)`
`boolean`	`isNegative()`	Check if the truth value is negative
`TruthValue`	`mulConfidence(float mul)`
`CharSequence`	`name()`
`TruthValue`	`set(float frequency, double confidence)`
`void`	`setAnalytic()`	Set it to analytic truth
`TruthValue`	`setAnalytic(boolean a)`
`TruthValue`	`setConfidence(double c)`
`TruthValue`	`setFrequency(float f)`
`String`	`toString()`	Returns a String representation of a TruthValue, as used internally by the system
`CharSequence`	`toStringExternal()`	output representation
`Term`	`toWordTerm()`

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

- Field Detail
  - Truth_TRUE
```
static final Term Truth_TRUE
```
  - Truth_FALSE
```
static final Term Truth_FALSE
```
  - Truth_UNSURE
```
static final Term Truth_UNSURE
```
  - DELIMITER
```
private static final char DELIMITER
```
    character that marks the two ends of a truth value
    
    See Also:
    
    Constant Field Values
  - SEPARATOR
```
private static final char SEPARATOR
```
    character that separates the factors in a truth value
    
    See Also:
    
    Constant Field Values
  - frequency
```
private float frequency
```
    frequency factor of the truth value
  - confidence
```
private double confidence
```
    confidence factor of the truth value
  - analytic
```
private boolean analytic
```
    Whether the truth value is derived from a definition
  - narParameters
```
private Parameters narParameters
```
- Constructor Detail
  - TruthValue
```
public TruthValue(Parameters narParameters)
```
    Parameters:
    
    narParameters - parameters of the reasoner
  - TruthValue
```
public TruthValue(float f,
                  double c,
                  Parameters narParameters)
```
    Constructor
    
    Parameters:
    
    f - frequency value
    
    c - confidence value
    
    narParameters - parameters of the reasoner
  - TruthValue
```
public TruthValue(float f,
                  double c,
                  boolean isAnalytic,
                  Parameters narParameters)
```
    Constructor
    
    Parameters:
    
    f - frequency value
    
    c - confidence value
    
    isAnalytic - is the truth value an analytic one?
    
    narParameters - parameters of the reasoner
  - TruthValue
```
public TruthValue(TruthValue v)
```
    Constructor with a TruthValue to clone
    
    Parameters:
    
    v - truth value to be cloned
- Method Detail
  - getFrequency
```
public float getFrequency()
```
    returns the frequency value
    
    Returns:
    
    frequency value
  - getConfidence
```
public double getConfidence()
```
    returns the confidence value
    
    Returns:
    
    confidence value
  - setFrequency
```
public TruthValue setFrequency(float f)
```
  - setConfidence
```
public TruthValue setConfidence(double c)
```
  - mulConfidence
```
public TruthValue mulConfidence(float mul)
```
  - getAnalytic
```
public boolean getAnalytic()
```
    Returns:
    
    is it a analytic truth value?
  - setAnalytic
```
public void setAnalytic()
```
    Set it to analytic truth
  - getExpectation
```
public float getExpectation()
```
    Calculate the expectation value of the truth value
    
    Returns:
    
    expectation value
  - getExpDifAbs
```
public float getExpDifAbs(TruthValue t)
```
    Calculate the absolute difference of the expectation value and that of a given truth value
    
    Parameters:
    
    t - given value
    
    Returns:
    
    absolute difference
  - isNegative
```
public boolean isNegative()
```
    Check if the truth value is negative
    
    Returns:
    
    True if the frequency is less than 1/2
  - isEqual
```
public static boolean isEqual(double a,
                              double b,
                              double epsilon)
```
  - equals
```
public boolean equals(Object that)
```
    Compare two truth values
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    that - other TruthValue
    
    Returns:
    
    Whether the two are equivalent
  - hashCode
```
public int hashCode()
```
    The hash code of a TruthValue
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hash code
  - clone
```
public TruthValue clone()
```
    Overrides:
    
    clone in class Object
  - setAnalytic
```
public TruthValue setAnalytic(boolean a)
```
  - appendString
```
public StringBuilder appendString(StringBuilder sb,
                                  boolean external)
```
    A simplified String representation of a TruthValue
  - name
```
public CharSequence name()
```
  - toStringExternal
```
public CharSequence toStringExternal()
```
    output representation
  - toString
```
public String toString()
```
    Returns a String representation of a TruthValue, as used internally by the system
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation
  - toWordTerm
```
public Term toWordTerm()
```
  - fromWordTerm
```
public static TruthValue fromWordTerm(Parameters narParameters,
                                      Term term)
```
  - set
```
public TruthValue set(float frequency,
                      double confidence)
```

Class TruthValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Truth_TRUE

Truth_FALSE

Truth_UNSURE

DELIMITER

SEPARATOR

frequency

confidence

analytic

narParameters

Constructor Detail

TruthValue

TruthValue

TruthValue

TruthValue

Method Detail

getFrequency

getConfidence

setFrequency

setConfidence

mulConfidence

getAnalytic

setAnalytic

getExpectation

getExpDifAbs

isNegative

isEqual

equals

hashCode

clone

setAnalytic

appendString

name

toStringExternal

toString

toWordTerm

fromWordTerm

set