Package org.opennars.entity

Class Stamp

java.lang.Object

org.opennars.entity.Stamp

All Implemented Interfaces:

Serializable, Cloneable

public class Stamp
extends Object
implements Cloneable, Serializable

Stamps are used to keep track of done derivations

Author:

Pei Wang, Patrick Hammer

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Stamp.BaseEntry	Element of the evidential base of stamp

Field Summary

Fields

Modifier and Type	Field	Description
boolean	alreadyAnticipatedNegConfirmation	is it a neg confirmation task that was already checked
int	baseLength	the length of @see evidentialBase
private long	creationTime	creation time of the stamp
static long	ETERNAL	default for atemporal events means "always" in Judgment/Question, but "current" in Goal/Quest
Stamp.BaseEntry[]	evidentialBase	serial numbers.
private int	evidentialHash	cache of hashcode of evidential base
private Stamp.BaseEntry[]	evidentialSet	caches evidentialBase as a set for comparisons and hashcode, stores the unique Long's in-order for efficiency
(package private) CharSequence	name	caches
private long	occurrenceTime	estimated occurrence time of the event
private Tense	tense	Tense of the item

Constructor Summary

Constructors

Modifier	Constructor	Description
	Stamp(long time, Tense tense, Stamp.BaseEntry serial, int duration)	Generate a new stamp, with a new serial number, for a new Task
private	Stamp(Stamp old)	Generate a new stamp identical with a given one
	Stamp(Stamp old, long creationTime)	Generate a new stamp from an existing one, with the same evidentialBase but different creation time
	Stamp(Stamp old, long creationTime, Stamp useEvidentialBase)
	Stamp(Stamp first, Stamp second, long time, Parameters narParameters)	Generate a new stamp for derived sentence by merging the two from parents the first one is no shorter than the second
	Stamp(Timable time, Memory memory)	creates a stamp with default Present tense
	Stamp(Timable time, Memory memory, Tense tense)
protected	Stamp(Tense tense, Stamp.BaseEntry serial)	used for when the ocrrence time will be set later; so should not be called from externally but through another Stamp constructor

Method Summary

Modifier and Type	Method	Description
boolean	after(Stamp s, int duration)
StringBuilder	appendOcurrenceTime(StringBuilder sb)
static boolean	baseOverlap(Stamp a, Stamp b)	Detects evidental base overlaps
boolean	before(Stamp s, int duration)
Stamp	clone()	Clone a stamp
Stamp	cloneWithNewOccurrenceTime(long newOcurrenceTime)
boolean	equals(Object that)
boolean	equals(Stamp s, boolean creationTime, boolean ocurrenceTime, boolean evidentialBase)	Check if two stamps contains the same types of content
boolean	evidenceIsCyclic()
int	evidentialHash()	hash code of Stamp
long	getCreationTime()
long	getOccurrenceTime()	Get the occurrenceTime of the truth-value
String	getOccurrenceTimeString()	Get the occurrenceTime of the truth-value
float	getOriginality()
String	getTense(long currentTime, int duration)
boolean	isEternal()
CharSequence	name()
void	setCreationTime(long time, int duration)	sets the creation time; used to set input tasks with the actual time they enter Memory
void	setEternal()
void	setOccurrenceTime(long time)
private Stamp.BaseEntry[]	toSet()	Convert the evidentialBase into a set
static Stamp.BaseEntry[]	toSetArray(Stamp.BaseEntry[] x)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

evidentialBase

public Stamp.BaseEntry[] evidentialBase

serial numbers. not to be modified after Stamp constructor has initialized it

baseLength

public int baseLength

the length of @see evidentialBase

creationTime

private long creationTime

creation time of the stamp

occurrenceTime

private long occurrenceTime

estimated occurrence time of the event

ETERNAL

public static final long ETERNAL

default for atemporal events means "always" in Judgment/Question, but "current" in Goal/Quest

See Also:

