it.uniroma2.sag.kelp.kernel.cache

Class DynamicIndexSquaredNormCache

java.lang.Object

it.uniroma2.sag.kelp.kernel.cache.DynamicIndexSquaredNormCache

All Implemented Interfaces:

SquaredNormCache

public class DynamicIndexSquaredNormCache
extends Object
implements SquaredNormCache

Constructor Summary

Constructors

Constructor and Description
DynamicIndexSquaredNormCache()
DynamicIndexSquaredNormCache(int examplesToStore) Initializes a DynamicIndexSquaredNormCache that can contain all up to examplesToStore norms

Method Summary

Methods

Modifier and Type	Method and Description
void	flush() Empties the cache
int	getExamplesToStore() Returns the maximum number of norms that can be simultaneously stored
Float	getSquaredNorm(Example example) Returns a previously stored norm of a given example
void	setExamplesToStore(int examplesToStore) Sets the maximum number of norms that can be simultaneously stored
void	setSquaredNormValue(Example example, float squaredNorm) Stores a squared norm in the cache

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicIndexSquaredNormCache

public DynamicIndexSquaredNormCache(int examplesToStore)

Initializes a DynamicIndexSquaredNormCache that can contain all up to examplesToStore norms

Parameters:

examplesToStore - the maximum number of norms that can be simultaneously stored

DynamicIndexSquaredNormCache

public DynamicIndexSquaredNormCache()

Method Detail

getExamplesToStore

public int getExamplesToStore()

Returns the maximum number of norms that can be simultaneously stored

Returns:

the examplesToStore

setExamplesToStore

public void setExamplesToStore(int examplesToStore)

Sets the maximum number of norms that can be simultaneously stored

Parameters:

examplesToStore - the examplesToStore to set

NOTE: all the already stored norms will be lost

getSquaredNorm

public Float getSquaredNorm(Example example)

Description copied from interface: SquaredNormCache

Returns a previously stored norm of a given example

Specified by:

getSquaredNorm in interface SquaredNormCache

Parameters:

example - the instance whose squared norm is required

Returns:

the squared norm or null if a cache miss occurs

setSquaredNormValue

public void setSquaredNormValue(Example example,
                       float squaredNorm)

Description copied from interface: SquaredNormCache

Stores a squared norm in the cache

Specified by:

setSquaredNormValue in interface SquaredNormCache

Parameters:

example - the example whose quadratic norm must be stored

squaredNorm - the squared norm to be stored

flush

public void flush()

Description copied from interface: SquaredNormCache

Empties the cache

Specified by:

flush in interface SquaredNormCache