SimpleCache

java.lang.Object
- jdd.bdd.CacheBase
- - jdd.bdd.SimpleCache

Direct Known Subclasses:

OptimizedCache
```
public class SimpleCache
extends CacheBase
```
A cache class that is [we belive] faster and uses less memory than Cache.java.

See Also:

Cache, DoubleCache, OptimizedCache

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`answer`
`protected int`	`bdds`
`protected int`	`cache_size`
`int`	`hash_value`
`protected long`	`hit`
`protected long`	`last_access`
`protected long`	`last_hit`
`protected int`	`members`
`protected long`	`miss`
`protected long`	`num_access`
`protected int`	`num_clears`
`protected int`	`num_grows`
`protected int`	`width`

Constructor Summary

Constructors
Constructor and Description
`SimpleCache(String name, int size, int members, int bdds)` the arguments are: (size of elements, number of members.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check_cache(NodeTable nt)`
`protected void`	`clear_cache()` invalidate the complete cache
`double`	`computeHitRate()` the hit rate, 0-100%
`double`	`computeLoadFactor()` the load factor, 0-100%
`void`	`free_or_grow()` try to grow the cache.
`void`	`free_or_grow(NodeTable nt)` either _partially_ wipe the cache or try to grow it.
`long`	`getAccessCount()` number of times the cache was accessed
`int`	`getCacheSize()` size of the cache
`protected int`	`getIn(int i, int member)`
`long`	`getMemoryUsage()`
`int`	`getNumberOfClears()` number of times cache was cleared
`int`	`getNumberOfGrows()` number of times cache was growed
`int`	`getNumberOfPartialClears()` number of times cache was partially
`protected int`	`getOut(int i)`
`int`	`getSize()` the _real_ size of the cache.
`protected int`	`good_hash(int i)`
`protected int`	`good_hash(int i, int j)`
`protected int`	`good_hash(int i, int j, int k)`
`protected void`	`grow_and_invalidate_cache()` grow the cache and invalidate everything [since the hash function hash chagned]
`void`	`insert(int hash, int key1, int value)` this is the _correct_ way to insert something into the cache.
`void`	`insert(int hash, int key1, int key2, int value)` this is the _correct_ way to insert something into the cache.
`void`	`insert(int hash, int key1, int key2, int key3, int value)` this is the _correct_ way to insert something into the cache.
`static void`	`internal_test()` testbench.
`void`	`invalidate_cache()` just wipe the cache
`void`	`invalidate_cache(NodeTable nt)` removes the elements that are garbage collected.
`protected void`	`invalidate(int number)`
`protected boolean`	`isValid(int number)`
`boolean`	`lookup(int a)` lookup the element associated with (a) returns true if element found (stored in SimpleCache.answer) returns false if element not found.
`boolean`	`lookup(int a, int b)` lookup the element associated with (a,b) returns true if element found (stored in SimpleCache.answer) returns false if element not found.
`boolean`	`lookup(int a, int b, int c)` lookup the element associated with (a,b,c) returns true if element found (stored in SimpleCache.answer) returns false if element not found.
`protected boolean`	`may_grow()` see if we are allowed to grow this cache.
`protected void`	`setIn(int i, int member, int v)`
`protected void`	`setOut(int i, int v)`
`void`	`show_tuple(int bdd)`
`void`	`showStats()`

Methods inherited from class jdd.bdd.CacheBase
getName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - answer
```
public int answer
```
  - hash_value
```
public int hash_value
```
  - members
```
protected int members
```
  - width
```
protected int width
```
  - bdds
```
protected int bdds
```
  - num_clears
```
protected int num_clears
```
  - num_grows
```
protected int num_grows
```
  - cache_size
```
protected int cache_size
```
  - num_access
```
protected long num_access
```
  - hit
```
protected long hit
```
  - miss
```
protected long miss
```
  - last_hit
```
protected long last_hit
```
  - last_access
```
protected long last_access
```
- Constructor Detail
  - SimpleCache
```
public SimpleCache(String name,
                   int size,
                   int members,
                   int bdds)
```
    the arguments are: (size of elements, number of members. number of members that also are BDD nodes)
- Method Detail
  - getOut
```
protected final int getOut(int i)
```
  - setOut
```
protected final void setOut(int i,
                            int v)
```
  - getIn
```
protected final int getIn(int i,
                          int member)
```
  - setIn
```
protected final void setIn(int i,
                           int member,
                           int v)
```
  - clear_cache
```
protected final void clear_cache()
```
    invalidate the complete cache
  - invalidate
```
protected final void invalidate(int number)
```
  - isValid
```
protected final boolean isValid(int number)
```
  - getMemoryUsage
```
public long getMemoryUsage()
```
  - getSize
```
public int getSize()
```
    the _real_ size of the cache. it is probably higher than what the user requested
  - may_grow
```
protected boolean may_grow()
```
    see if we are allowed to grow this cache. We grow the cache if (num_grows < MAX_SIMPLECACHE_GROWS) and the hit-rate since the last grow is larger than MIN_SIMPLECACHE_HITRATE_TO_GROW.
  - invalidate_cache
```
public void invalidate_cache()
```
    just wipe the cache
  - free_or_grow
```
public void free_or_grow()
```
    try to grow the cache. if unable, it will just wipe the cache clean
  - grow_and_invalidate_cache
```
protected void grow_and_invalidate_cache()
```
    grow the cache and invalidate everything [since the hash function hash chagned]
  - free_or_grow
```
public void free_or_grow(NodeTable nt)
```
    either _partially_ wipe the cache or try to grow it. XXX: at the moment, if cache is grown all current data is lost
    
    See Also:
    
    free_or_grow()
  - invalidate_cache
```
public void invalidate_cache(NodeTable nt)
```
    removes the elements that are garbage collected. this is where the "bdds" variable in constructor is used.
  - insert
```
public void insert(int hash,
                   int key1,
                   int value)
```
    this is the _correct_ way to insert something into the cache. format: (key1->value)
  - insert
```
public void insert(int hash,
                   int key1,
                   int key2,
                   int value)
```
    this is the _correct_ way to insert something into the cache. format: (key1,key2->value)
  - insert
```
public void insert(int hash,
                   int key1,
                   int key2,
                   int key3,
                   int value)
```
    this is the _correct_ way to insert something into the cache. format: (key1,key2,key3->value)
  - lookup
```
public final boolean lookup(int a)
```
    lookup the element associated with (a) returns true if element found (stored in SimpleCache.answer) returns false if element not found. user should copy the hash value from SimpleCache.hash_value before doing any more cache-operations!
  - lookup
```
public final boolean lookup(int a,
                            int b)
```
    lookup the element associated with (a,b) returns true if element found (stored in SimpleCache.answer) returns false if element not found. user should copy the hash value from SimpleCache.hash_value before doing any more cache-operations!
  - lookup
```
public final boolean lookup(int a,
                            int b,
                            int c)
```
    lookup the element associated with (a,b,c) returns true if element found (stored in SimpleCache.answer) returns false if element not found. user should copy the hash value from SimpleCache.hash_value before doing any more cache-operations!
  - good_hash
```
protected final int good_hash(int i)
```
  - good_hash
```
protected final int good_hash(int i,
                              int j)
```
  - good_hash
```
protected final int good_hash(int i,
                              int j,
                              int k)
```
  - computeLoadFactor
```
public double computeLoadFactor()
```
    Description copied from class: CacheBase
    
    the load factor, 0-100%
    
    Specified by:
    
    computeLoadFactor in class CacheBase
  - computeHitRate
```
public double computeHitRate()
```
    Description copied from class: CacheBase
    
    the hit rate, 0-100%
    
    Specified by:
    
    computeHitRate in class CacheBase
  - getAccessCount
```
public long getAccessCount()
```
    Description copied from class: CacheBase
    
    number of times the cache was accessed
    
    Specified by:
    
    getAccessCount in class CacheBase
  - getCacheSize
```
public int getCacheSize()
```
    Description copied from class: CacheBase
    
    size of the cache
    
    Specified by:
    
    getCacheSize in class CacheBase
  - getNumberOfClears
```
public int getNumberOfClears()
```
    Description copied from class: CacheBase
    
    number of times cache was cleared
    
    Specified by:
    
    getNumberOfClears in class CacheBase
  - getNumberOfPartialClears
```
public int getNumberOfPartialClears()
```
    Description copied from class: CacheBase
    
    number of times cache was partially
    
    Specified by:
    
    getNumberOfPartialClears in class CacheBase
  - getNumberOfGrows
```
public int getNumberOfGrows()
```
    Description copied from class: CacheBase
    
    number of times cache was growed
    
    Specified by:
    
    getNumberOfGrows in class CacheBase
  - showStats
```
public void showStats()
```
  - show_tuple
```
public void show_tuple(int bdd)
```
  - check_cache
```
public void check_cache(NodeTable nt)
```
  - internal_test
```
public static void internal_test()
```
    testbench. do not call

Class SimpleCache

Field Summary

Constructor Summary

Method Summary

Methods inherited from class jdd.bdd.CacheBase

Methods inherited from class java.lang.Object

Field Detail

answer

hash_value

members

width

bdds

num_clears

num_grows

cache_size

num_access

hit

miss

last_hit

last_access

Constructor Detail

SimpleCache

Method Detail

getOut

setOut

getIn

setIn

clear_cache

invalidate

isValid

getMemoryUsage

getSize

may_grow

invalidate_cache

free_or_grow

grow_and_invalidate_cache

free_or_grow

invalidate_cache

insert

insert

insert

lookup

lookup

lookup

good_hash

good_hash

good_hash

computeLoadFactor

computeHitRate

getAccessCount

getCacheSize

getNumberOfClears

getNumberOfPartialClears

getNumberOfGrows

showStats

show_tuple

check_cache

internal_test