Class: Bag

Methods

add(e)

utils/Bag.js, line 183

Adds the specified element to the end of this bag. if needed also
increases the capacity of the bag.

Name	Type	Description
e		element to be added to this list

addAll(items)

utils/Bag.js, line 229

Add all items into this bag.

Name	Type	Description
items

clear()

utils/Bag.js, line 216

Removes all of the elements from this bag. The bag will be empty after
this call returns.

contains(e){boolean}

utils/Bag.js, line 74

Check if bag contains this element.

Name	Type	Description
e

Returns:

Type	Description
boolean

get(index){Object}

utils/Bag.js, line 120

Returns the element at the specified position in Bag.

Name	Type	Description
index		index of the element to return

Returns:

Type	Description
Object	the element at the specified position in bag

getCapacity(){number}

utils/Bag.js, line 156

Returns the number of elements the bag can hold without growing.

Returns:

Type	Description
number	the number of elements the bag can hold without growing.

isEmpty(){boolean}

utils/Bag.js, line 173

Returns true if this list contains no elements.

Returns:

Type	Description
boolean	true if this list contains no elements

isIndexWithinBounds(index){boolean}

utils/Bag.js, line 165

Checks if the internal storage supports this index.

Name	Type	Description
index

Returns:

Type	Description
boolean

remove(e){boolean}

utils/Bag.js, line 41

Removes the first occurrence of the specified element from this Bag, if
it is present. If the Bag does not contain the element, it is unchanged.
does this by overwriting it was last element then removing last element

Name	Type	Description
e		element to be removed from this list, if present

Returns:

Type	Description
boolean	true if this list contained the specified element

removeAll(bag){boolean}

utils/Bag.js, line 92

Removes from this Bag all of its elements that are contained in the
specified Bag.

Name	Type	Description
bag		Bag containing elements to be removed from this Bag

Returns:

Type	Description
boolean	true if this Bag changed as a result of the call

removeAt(index){Object}

utils/Bag.js, line 26

Removes the element at the specified position in this Bag. does this by
overwriting it was last element then removing last element

Name	Type	Description
index		the index of element to be removed

Returns:

Type	Description
Object	element that was removed from the Bag

removeLast(){Object}

utils/Bag.js, line 60

Remove and return the last object in the bag.

Returns:

Type	Description
Object	the last object in the bag, null if empty.

safeGet(index){Object}

utils/Bag.js, line 137

Returns the element at the specified position in Bag. This method
ensures that the bag grows if the requested index is outside the bounds
of the current backing array.

Name	Type	Description
index		index of the element to return

Returns:

Type	Description
Object	the element at the specified position in bag

set(index, e)

utils/Bag.js, line 196

Set element at specified index in the bag.

Name	Type	Description
index		position of element
e		the element

size(){number}

utils/Bag.js, line 148

Returns the number of elements in this bag.

Returns:

Type	Description
number	the number of elements in this bag