DynamicBooleanArray (Artisynth API documentation)

java.lang.Object
- maspack.util.ModifiedVersionBase
- - maspack.util.DynamicBooleanArray

All Implemented Interfaces:

java.lang.Cloneable, Versioned
```
public class DynamicBooleanArray
extends ModifiedVersionBase
implements java.lang.Cloneable
```
Dynamic integer array (saves on memory vs ArrayList)

Author:

Antonio

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_INITIAL_CAPACITY

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_INITIAL_CAPACITY`

Constructor Summary

Constructors
Constructor and Description
`DynamicBooleanArray()` Dynamic array of integers with default capacity of 10
`DynamicBooleanArray(boolean... vals)`
`DynamicBooleanArray(DynamicBooleanArray array)`
`DynamicBooleanArray(int initialCapacity)` Dynamic array of integers with provided initial capacity

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(boolean e)`
`void`	`addAll(boolean[] e)`
`void`	`addAll(DynamicBooleanArray array)`
`void`	`chop(int start, int size)` Performs an in-place slice, modifying this array directly
`void`	`clear()`
`DynamicBooleanArray`	`clone()` Creates a shallow copy
`void`	`ensureCapacity(int cap)`
`boolean`	`equals(DynamicBooleanArray array)` Returns `true` if this DynamicBooleanArray is equals to another one.
`boolean`	`get(int idx)`
`boolean[]`	`getArray()` Provides direct access to the underlying array.
`boolean`	`remove(int idx)`
`void`	`remove(int idx, int count)` Remove a specified number of elements starting at the provided index.
`void`	`resize(int size)` Resizes the array.
`void`	`set(int idx, boolean e)` Sets the value at index `idx` to the provided `e`.
`int`	`size()`
`DynamicBooleanArray`	`slice(int start, int size)` Returns a copy of a portion of the array
`boolean[]`	`toArray()` Copies the contents of this DynamicBooleanArray into an array.
`void`	`trimToSize()`

Methods inherited from class maspack.util.ModifiedVersionBase
getVersion, notifyModified

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

- Field Detail
  - DEFAULT_INITIAL_CAPACITY
```
public static final int DEFAULT_INITIAL_CAPACITY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DynamicBooleanArray
```
public DynamicBooleanArray()
```
    Dynamic array of integers with default capacity of 10
  - DynamicBooleanArray
```
public DynamicBooleanArray(int initialCapacity)
```
    Dynamic array of integers with provided initial capacity
    
    Parameters:
    
    initialCapacity - initial capacity. If <= 0, uses the default capacity
  - DynamicBooleanArray
```
public DynamicBooleanArray(boolean... vals)
```
  - DynamicBooleanArray
```
public DynamicBooleanArray(DynamicBooleanArray array)
```
- Method Detail
  - ensureCapacity
```
public void ensureCapacity(int cap)
```
  - size
```
public int size()
```
  - add
```
public void add(boolean e)
```
  - addAll
```
public void addAll(boolean[] e)
```
  - addAll
```
public void addAll(DynamicBooleanArray array)
```
  - clear
```
public void clear()
```
  - remove
```
public boolean remove(int idx)
```
  - remove
```
public void remove(int idx,
                   int count)
```
    Remove a specified number of elements starting at the provided index.
    
    Parameters:
    
    idx - starting index to remove
    
    count - number of elements to remove
  - trimToSize
```
public void trimToSize()
```
  - resize
```
public void resize(int size)
```
    Resizes the array. If the new size is smaller than the current array size, then the trailing elements are removed from the array. If the new size is greater than the current, then the array is grown, and new elements are initialized to zero.
    
    Parameters:
    
    size - new size
  - slice
```
public DynamicBooleanArray slice(int start,
                                 int size)
```
    Returns a copy of a portion of the array
    
    Parameters:
    
    start - starting index to copy
    
    size - number of elements
    
    Returns:
    
    portion of array
  - chop
```
public void chop(int start,
                 int size)
```
    Performs an in-place slice, modifying this array directly
    
    Parameters:
    
    start - starting index to keep
    
    size - number of elements
  - get
```
public boolean get(int idx)
```
  - set
```
public void set(int idx,
                boolean e)
```
    Sets the value at index idx to the provided e. If idx==size(), then the element is appended to the array.
    
    Parameters:
    
    idx - index at which to modify the value
    
    e - new value
  - getArray
```
public boolean[] getArray()
```
    Provides direct access to the underlying array. If the array is modified, then the version numbering will be out of sync until ModifiedVersionBase.notifyModified() is called. The underying array is automatically trimmed to the correct size before being returned.
    
    Returns:
    
    the underlying array.
  - toArray
```
public boolean[] toArray()
```
    Copies the contents of this DynamicBooleanArray into an array.
    
    Returns:
    
    new array
  - clone
```
public DynamicBooleanArray clone()
```
    Creates a shallow copy
    
    Overrides:
    
    clone in class java.lang.Object
  - equals
```
public boolean equals(DynamicBooleanArray array)
```
    Returns true if this DynamicBooleanArray is equals to another one.
    
    Parameters:
    
    array - array to compare with

Class DynamicBooleanArray

Field Summary

Constructor Summary

Method Summary

Methods inherited from class maspack.util.ModifiedVersionBase

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INITIAL_CAPACITY

Constructor Detail

DynamicBooleanArray

DynamicBooleanArray

DynamicBooleanArray

DynamicBooleanArray

Method Detail

ensureCapacity

size

add

addAll

addAll

clear

remove

remove

trimToSize

resize

slice

chop

get

set

getArray

toArray

clone

equals