++ed by:
FAYLAND ILUX KES BEROV MHOWARD
7 non-PAUSE users
Author image Yuki Kimoto

NAME

SPVM::List - 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 dynamic object array.

STATIC METHODS

new

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

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

Internally, new array is created, and each element of argument array is copied to internal array.

If array is undef, 0-length internal array is created.

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

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.

length

  sub length : int ()

Get list length.

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.

push

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

Appending the value to the end of list.

remove

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

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

resize

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

Resize this list. If the new length is shorter than the current length, the list is truncated to the new length. If the new length is shorter than the current length, the list is truncated to the new length. If the new length is same as the current length, there is nothing to do. If the new length is longer than the current length, the list grows to the new length, and the values of the added elements are set to undef.

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

set

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

Set the value with index.

set_array

  sub set_array : void ($self : self, $array : oarray)

Set a array. Each elements of the array is copied to the correspoinding index of the array this list has. Note that this copy is address copy.

Array must be defined, otherwise a exception occurs.

The length of argument array must be same as the length of current list array, otherwise a exception occures.

to_array

  sub to_array : oarray ($self : self)

Convert SPVM::List to object array.

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.

unshift

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

Appending the value to the top of list.