Constant Field Values

evidentialSet

private Stamp.BaseEntry[] evidentialSet

caches evidentialBase as a set for comparisons and hashcode, stores the unique Long's in-order for efficiency

tense

private Tense tense

Tense of the item

alreadyAnticipatedNegConfirmation

public boolean alreadyAnticipatedNegConfirmation

is it a neg confirmation task that was already checked

name

CharSequence name

caches

evidentialHash

private int evidentialHash

cache of hashcode of evidential base

Constructor Detail

Stamp

protected Stamp(Tense tense,
                Stamp.BaseEntry serial)

used for when the ocrrence time will be set later; so should not be called from externally but through another Stamp constructor

Stamp

public Stamp(long time,
             Tense tense,
             Stamp.BaseEntry serial,
             int duration)

Generate a new stamp, with a new serial number, for a new Task

Parameters:

time - Creation time of the stamp

Stamp

private Stamp(Stamp old)

Generate a new stamp identical with a given one

Parameters:

old - The stamp to be cloned

Stamp

public Stamp(Stamp old,
             long creationTime)

Generate a new stamp from an existing one, with the same evidentialBase but different creation time

For single-premise rules

Parameters:

old - The stamp of the single premise

creationTime - The current time

Stamp

public Stamp(Stamp old,
             long creationTime,
             Stamp useEvidentialBase)

Stamp

public Stamp(Stamp first,
             Stamp second,
             long time,
             Parameters narParameters)

Generate a new stamp for derived sentence by merging the two from parents the first one is no shorter than the second

Parameters:

first - The first Stamp

second - The second Stamp

Stamp

public Stamp(Timable time,
             Memory memory,
             Tense tense)

Stamp

public Stamp(Timable time,
             Memory memory)

creates a stamp with default Present tense

Method Detail

before

public boolean before(Stamp s,
                      int duration)

after

public boolean after(Stamp s,
                     int duration)

getOriginality

public float getOriginality()

baseOverlap

public static boolean baseOverlap(Stamp a,
                                  Stamp b)

Detects evidental base overlaps

evidenceIsCyclic

public boolean evidenceIsCyclic()

isEternal

public boolean isEternal()

setCreationTime

public void setCreationTime(long time,
                            int duration)

sets the creation time; used to set input tasks with the actual time they enter Memory

clone

public Stamp clone()

Clone a stamp

Overrides:

clone in class Object

Returns:

The cloned stamp

toSetArray

public static Stamp.BaseEntry[] toSetArray(Stamp.BaseEntry[] x)

toSet

private Stamp.BaseEntry[] toSet()

Convert the evidentialBase into a set

Returns:

The NavigableSet representation of the evidential base

equals

public boolean equals(Object that)

Overrides:

equals in class Object

equals

public boolean equals(Stamp s,
                      boolean creationTime,
                      boolean ocurrenceTime,
                      boolean evidentialBase)

Check if two stamps contains the same types of content

Parameters:

s - The Stamp to be compared

Returns:

Whether the two have contain the same evidential base

evidentialHash

public final int evidentialHash()

hash code of Stamp

Returns:

hash code

cloneWithNewOccurrenceTime

public Stamp cloneWithNewOccurrenceTime(long newOcurrenceTime)

getOccurrenceTime

public long getOccurrenceTime()

Get the occurrenceTime of the truth-value

Returns:

occurrence time

setEternal

public void setEternal()

appendOcurrenceTime

public StringBuilder appendOcurrenceTime(StringBuilder sb)

getOccurrenceTimeString

public String getOccurrenceTimeString()

Get the occurrenceTime of the truth-value

Returns:

occurrence time

getTense

public String getTense(long currentTime,
                       int duration)

setOccurrenceTime

public void setOccurrenceTime(long time)

name

public CharSequence name()

toString

public String toString()

Overrides:

toString in class Object

getCreationTime

public long getCreationTime()

Returns:

time of creation