org.jactr.core.utils.references

Interface IReferences

All Known Subinterfaces:

IOptimizedReferences

All Known Implementing Classes:

DefaultReferences, ImmutableReferences

public interface IReferences

interface used to track the number and times of references of objects in a model

Author:

developer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IReferences.Factory factory for instantiating new references

Method Summary

Modifier and Type	Method and Description
void	addReferenceTime(double time) add a reference time and increment the reference count
void	clear() clear it out
double	getLastReferenceTime() get the last time there has been a reference
long	getNumberOfReferences() get the number of references.
double[]	getRelativeTimes(double referenceTime) get all the reference times relative to referenceTime
double[]	getTimes() get all the tracked absolute reference times.
void	removeReferenceTime(double time) remove a reference time and decrement the reference coutn
void	setNumberOfReferences(long references)

Method Detail

getTimes

double[] getTimes()

get all the tracked absolute reference times. The order of the times is not guaranteed

Returns:

all the known absolute reference times

getRelativeTimes

double[] getRelativeTimes(double referenceTime)

get all the reference times relative to referenceTime

Parameters:

referenceTime -

Returns:

getNumberOfReferences

long getNumberOfReferences()

get the number of references. this value need not equal getTimes().size(), for instance getTimes() might just track a window of values and not every reference.

Returns:

getLastReferenceTime

double getLastReferenceTime()

get the last time there has been a reference

Returns:

addReferenceTime

void addReferenceTime(double time)

add a reference time and increment the reference count

Parameters:

time -

removeReferenceTime

void removeReferenceTime(double time)

remove a reference time and decrement the reference coutn

Parameters:

time -

clear

void clear()

clear it out

setNumberOfReferences

void setNumberOfReferences(long references)

Parameters:

references -