Package com.github.tommyettinger.ds

Class FloatBag

java.lang.Object

com.github.tommyettinger.ds.FloatList

com.github.tommyettinger.ds.FloatBag

All Implemented Interfaces:

Arrangeable, Ordered.OfFloat, PrimitiveCollection<Float>, PrimitiveCollection.OfFloat

public class FloatBag
extends FloatList

An unordered List of float items. This allows efficient iteration via a reused iterator or via index. This class avoids a memory copy when removing elements (the last element is moved to the removed element's position). Items are permitted to change position in the ordering when any item is removed or added. Although this won't keep an order during modifications, you can FloatList.sort() the bag to ensure, if no modifications are made later, that the iteration will happen in sorted order.

Nested Class Summary

Nested classes/interfaces inherited from class com.github.tommyettinger.ds.FloatList

FloatList.FloatListIterator

Nested classes/interfaces inherited from interface com.github.tommyettinger.ds.Arrangeable

Arrangeable.ArrangeableList<T>

Nested classes/interfaces inherited from interface com.github.tommyettinger.ds.PrimitiveCollection

PrimitiveCollection.OfBoolean, PrimitiveCollection.OfByte, PrimitiveCollection.OfChar, PrimitiveCollection.OfDouble, PrimitiveCollection.OfFloat, PrimitiveCollection.OfInt, PrimitiveCollection.OfLong, PrimitiveCollection.OfShort

Field Summary

Fields inherited from class com.github.tommyettinger.ds.FloatList

items, iterator1, iterator2, size

Constructor Summary

Constructors

Constructor	Description
FloatBag()	Creates an ordered bag with a capacity of 10.
FloatBag(float[] array)	Creates a new bag containing the elements in the specified array.
FloatBag(float[] array, int startIndex, int count)	Creates a new bag containing the elements in the specified array.
FloatBag(int capacity)	Creates an ordered bag with the specified capacity.
FloatBag(FloatList list)	Creates a new bag containing the elements in the specific list or bag.
FloatBag(Ordered.OfFloat other)	Copies the given Ordered.OfFloat into a new bag.
FloatBag(Ordered.OfFloat other, int offset, int count)	Creates a new bag by copying count items from the given Ordered, starting at offset in that Ordered, into this.
FloatBag(PrimitiveCollection.OfFloat coll)	Creates a new bag containing the items in the specified PrimitiveCollection.OfFloat.
FloatBag(FloatIterator coll)	Creates a new instance containing the items in the specified iterator.

Method Summary

Modifier and Type	Method	Description
int	hashCode()
void	insert(int index, float element)	This always adds element to the end of this bag's ordering.
boolean	keepsOrder()	Returns true if this implementation retains order, which it does not.
static FloatBag	parse(String str, String delimiter)	Calls parse(String, String, boolean) with brackets set to false.
static FloatBag	parse(String str, String delimiter, boolean brackets)	Creates a new collection and fills it by calling PrimitiveCollection.OfFloat.addLegible(String, String, int, int) on either all of str (if brackets is false) or str without its first and last chars (if brackets is true).
static FloatBag	parse(String str, String delimiter, int offset, int length)	Creates a new collection and fills it by calling PrimitiveCollection.OfFloat.addLegible(String, String, int, int) with the given four parameters as-is.
float	removeAt(int index)	Removes and returns the item at the specified index.
void	removeRange(int start, int end)	Removes the items between the specified start index, inclusive, and end index, exclusive.
static FloatBag	with()	Constructs an empty bag.
static FloatBag	with(float item)	Creates a new FloatBag that holds only the given item, but can be resized.
static FloatBag	with(float... varargs)	Creates a new FloatBag that holds only the given items, but can be resized.
static FloatBag	with(float item0, float item1)	Creates a new FloatBag that holds only the given items, but can be resized.
static FloatBag	with(float item0, float item1, float item2)	Creates a new FloatBag that holds only the given items, but can be resized.
static FloatBag	with(float item0, float item1, float item2, float item3)	Creates a new FloatBag that holds only the given items, but can be resized.
static FloatBag	with(float item0, float item1, float item2, float item3, float item4)	Creates a new FloatBag that holds only the given items, but can be resized.
static FloatBag	with(float item0, float item1, float item2, float item3, float item4, float item5)	Creates a new FloatBag that holds only the given items, but can be resized.
static FloatBag	with(float item0, float item1, float item2, float item3, float item4, float item5, float item6)	Creates a new FloatBag that holds only the given items, but can be resized.
static FloatBag	with(float item0, float item1, float item2, float item3, float item4, float item5, float item6, float item7)	Creates a new FloatBag that holds only the given items, but can be resized.

Methods inherited from class com.github.tommyettinger.ds.FloatList

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll, clear, contains, containsAll, div, div, duplicateRange, ensureCapacity, equals, equals, first, get, indexOf, isEmpty, iterator, lastIndexOf, minus, minus, notEmpty, order, peek, plus, plus, pop, random, rem, rem, remove, removeAll, removeEach, replaceAll, replaceAll, replaceAll, replaceAllNaN, replaceFirst, replaceFirst, replaceFirstNaN, resize, retainAll, reverse, set, setSize, shrink, shuffle, size, sort, sort, sort, sort, swap, times, times, toArray, toArray, toString, trimToSize, truncate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.tommyettinger.ds.Arrangeable

rearrange, shuffle

Methods inherited from interface com.github.tommyettinger.ds.Ordered.OfFloat

getOrderType, random, selectRanked, selectRankedIndex

Methods inherited from interface com.github.tommyettinger.ds.PrimitiveCollection.OfFloat

addAll, addAll, addDense, addDense, addLegible, addLegible, addVarargs, appendTo, appendTo, containsAll, containsAll, containsAll, containsAll, containsAny, containsAny, containsAny, containsAny, denseAppendTo, forEach, removeAll, removeAll, removeAll, removeEach, removeEach, removeEach, removeIf, retainAll, retainAll, toDenseString, toDenseString, toString, toString, toString

Constructor Details

FloatBag

public FloatBag()

Creates an ordered bag with a capacity of 10.

FloatBag

public FloatBag(int capacity)

Creates an ordered bag with the specified capacity.

Parameters:

capacity -

FloatBag

public FloatBag(FloatList list)

Creates a new bag containing the elements in the specific list or bag. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.

Parameters:

list - another FloatList or FloatBag

FloatBag

public FloatBag(float[] array)

Creates a new bag containing the elements in the specified array. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.

Parameters:

array - a non-null float array to add to this bag

FloatBag

public FloatBag(float[] array,
 int startIndex,
 int count)

Creates a new bag containing the elements in the specified array. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.

Parameters:

array - a non-null float array to add to this bag

startIndex - the first index in array to use

count - how many items to use from array

FloatBag

public FloatBag(PrimitiveCollection.OfFloat coll)

Creates a new bag containing the items in the specified PrimitiveCollection.OfFloat.

Parameters:

coll - a primitive collection that will have its contents added to this

FloatBag

public FloatBag(FloatIterator coll)

Creates a new instance containing the items in the specified iterator.

Parameters:

coll - an iterator that will have its remaining contents added to this

FloatBag

public FloatBag(Ordered.OfFloat other)

Copies the given Ordered.OfFloat into a new bag.

Parameters:

other - another Ordered.OfFloat

FloatBag

public FloatBag(Ordered.OfFloat other,
 int offset,
 int count)

Creates a new bag by copying count items from the given Ordered, starting at offset in that Ordered, into this.

Parameters:

other - another Ordered.OfFloat

offset - the first index in other's ordering to draw an item from

count - how many items to copy from other

Method Details

keepsOrder

public boolean keepsOrder()

Returns true if this implementation retains order, which it does not.

Overrides:

keepsOrder in class FloatList

Returns:

false

insert

public void insert(int index,
 float element)

This always adds element to the end of this bag's ordering.

Overrides:

insert in class FloatList

Parameters:

index - ignored

element - element to be inserted

removeAt

public float removeAt(int index)

Removes and returns the item at the specified index. Note that this is equivalent to List.remove(int), but can't have that name because we also have FloatList.remove(float) that removes a value, rather than an index.

Overrides:

removeAt in class FloatList

Parameters:

index - the index of the item to remove and return

Returns:

the removed item

removeRange

public void removeRange(int start,
 int end)

Removes the items between the specified start index, inclusive, and end index, exclusive. Note that this takes different arguments than some other range-related methods; this needs a start index and an end index, rather than a count of items. This matches the behavior in the JDK collections.

Specified by:

removeRange in interface Ordered.OfFloat

Overrides:

removeRange in class FloatList

Parameters:

start - the first index to remove, inclusive

end - the last index (after what should be removed), exclusive

hashCode

public int hashCode()

Specified by:

hashCode in interface PrimitiveCollection<Float>

Overrides:

hashCode in class FloatList

with

public static FloatBag with()

Constructs an empty bag. This is usually less useful than just using the constructor, but can be handy in some code-generation scenarios when you don't know how many arguments you will have.

Returns:

a new bag containing nothing

with

public static FloatBag with(float item)

Creates a new FloatBag that holds only the given item, but can be resized.

Parameters:

item - a float item

Returns:

a new FloatBag that holds the given item

with

public static FloatBag with(float item0,
 float item1)

Creates a new FloatBag that holds only the given items, but can be resized.

Parameters:

item0 - a float item

item1 - a float item

Returns:

a new FloatBag that holds the given items

with

public static FloatBag with(float item0,
 float item1,
 float item2)

Creates a new FloatBag that holds only the given items, but can be resized.

Parameters:

item0 - a float item

item1 - a float item

item2 - a float item

Returns:

a new FloatBag that holds the given items

with

public static FloatBag with(float item0,
 float item1,
 float item2,
 float item3)

Creates a new FloatBag that holds only the given items, but can be resized.

Parameters:

item0 - a float item

item1 - a float item

item2 - a float item

item3 - a float item

Returns:

a new FloatBag that holds the given items

with

public static FloatBag with(float item0,
 float item1,
 float item2,
 float item3,
 float item4)

Creates a new FloatBag that holds only the given items, but can be resized.

Parameters:

item0 - a float item

item1 - a float item

item2 - a float item

item3 - a float item

item4 - a float item

Returns:

a new FloatBag that holds the given items

with

public static FloatBag with(float item0,
 float item1,
 float item2,
 float item3,
 float item4,
 float item5)

Creates a new FloatBag that holds only the given items, but can be resized.

Parameters:

item0 - a float item

item1 - a float item

item2 - a float item

item3 - a float item

item4 - a float item

item5 - a float item

Returns:

a new FloatBag that holds the given items

with

public static FloatBag with(float item0,
 float item1,
 float item2,
 float item3,
 float item4,
 float item5,
 float item6)

Creates a new FloatBag that holds only the given items, but can be resized.

Parameters:

item0 - a float item

item1 - a float item

item2 - a float item

item3 - a float item

item4 - a float item

item5 - a float item

item6 - a float item

Returns:

a new FloatBag that holds the given items

with

public static FloatBag with(float item0,
 float item1,
 float item2,
 float item3,
 float item4,
 float item5,
 float item6,
 float item7)

Creates a new FloatBag that holds only the given items, but can be resized.

Parameters:

item0 - a float item

item1 - a float item

item2 - a float item

item3 - a float item

item4 - a float item

item5 - a float item

item6 - a float item

Returns:

a new FloatBag that holds the given items

with

public static FloatBag with(float... varargs)

Creates a new FloatBag that holds only the given items, but can be resized. This overload will only be used when an array is supplied and the type of the items requested is the component type of the array, or if varargs are used and there are 9 or more arguments.

Parameters:

varargs - a float varargs or float array; remember that varargs allocate

Returns:

a new FloatBag that holds the given items

parse

public static FloatBag parse(String str,
 String delimiter)

Calls parse(String, String, boolean) with brackets set to false.

Parameters:

str - a String that will be parsed in full

delimiter - the delimiter between items in str

Returns:

a new collection parsed from str

parse

public static FloatBag parse(String str,
 String delimiter,
 boolean brackets)

Creates a new collection and fills it by calling PrimitiveCollection.OfFloat.addLegible(String, String, int, int) on either all of str (if brackets is false) or str without its first and last chars (if brackets is true). Each item is expected to be separated by delimiter.

Parameters:

str - a String that will be parsed in full (depending on brackets)

delimiter - the delimiter between items in str

brackets - if true, the first and last chars in str will be ignored

Returns:

a new collection parsed from str

parse

public static FloatBag parse(String str,
 String delimiter,
 int offset,
 int length)

Creates a new collection and fills it by calling PrimitiveCollection.OfFloat.addLegible(String, String, int, int) with the given four parameters as-is.

Parameters:

str - a String that will have the given section parsed

delimiter - the delimiter between items in str

offset - the first position to parse in str, inclusive

length - how many chars to parse, starting from offset

Returns:

a new collection parsed from str