SPVM::List - Dynamic Object Array
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 $element = $list->pop; # Unshift object value. $list->unshift(Int->new(3)); # Shift object value. my $element = $list->shift; # Set object value. $list->set(2, Int->new(3)); # Get object value. my $element = $list->get(2); # Insert object value $list->insert(1, Int->new(3)); # Remove object value my $element = $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;
List is the dynamic object array that has a specified object array type.
List
enum { DEFAULT_CAPACITY = 4, }
The default capacity. The value is 4.
4
has capacity : ro int;
The capacity. This is the length of the internally reserved elements to extend the length of the list.
has length : ro int;
The length of the list.
has values : ro object[];
The values. This is the elements in the internally used array, but it can be manipulated directly.
static method new : List ($array = undef : object[], $capacity = -1 : int);
Creates 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.
$array
undef
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)]);
static method new_len : List ($proto_array : object[], $length : int, $capacity = -1 : int);
Creates a new StringList object with the $protot_array, the $length and the $capacity.
StringList
$protot_array
$length
$capacity
If the $protot_array is undefined, the $protot_array is set to an object[] 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.
Exceptions:
The $length must be greater than or equal to 0.
Examples:
# Create a Int list with length my $list = List->new_len(new Int[0], 3);
method get : object ($index : int);
Gets the element of the position of the $index.
$index
The $index must be greater than or equal to 0.
The $index must be less than the length of the $list.
$list
method insert : void ($index : int, $element : object);
Inserts an $element to the position of the $index.
$element
The $index must be less than or equal to the length of the $list.
method pop : object ();
Removes the last element and return it.
The length of the $list must be greater than 0.
method push : void ($element : object);
Adds an $element after the end of the list.
method remove : object ($index : int);
Removes the element at the position of the $index and return it.
method replace : void ($offset : int, $remove_length : int, $replace : string[]);
Replaces the elements of the range specified by the $offset and the $lenght with the $replace array.
$offset
$lenght
$replace
The $offset must be greater than or equal to 0.
The $remove_length must be greater than or equal to 0.
$remove_length
The $offset + the $removing lenght must be less than or equal to the length of the $list.
$removing
method reserve : void ($new_capacity : int);
Reserves the elements with the $new_capacity.
$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.
method resize : void ($new_length : int);
Resize the list with the $new_length.
$new_length
The $new_length must be greater than or equal to 0.
method replace : void ($offset : int, $remove_length : int, $replace : object[]);
Replaces the elements of the range specified by the $offset and the $remove_length with the replacement array.
method set : void ($index : int, $element : object);
Sets the $element at the position of the $index.
method set_array : void ($array : object[]);
Sets an $array. Each element of the $array is copied to the element of the list.
The $array must be defined.
The length of the $array must be the $same as the length of the $list.
$same
method shift : object ();
Removes the first element and return it.
method to_array : object[] ();
Converts the list to an array.
method unshift : void ($element : object);
Inserts an $element at the beginning of the list.
To install SPVM, copy and paste the appropriate command in to your terminal.
cpanm
cpanm SPVM
CPAN shell
perl -MCPAN -e shell install SPVM
For more information on module installation, please visit the detailed CPAN module installation guide.