Name
SPVM::List - Dynamic Object Array
Usage
use List;
# Create a object list
my $list = List->new;
my $list = List->new([(object)Byte->new(1), Int->new(2), Long->new(3)]);
# Create a Int list
my $list = List->new([Int->new(1), Int->new(2), Int->new(3)]);
# Create a object list with length
my $list = List->new_len([], 3);
# Create a Int list with length
my $list = List->new_len(new Int[0], 3);
# Get list length
my $length = $list->length;
# Push object value
$list->push(Int->new(3));
# Pop object value.
my $value = $list->pop;
# Unshift object value.
$list->unshift(Int->new(3));
# Shift object value.
my $value = $list->shift;
# Set object value.
$list->set(2, Int->new(3));
# Get object value.
my $value = $list->get(2);
# Insert object value
$list->insert(1, Int->new(3));
# Remove object value
my $value = $list->remove(1);
# Convert List to object array.
my $int_array = $list->to_array;
# Convert List to Int array.
my $int_array = (Int[])$list->to_array;Description
List is the dynamic object array that has a specified object array type.
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 object[];The values. This is the internally used array, but it can be manipulated directly.
Class Methods
new
static method new : List ($array = undef : object[], $capacity = -1 : int)Create a new List 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 element's addresses of the object array are copied to the values of the the created array.
# object[]
my $list = List->new([(object)Byte->new(1), Int->new(2), Long->new(3)]);
# Int[]
my $list = List->new([Int->new(1), Int->new(2), Int->new(3)]);new_len
static method new_len : List ($proto_array : object[], $length : int, $capacity = -1 : int)Create a new StringList object with the prototype array, the length and the capacity.
If the prototype array is undefined, the prototype array is set to an object[] object.
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.
Examples:
# Create a Int list with length
my $list = List->new_len(new Int[0], 3);Instance Methods
get
method get : object ($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 : object)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 : object ()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 : object)Add an element after the end of the list.
remove
method remove : object ($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.
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.
replace
method replace : void ($offset : int, $remove_length : int, $replace : object[])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.
set
method set : void ($index : int, $value : object)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 : object[])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 : object ()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 : object[] ()Convert the list to an array.
unshift
method unshift : void ($value : object)Insert an element at the beginning of the list.