Package tools.refinery.interpreter.matchers.memories.timely

Class TimelyDefaultMaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

java.lang.Object

tools.refinery.interpreter.matchers.memories.MaskedTupleMemory<Timestamp>

tools.refinery.interpreter.matchers.memories.timely.TimelyDefaultMaskedTupleMemory<Timestamp>

All Implemented Interfaces:

Clearable, MaskedResumable<Timestamp>, Resumable<Timestamp>

public final class TimelyDefaultMaskedTupleMemory<Timestamp extends Comparable<Timestamp>>
extends MaskedTupleMemory<Timestamp>

Default timely implementation that covers all cases.

Since:

2.3

Field Summary

Fields

Modifier and Type	Field	Description
protected final TreeMap<Timestamp,Set<Tuple>>	foldingStates
protected final boolean	isLazy
protected final Map<Tuple,TimelyMemory<Timestamp>>	memoryMap

Fields inherited from class tools.refinery.interpreter.matchers.memories.MaskedTupleMemory

mask, owner

Constructor Summary

Constructors

Constructor	Description
TimelyDefaultMaskedTupleMemory(TupleMask mask, Object owner, boolean isLazy)

Method Summary

Modifier and Type	Method	Description
protected Diff<Timestamp>	addInternal(Tuple key, Tuple tuple, Timestamp timestamp)
Diff<Timestamp>	addWithTimestamp(Tuple tuple, Timestamp timestamp)	Adds a tuple occurrence to the memory with the given timestamp.
Diff<Timestamp>	addWithTimestamp(Tuple tuple, Tuple signature, Timestamp timestamp)	Adds a tuple occurrence to the memory with the given signature and timestamp.
void	clear()	Clear all partial matchings stored in memory
Collection<Tuple>	get(ITuple signature)	Retrieves tuples that have the specified signature
protected Collection<Tuple>	getInternal(Tuple key)
int	getKeysetSize()
Set<Tuple>	getResumableSignatures()	Returns the set of signatures for which lazy folding shall be resumed at the next timestamp.
Timestamp	getResumableTimestamp()	Returns the smallest timestamp where lazy folding shall be resumed, or null if there is no more folding to do in this resumable.
Iterable<Tuple>	getSignatures()	Retrieves a read-only view of exactly those signatures for which at least one tuple is stored
int	getTotalSize()
Map<Tuple,Timeline<Timestamp>>	getWithTimeline(ITuple signature)	Retrieves the tuples and their associated timelines that have the specified signature.
Map<Tuple,Timeline<Timestamp>>	getWithTimestampInternal(Tuple key)
void	initializeWith(MaskedTupleMemory<Timestamp> other, Timestamp defaultValue)	Initializes the contents of this memory based on the contents of another memory.
boolean	isPresentAtInfinity(ITuple signature)	Returns true if there is any tuple with the given signature that is present at the timestamp +inf, false otherwise.
boolean	isPresentAtInfinityInteral(Tuple key)
boolean	isTimely()	Returns true of this memory is timely, false otherwise.
Iterator<Tuple>	iterator()	Iterates over distinct tuples stored in the memory, regardless of their signatures.
protected void	registerFoldingState(Timestamp timestamp, Tuple key)
protected Diff<Timestamp>	removeInternal(Tuple key, Tuple tuple, Timestamp timestamp)
Diff<Timestamp>	removeWithTimestamp(Tuple tuple, Timestamp timestamp)	Removes a tuple occurrence from the memory with the given timestamp.
Diff<Timestamp>	removeWithTimestamp(Tuple tuple, Tuple signature, Timestamp timestamp)	Removes a tuple occurrence from the memory with the given signature and timestamp.
Map<Tuple,Map<Tuple,Diff<Timestamp>>>	resumeAt(Timestamp timestamp)	When called, the folding of the state shall be resumed at the given timestamp.
protected void	unregisterFoldingState(Timestamp timestamp, Tuple key)

Methods inherited from class tools.refinery.interpreter.matchers.memories.MaskedTupleMemory

add, add, create, create, create, getMask, getOrEmpty, getOrEmptyWithTimeline, getOwner, raiseDuplicateDeletion, raiseDuplicateInsertion, remove, remove, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

foldingStates

protected final TreeMap<Timestamp extends Comparable<Timestamp>,Set<Tuple>> foldingStates

memoryMap

protected final Map<Tuple,TimelyMemory<Timestamp extends Comparable<Timestamp>>> memoryMap

isLazy

protected final boolean isLazy

Constructor Details

TimelyDefaultMaskedTupleMemory

public TimelyDefaultMaskedTupleMemory(TupleMask mask,
 Object owner,
 boolean isLazy)

Method Details

getSignatures

public Iterable<Tuple> getSignatures()

Description copied from class: MaskedTupleMemory

Retrieves a read-only view of exactly those signatures for which at least one tuple is stored

Specified by:

getSignatures in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

removeWithTimestamp

public Diff<Timestamp> removeWithTimestamp(Tuple tuple,
 Tuple signature,
 Timestamp timestamp)

Description copied from class: MaskedTupleMemory

Removes a tuple occurrence from the memory with the given signature and timestamp.

Overrides:

removeWithTimestamp in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

Parameters:

tuple - the tuple to be removed from the memory

signature - precomputed footprint of the tuple according to the mask

timestamp - the timestamp associated with the tuple

Returns:

A Diff describing how the timeline of the given tuple changed.

addWithTimestamp

