BudgetValue (OpenNARS 3.0.4-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class BudgetValue
extends Object
implements Cloneable, Serializable
```
A triple of priority (current), durability (decay), and quality (long-term average).

Author:

Pei Wang, Patrick Hammer

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`private float`	`durability`	The percent of priority to be kept in a constant period; All priority values "decay" over time, though at different rates.
`private long`	`lastForgetTime`	time at which this budget was last forgotten, for calculating accurate memory decay rates
`private static char`	`MARK`	character that marks the two ends of a budget value
`private Parameters`	`narParameters`
`private float`	`priority`	relative share of time resource to be allocated
`private float`	`quality`	overall (context-independent) evaluation
`private static char`	`SEPARATOR`	character that separates the factors in a budget value

Constructor Summary

Constructors
Constructor	Description
`BudgetValue(float p, float d, float q, Parameters narParameters)`	Constructor with initialization
`BudgetValue(float p, float d, TruthValue qualityFromTruth, Parameters narParameters)`
`BudgetValue(BudgetValue v)`	Cloning constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`aboveThreshold()`	Whether the budget should get any processing at all
`void`	`andPriority(float v)`	AND's (multiplies) priority with another value
`BudgetValue`	`clone()`	Cloning method
`void`	`decDurability(float v)`	Decrease durability value by a percentage of the remaining range
`void`	`decPriority(float v)`	Decrease priority value by a percentage of the remaining range
`void`	`decQuality(float v)`	Decrease quality value by a percentage of the remaining range
`boolean`	`equalsByPrecision(Object that)`
`float`	`getDurability()`	Get durability value
`long`	`getLastForgetTime()`
`float`	`getPriority()`	Get priority value
`float`	`getQuality()`	Get quality value
`boolean`	`greaterThan(BudgetValue rhs)`
`void`	`incDurability(float v)`	Increase durability value by a percentage of the remaining range
`void`	`incPriority(float v)`	Increase priority value by a percentage of the remaining range
`void`	`incQuality(float v)`	Increase quality value by a percentage of the remaining range
`void`	`merge(BudgetValue that)`	Merge one BudgetValue into another
`void`	`setDurability(float d)`	Change durability value
`long`	`setLastForgetTime(long currentTime)`	computes the period and sets the current time to the period
`void`	`setPriority(float v)`	Change priority value
`void`	`setQuality(float v)`	Change quality value
`float`	`summary()`	To summarize a BudgetValue into a single number in [0, 1]
`String`	`toString()`	Fully display the BudgetValue
`String`	`toStringExternal()`	Briefly display the BudgetValue

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

- Field Detail
  - MARK
```
private static final char MARK
```
    character that marks the two ends of a budget value
    
    See Also:
    
    Constant Field Values
  - SEPARATOR
```
private static final char SEPARATOR
```
    character that separates the factors in a budget value
    
    See Also:
    
    Constant Field Values
  - priority
```
private float priority
```
    relative share of time resource to be allocated
  - durability
```
private float durability
```
    The percent of priority to be kept in a constant period; All priority values "decay" over time, though at different rates. Each item is given a "durability" factor in (0, 1) to specify the percentage of priority level left after each reevaluation
  - quality
```
private float quality
```
    overall (context-independent) evaluation
  - lastForgetTime
```
private long lastForgetTime
```
    time at which this budget was last forgotten, for calculating accurate memory decay rates
  - narParameters
```
private Parameters narParameters
```
- Constructor Detail
  - BudgetValue
```
public BudgetValue(float p,
                   float d,
                   TruthValue qualityFromTruth,
                   Parameters narParameters)
```
  - BudgetValue
```
public BudgetValue(float p,
                   float d,
                   float q,
                   Parameters narParameters)
```
    Constructor with initialization
    
    Parameters:
    
    p - Initial priority
    
    d - Initial durability
    
    q - Initial quality
  - BudgetValue
```
public BudgetValue(BudgetValue v)
```
    Cloning constructor
    
    Parameters:
    
    v - Budget value to be cloned
- Method Detail
  - clone
```
public BudgetValue clone()
```
    Cloning method
    
    Overrides:
    
    clone in class Object
  - getPriority
```
public float getPriority()
```
    Get priority value
    
    Returns:
    
    The current priority
  - setPriority
```
public final void setPriority(float v)
```
    Change priority value
    
    Parameters:
    
    v - The new priority
  - incPriority
```
public void incPriority(float v)
```
    Increase priority value by a percentage of the remaining range
    
    Parameters:
    
    v - The increasing percent
  - andPriority
```
public void andPriority(float v)
```
    AND's (multiplies) priority with another value
  - decPriority
```
public void decPriority(float v)
```
    Decrease priority value by a percentage of the remaining range
    
    Parameters:
    
    v - The decreasing percent
  - getDurability
```
public float getDurability()
```
    Get durability value
    
    Returns:
    
    The current durability
  - setDurability
```
public void setDurability(float d)
```
    Change durability value
    
    Parameters:
    
    d - The new durability
  - incDurability
```
public void incDurability(float v)
```
    Increase durability value by a percentage of the remaining range
    
    Parameters:
    
    v - The increasing percent
  - decDurability
```
public void decDurability(float v)
```
    Decrease durability value by a percentage of the remaining range
    
    Parameters:
    
    v - The decreasing percent
  - getQuality
```
public float getQuality()
```
    Get quality value
    
    Returns:
    
    The current quality
  - setQuality
```
public void setQuality(float v)
```
    Change quality value
    
    Parameters:
    
    v - The new quality
  - incQuality
```
public void incQuality(float v)
```
    Increase quality value by a percentage of the remaining range
    
    Parameters:
    
    v - The increasing percent
  - decQuality
```
public void decQuality(float v)
```
    Decrease quality value by a percentage of the remaining range
    
    Parameters:
    
    v - The decreasing percent
  - merge
```
public void merge(BudgetValue that)
```
    Merge one BudgetValue into another
    
    Parameters:
    
    that - The other Budget
  - greaterThan
```
public boolean greaterThan(BudgetValue rhs)
```
    Parameters:
    
    rhs - compared truth value
    
    Returns:
    
    if this budget is greater in all quantities than another budget,
  - summary
```
public float summary()
```
    To summarize a BudgetValue into a single number in [0, 1]
    
    Returns:
    
    The summary value
  - equalsByPrecision
```
public boolean equalsByPrecision(Object that)
```
  - aboveThreshold
```
public boolean aboveThreshold()
```
    Whether the budget should get any processing at all
    to be revised to depend on how busy the system is
    
    Returns:
    
    The decision on whether to process the Item
  - toString
```
public String toString()
```
    Fully display the BudgetValue
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of the value
  - toStringExternal
```
public String toStringExternal()
```
    Briefly display the BudgetValue
    
    Returns:
    
    String representation of the value with 2-digit accuracy
  - setLastForgetTime
```
public long setLastForgetTime(long currentTime)
```
    computes the period and sets the current time to the period
    
    Returns:
    
    period in time: currentTime - lastForgetTime
  - getLastForgetTime
```
public long getLastForgetTime()
```

Class BudgetValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MARK

SEPARATOR

priority

durability

quality

lastForgetTime

narParameters

Constructor Detail

BudgetValue

BudgetValue

BudgetValue

Method Detail

clone

getPriority

setPriority

incPriority

andPriority

decPriority

getDurability

setDurability

incDurability

decDurability

getQuality

setQuality

incQuality

decQuality

merge

greaterThan

summary

equalsByPrecision

aboveThreshold

toString

toStringExternal

setLastForgetTime

getLastForgetTime