/ 
SPVM-0.0940
River stage two • 37 direct dependents • 40 total dependents
/ SPVM::List

NAME

SPVM::List - Continuous dynamic object array

SYNOPSYS

use SPVM::List;

# Create a object list
my $object_list = SPVM::List->new([(object)SPVM::Byte->new(1), SPVM::Int->new(2), SPVM::Long->new(3)]);

# Create a SPVM::Int list
my $object_list = SPVM::List->new([SPVM::Byte->new(1), SPVM::Int->new(2), SPVM::Int->new(3)]);

# Create a object list with length
my $object_list = SPVM::List->new_len([], 3);

# Create a SPVM::Int list with length
my $object_list = SPVM::List->new_len(new SPVM::Int[0], 3);

# Get list length
my $length = $object_list->length;

# Push object value
$object_list->push(SPVM::Int->new(3));

# Pop object value.
my $object_value = $object_list->pop;

# Unshift object value.
$object_list->unshift(SPVM::Int->new(3));

# Shift object value.
my $object_value = $object_list->shift;

# Set object value.
$object_list->set(2, SPVM::Int->new(3));

# Get object value.
my $object_value = $object_list->get(2);

# Insert object value
$object_list->insert(1, SPVM::Int->new(3));

# Remove object value
my $object_value = $object_list->remove(1);

# Convert SPVM::List to object array.
my $int_array = $object_list->to_array;

# Convert SPVM::List to SPVM::Int array.
my $int_array = (SPVM::Int[])$object_list->to_array;

DESCRIPTION

SPVM::List is continuous dynamic object array.

STATIC METHODS

new

sub new : SPVM::List ($objects : oarray)

Create a new SPVM::List object with specific object array.

new_len

sub new_len : SPVM::List ($proto_array : oarray, $length : int)

Create a new SPVM::List object with prototype array and array length. Prototype array is used to decide the array type of internal values.

INSTANCE METHODS

length

sub length : int ()

Get list length.

push

sub push : void ($self : self, $value : object)

Appending the value to the end of list.

pop

sub pop : object ($self : self)

Pops and returns the last value of the list, shortening the array by one element If there are no elements in the list, exception occur.

unshift

sub unshift : void ($self : self, $value : object)

Appending the value to the top of list.

shift

sub shift : object ($self : self)

Shifts the first value of the list off and returns it, shortening the array by 1 and moving everything down. If there are no elements in the list, exception occur.

set

sub set : void ($self : self, $index : int, $value : object)

Set the value with index.

get

sub get : object ($self : self, $index : int)

Get the value with index.

insert

sub insert : void ($self : self, $index : int, $value : object)

Insert a element to the specific index.

remove

sub remove : object ($self : self, $index : int)

Remove and return the element which is specified by the index.

to_array

sub to_array : oarray ($self : self)

Convert SPVM::List to object array.

resize

sub resize : void ($self : self, $new_length : int)

Resize list.

New length must be more than or equals to 0, otherwise a exception occur.