Bag (OpenNARS 3.0.4-SNAPSHOT API)

java.lang.Object
- org.opennars.storage.Bag<Type,K>

All Implemented Interfaces:

Serializable, Iterable<Type>
```
public class Bag<Type extends Item<K>,K>
extends Object
implements Serializable, Iterable<Type>
```
Original Bag implementation which distributes items into discrete levels (queues) according to priority

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`private int`	`capacity`	defined in different bags
`private int`	`currentCounter`	maximum number of items to be taken out at current level
`private int`	`currentLevel`	current take out level
`private Distributor`	`DISTRIBUTOR`	shared DISTRIBUTOR that produce the probability distribution
`private ArrayList<ArrayList<Type>>`	`itemTable`	array of lists of items, for items on different level
`private int`	`levelIndex`	index to get next level, kept in individual objects
`private int`	`mass`	current sum of occupied level
`private HashMap<K,Type>`	`nameTable`	mapping from key to item
`private int`	`THRESHOLD`	firing threshold
`private int`	`TOTAL_LEVEL`	priority levels

Constructor Summary

Constructors
Constructor	Description
`Bag(int levels, int capacity, int thresholdLevel)`	thresholdLevel = 0 disables "fire level completely" threshold effect
`Bag(int levels, int capacity, Parameters narParameters)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`
`boolean`	`contains(Type it)`	Check if an item is in the bag
`protected boolean`	`emptyLevel(int n)`	Check whether a level is empty
`Type`	`get(K key)`	Get an Item by key
`float`	`getAveragePriority()`	Get the average priority of Items
`private int`	`getLevel(Type item)`	Decide the put-in level according to priority
`private Type`	`intoBase(Type newItem)`	Insert an item into the itemTable, and return the overflow
`Iterator<Type>`	`iterator()`
`protected void`	`outOfBase(Type oldItem)`	Remove an item from itemTable, then adjust mass
`Type`	`pickOut(K key)`	Pick an item by key, then remove it from the bag
`Type`	`pickOut(Type val)`
`Type`	`putBack(Type oldItem, float forgetCycles, Memory m)`	Put an item back into the itemTable
`Type`	`putIn(Type newItem)`	Add a new Item into the Bag
`(package private) String`	`showSizes()`
`int`	`size()`
`Type`	`takeOut()`	Choose an Item according to priority distribution and take it out of the Bag
`private Type`	`takeOutFirst(int level)`	Take out the first or last Type in a level from the itemTable
`String`	`toString()`	Collect Bag content into a String for display
`String`	`toStringLong()`	TODO bad paste from preceding

Methods inherited from interface java.lang.Iterable
forEach, spliterator

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

- Field Detail
  - TOTAL_LEVEL
```
private final int TOTAL_LEVEL
```
    priority levels
  - THRESHOLD
```
private final int THRESHOLD
```
    firing threshold
  - DISTRIBUTOR
```
private final Distributor DISTRIBUTOR
```
    shared DISTRIBUTOR that produce the probability distribution
  - nameTable
```
private HashMap<K,Type extends Item<K>> nameTable
```
    mapping from key to item
  - itemTable
```
private ArrayList<ArrayList<Type extends Item<K>>> itemTable
```
    array of lists of items, for items on different level
  - capacity
```
private final int capacity
```
    defined in different bags
  - mass
```
private int mass
```
    current sum of occupied level
  - levelIndex
```
private int levelIndex
```
    index to get next level, kept in individual objects
  - currentLevel
```
private int currentLevel
```
    current take out level
  - currentCounter
```
private int currentCounter
```
    maximum number of items to be taken out at current level
- Constructor Detail
  - Bag
```
public Bag(int levels,
           int capacity,
           Parameters narParameters)
```
  - Bag
```
public Bag(int levels,
           int capacity,
           int thresholdLevel)
```
    thresholdLevel = 0 disables "fire level completely" threshold effect
- Method Detail
  - clear
```
public void clear()
```
  - getAveragePriority
```
public float getAveragePriority()
```
    Get the average priority of Items
    
    Returns:
    
    The average priority of Items in the bag
  - contains
```
public boolean contains(Type it)
```
    Check if an item is in the bag
    
    Parameters:
    
    it - An item
    
    Returns:
    
    Whether the Item is in the Bag
  - get
```
public Type get(K key)
```
    Get an Item by key
    
    Parameters:
    
    key - The key of the Item
    
    Returns:
    
    The Item with the given key
  - putIn
```
public Type putIn(Type newItem)
```
    Add a new Item into the Bag
    
    Parameters:
    
    newItem - The new Item
    
    Returns:
    
    Whether the new Item is added into the Bag
  - putBack
```
public Type putBack(Type oldItem,
                    float forgetCycles,
                    Memory m)
```
    Put an item back into the itemTable
    The only place where the forgetting rate is applied
    
    Parameters:
    
    oldItem - The Item to put back
    
    m - related memory
    
    Returns:
    
    the item which was removed, or null if none removed
  - takeOut
```
public Type takeOut()
```
    Choose an Item according to priority distribution and take it out of the Bag
    
    Returns:
    
    The selected Item
  - pickOut
```
public Type pickOut(K key)
```
    Pick an item by key, then remove it from the bag
    
    Parameters:
    
    key - The given key
    
    Returns:
    
    The Item with the key
  - pickOut
```
public Type pickOut(Type val)
```
  - emptyLevel
```
protected boolean emptyLevel(int n)
```
    Check whether a level is empty
    
    Parameters:
    
    n - The level index
    
    Returns:
    
    Whether that level is empty
  - getLevel
```
private int getLevel(Type item)
```
    Decide the put-in level according to priority
    
    Parameters:
    
    item - The Item to put in
    
    Returns:
    
    The put-in level
  - intoBase
```
private Type intoBase(Type newItem)
```
    Insert an item into the itemTable, and return the overflow
    
    Parameters:
    
    newItem - The Item to put in
    
    Returns:
    
    The overflow Item
  - takeOutFirst
```
private Type takeOutFirst(int level)
```
    Take out the first or last Type in a level from the itemTable
    
    Parameters:
    
    level - The current level
    
    Returns:
    
    The first Item
  - outOfBase
```
protected void outOfBase(Type oldItem)
```
    Remove an item from itemTable, then adjust mass
    
    Parameters:
    
    oldItem - The Item to be removed
  - toString
```
public String toString()
```
    Collect Bag content into a String for display
    
    Overrides:
    
    toString in class Object
  - toStringLong
```
public String toStringLong()
```
    TODO bad paste from preceding
  - showSizes
```
String showSizes()
```
  - size
```
public int size()
```
  - iterator
```
public Iterator<Type> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Type extends Item<K>>

Class Bag<Type extends Item<K>,K>

Field Summary

Constructor Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from class java.lang.Object

Field Detail

TOTAL_LEVEL

THRESHOLD

DISTRIBUTOR

nameTable

itemTable

capacity

mass

levelIndex

currentLevel

currentCounter

Constructor Detail

Bag

Bag

Method Detail

clear

getAveragePriority

contains

get

putIn

putBack

takeOut

pickOut

pickOut

emptyLevel

getLevel

intoBase

takeOutFirst

outOfBase

toString

toStringLong

showSizes

size

iterator