com.github.benmanes.caffeine.cache.simulator.policy.sketch.climbing

Class AbstractClimber

java.lang.Object

com.github.benmanes.caffeine.cache.simulator.policy.sketch.climbing.AbstractClimber

All Implemented Interfaces:

HillClimber

Direct Known Subclasses:

Adam, AmsGrad, Nadam, SimpleClimber, SimulatedAnnealingClimber, Stochastic

public abstract class AbstractClimber
extends Object
implements HillClimber

A skeleton for hill climbers that walk using the hit rate.

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.benmanes.caffeine.cache.simulator.policy.sketch.climbing.HillClimber

HillClimber.Adaptation, HillClimber.QueueType

Field Summary

Fields

Modifier and Type	Field and Description
protected int	hitsInMain
protected int	hitsInSample
protected int	hitsInWindow
protected int	missesInSample
protected double	previousHitRate
protected int	sampleSize

Constructor Summary

Constructors

Constructor and Description
AbstractClimber()

Method Summary

Modifier and Type	Method and Description
HillClimber.Adaptation	adapt(double windowSize, double probationSize, double protectedSize, boolean isFull) Determines how to adapt the segment sizes.
protected abstract double	adjust(double hitRate) Returns the amount to adapt by.
void	onHit(long key, HillClimber.QueueType queueType, boolean isFull) Records that a hit occurred with a full cache.
void	onMiss(long key, boolean isFull) Records that a miss occurred with a full cache.
protected void	resetSample(double hitRate) Starts the next sample period.

Methods inherited from class java.lang.Object

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

Field Detail

sampleSize

protected int sampleSize

hitsInMain

protected int hitsInMain

hitsInWindow

protected int hitsInWindow

hitsInSample

protected int hitsInSample

missesInSample

protected int missesInSample

previousHitRate

protected double previousHitRate

Constructor Detail

AbstractClimber

public AbstractClimber()

Method Detail

onMiss

public void onMiss(long key,
                   boolean isFull)

Description copied from interface: HillClimber

Records that a miss occurred with a full cache.

Specified by:

onMiss in interface HillClimber

Parameters:

key - the key accessed

isFull - if the cache is fully populated and had to evict

onHit

public void onHit(long key,
                  HillClimber.QueueType queueType,
                  boolean isFull)

Description copied from interface: HillClimber

Records that a hit occurred with a full cache.

Specified by:

onHit in interface HillClimber

Parameters:

key - the key accessed

queueType - the queue the entry was found in

isFull - if the cache is fully populated

adapt

public HillClimber.Adaptation adapt(double windowSize,
                                    double probationSize,
                                    double protectedSize,
                                    boolean isFull)

Description copied from interface: HillClimber

Determines how to adapt the segment sizes.

Specified by:

adapt in interface HillClimber

Parameters:

windowSize - the current window size

probationSize - the current probation size

protectedSize - the current protected size

isFull - if the cache is fully populated

Returns:

the adjustment to the segments

adjust

protected abstract double adjust(double hitRate)

Returns the amount to adapt by.

resetSample

protected void resetSample(double hitRate)

Starts the next sample period.