public Diff<Timestamp> addWithTimestamp(Tuple tuple,
 Tuple signature,
 Timestamp timestamp)

Description copied from class: MaskedTupleMemory

Adds a tuple occurrence to the memory with the given signature and timestamp.

Overrides:

addWithTimestamp in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

Parameters:

tuple - the tuple to be added to the memory

signature - precomputed footprint of the tuple according to the mask

timestamp - the timestamp associated with the tuple

Returns:

A Diff describing how the timeline of the given tuple changed.

get

public Collection<Tuple> get(ITuple signature)

Description copied from class: MaskedTupleMemory

Retrieves tuples that have the specified signature

Specified by:

get in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

Returns:

collection of tuples found, null if none

getWithTimeline

public Map<Tuple,Timeline<Timestamp>> getWithTimeline(ITuple signature)

Description copied from class: MaskedTupleMemory

Retrieves the tuples and their associated timelines that have the specified signature.

Specified by:

getWithTimeline in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

Returns:

the mappings from tuples to timelines, null if there is no mapping for the signature

isPresentAtInfinity

public boolean isPresentAtInfinity(ITuple signature)

Description copied from class: MaskedTupleMemory

Returns true if there is any tuple with the given signature that is present at the timestamp +inf, false otherwise.

Overrides:

isPresentAtInfinity in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

getResumableSignatures

public Set<Tuple> getResumableSignatures()

Description copied from interface: MaskedResumable

Returns the set of signatures for which lazy folding shall be resumed at the next timestamp.

Specified by:

getResumableSignatures in interface MaskedResumable<Timestamp extends Comparable<Timestamp>>

Overrides:

getResumableSignatures in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

resumeAt

public Map<Tuple,Map<Tuple,Diff<Timestamp>>> resumeAt(Timestamp timestamp)

Description copied from interface: MaskedResumable

When called, the folding of the state shall be resumed at the given timestamp. The resumable is expected to do a folding step at the given timestamp only. Afterwards, folding shall be interrupted, even if there is more folding to do towards higher timestamps.

Specified by:

resumeAt in interface MaskedResumable<Timestamp extends Comparable<Timestamp>>

Overrides:

resumeAt in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

initializeWith

public void initializeWith(MaskedTupleMemory<Timestamp> other,
 Timestamp defaultValue)

Description copied from class: MaskedTupleMemory

Initializes the contents of this memory based on the contents of another memory. The default value is associated with each tuple in the timely memories.

Overrides:

initializeWith in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

isPresentAtInfinityInteral

public boolean isPresentAtInfinityInteral(Tuple key)

clear

public void clear()

Description copied from interface: Clearable

Clear all partial matchings stored in memory

getKeysetSize

public int getKeysetSize()

Specified by:

getKeysetSize in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

Returns:

the number of distinct signatures of all stored tuples.

getTotalSize

public int getTotalSize()

Specified by:

getTotalSize in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

Returns:

the total number of distinct tuples stored. Multiple copies of the same tuple, if allowed, are counted as one.

This is currently not cached but computed on demand. It is therefore not efficient, and shall only be used for debug / profiling purposes.

iterator

public Iterator<Tuple> iterator()

Description copied from class: MaskedTupleMemory

Iterates over distinct tuples stored in the memory, regardless of their signatures.

Specified by:

iterator in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

getInternal

protected Collection<Tuple> getInternal(Tuple key)

getWithTimestampInternal

public Map<Tuple,Timeline<Timestamp>> getWithTimestampInternal(Tuple key)

removeInternal

protected Diff<Timestamp> removeInternal(Tuple key,
 Tuple tuple,
 Timestamp timestamp)

addInternal

protected Diff<Timestamp> addInternal(Tuple key,
 Tuple tuple,
 Timestamp timestamp)

removeWithTimestamp

public Diff<Timestamp> removeWithTimestamp(Tuple tuple,
 Timestamp timestamp)

Description copied from class: MaskedTupleMemory

Removes a tuple occurrence from the memory with the given timestamp.

Overrides:

removeWithTimestamp in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

Parameters:

tuple - the tuple to be removed from the memory

timestamp - the timestamp associated with the tuple

Returns:

A Diff describing how the timeline of the given tuple changed.

addWithTimestamp

public Diff<Timestamp> addWithTimestamp(Tuple tuple,
 Timestamp timestamp)

Description copied from class: MaskedTupleMemory

Adds a tuple occurrence to the memory with the given timestamp.

Overrides:

addWithTimestamp in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

Parameters:

tuple - the tuple to be added to the memory

timestamp - the timestamp associated with the tuple

Returns:

A Diff describing how the timeline of the given tuple changed.

isTimely

public boolean isTimely()

Description copied from class: MaskedTupleMemory

Returns true of this memory is timely, false otherwise.

Overrides:

isTimely in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>

registerFoldingState

protected void registerFoldingState(Timestamp timestamp,
 Tuple key)

unregisterFoldingState

protected void unregisterFoldingState(Timestamp timestamp,
 Tuple key)

getResumableTimestamp

public Timestamp getResumableTimestamp()

Description copied from interface: Resumable

Returns the smallest timestamp where lazy folding shall be resumed, or null if there is no more folding to do in this resumable.

Specified by:

getResumableTimestamp in interface Resumable<Timestamp extends Comparable<Timestamp>>

Overrides:

getResumableTimestamp in class MaskedTupleMemory<Timestamp extends Comparable<Timestamp>>