org.broadinstitute.hellbender.utils

Class IntToDoubleFunctionCache

java.lang.Object

org.broadinstitute.hellbender.utils.IntToDoubleFunctionCache

Direct Known Subclasses:

DigammaCache, Log10Cache, Log10FactorialCache

public abstract class IntToDoubleFunctionCache
extends java.lang.Object

A helper class to maintain a cache of an int to double function defined on n = 0, 1, 2. . . The cache expands when a number is not available. NOTE: this cache is thread safe and it may be accessed from multiple threads.

Constructor Summary

Constructors

Constructor and Description
IntToDoubleFunctionCache()

Method Summary

Modifier and Type	Method and Description
protected abstract double	compute(int n)
void	expandCache(int newCapacity) Ensures that the cache contains a value for n.
double	get(int i) Get the value of the function, expanding the cache as necessary.
protected abstract int	maxSize()
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

IntToDoubleFunctionCache

public IntToDoubleFunctionCache()

Method Detail

maxSize

protected abstract int maxSize()

compute

protected abstract double compute(int n)

get

public double get(int i)

Get the value of the function, expanding the cache as necessary. The cache only applies to non-negative values.

Parameters:

i - operand

Returns:

the value of the cached function at i

expandCache

public void expandCache(int newCapacity)

Ensures that the cache contains a value for n. After completion of expandCache(n), get(n) is guaranteed to return without causing a cache expansion

Parameters:

newCapacity - desired value to be precomputed

size

public int size()