# Name

SPVM::DoubleList - Dynamic double Array

# Usage

```
use DoubleList;
# Create a double list
my $list = DoubleList->new;
my $list = DoubleList->new([(double)1, 2, 3]);
# Create a double list with array length
my $list = DoubleList->new_len(10);
# Get list length
my $length = $list->length;
# Push value
$list->push((double)3);
# Pop value.
my $value = $list->pop;
# Unshift value.
$list->unshift((double)3);
# Shift value.
my $value = $list->shift;
# Set value.
$list->set(2, (double)3);
# Get value.
my $value = $list->get(2);
# Insert value
$list->insert(1, 3);
# Remove value
my $value = $list->remove(1);
# Convert list to array.
my $array = $list->to_array;
```

# Description

`DoubleList`

is a dynamic `double`

array.

# Enumerations

```
enum {
DEFAULT_CAPACITY = 4,
}
```

## DEFAULT_CAPACITY

The default capacity. The value is `4`

.

# Fields

## capacity

` has capacity : ro int;`

The capacity. This is the length of the internally reserved elements to extend the length of the list.

## length

` has length : ro int;`

The length of the list.

## values

` has values : ro double[];`

The values of the list. This is the internally used array, but it can be manipulated directly.

```
my $values = $list->values;
$valeus->[0] = 5;
```

# Class Methods

## new

` static method new : DoubleList ($array = undef : double[], $capacity = -1 : int)`

Create a new `DoubleList`

object using "new_len".

The passed length to "new_len" is the length of the array. If the array is `undef`

, the length is `0`

.

The values of the array are copied to the values of the the created array.

**Examples:**

```
my $list = DoubleList->new;
my $list = DoubleList->new([(double)1, 2, 3]);
```

## new_len

` static method new_len : DoubleList ($length : int, $capacity = -1 : int)`

Create a new `DoubleList`

object with the length and the capacity.

If the capacity is less than `0`

, the capacity is set to the value of "DEFAULT_CAPACITY".

If the length is greater than the capacity, the capacity is set to the length.

The length must be greater than or equal to `0`

. Otherwise an excpetion will be thrown.

# Instance Methods

## get

` method get : double ($index : int)`

Get the element of the position of the index.

The index must be greater than or equal to 0. Otherwise an excpetion will be thrown.

The index must be less than the length of the list. Otherwise an excpetion will be thrown.

## insert

` method insert : void ($index : int, $value : double)`

Insert an element to the position of the index.

The index must be greater than or equal to `0`

. Otherwise an excpetion will be thrown.

The index must be less than or equal to the length of the list. Otherwise an excpetion will be thrown.

## pop

` method pop : double ()`

Remove the last element and return it.

The length of the list must be greater than `0`

. Otherwise an excpetion will be thrown.

## push

` method push : void ($value : double)`

Add an element after the end of the list.

## remove

` method remove : double ($index : int)`

Remove the element at the position of the index and return it.

The index must be greater than or equal to `0`

. Otherwise an excpetion will be thrown.

The index must be less than the length of the list. Otherwise an excpetion will be thrown.

## replace

` method replace : void ($offset : int, $remove_length : int, $replace : double[])`

Replace the elements of the range specified by the offset and the lenght with the replacement array.

The offset must be greater than or equal to `0`

. Otherwise an excpetion will be thrown.

The removing length must be greater than or equal to `0`

. Otherwise an excpetion will be thrown.

The offset + the removing lenght must be less than or equal to the length of the list. Otherwise an excpetion will be thrown.

## reserve

` method reserve : void ($new_capacity : int)`

Reserve the elements with the new capacity.

If the new capacity is greater than the capacity of the list, the capacity of the list is extended to the new capacity.

Note that "values" is replaced with the new values and the values of the original list are copied to the new values in the above case.

The new capacity must be greater than or equal to `0`

. Otherwise an excpetion will be thrown.

## resize

` method resize : void ($new_length : int)`

Resize the list.

The new length must be greater than or equal to `0`

. Otherwise an excpetion will be thrown.

## set

` method set : void ($index : int, $value : double)`

Set the element at the position of the index.

The index must be greater than or equal to `0`

. Otherwise an excpetion will be thrown.

The index must be less than the length of the list. Otherwise an excpetion will be thrown.

## set_array

` method set_array : void ($array : double[])`

Set an array. Each element of the array is copied to the element of the list.

The array must be defined. Otherwise an excpetion will be thrown.

The length of the array must be the same as the length of the list. Otherwise an excpetion will be thrown.

## shift

` method shift : double ()`

Remove the first element and return it.

The length of the list must be greater than `0`

. Otherwise an excpetion will be thrown.

## to_array

` method to_array : double[] ()`

Convert the list to an array.

## unshift

` method unshift : void ($value : double)`

Insert an element at the beginning of the list.