Name

SPVM::StringList - Dynamic string array

Usage

  use StringList;
  
  # Create a string list
  my $list = StringList->new;
  my $list = StringList->new(["abc", "def", "ghi"]);
  
  # Create a string list
  my $list = StringList->new_len(10);

  # Get list length
  my $length = $list->length;
  
  # Push string value
  $list->push("abc");

  # Pop string value.
  my $element = $list->pop;

  # Unshift string value.
  $list->unshift("abc");
  
  # Shift string value.
  my $element = $list->shift;
  
  # Set string value.
  $list->set(2, "abc");

  # Get string value.
  my $element = $list->get(2);

  # Insert string value
  $list->insert(1, "abc");

  # Remove string value
  my $element = $list->remove(1);

  # Convert StringList to string array.
  my $array = $list->to_array;

Description

StringList is a dynamic string 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 string[];

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

  my $elements = $list->values;
  $valeus->[0] = "d";

Class Methods

new

  static method new : StringList ($array = undef : string[], $capacity = -1 : int);

Create a new StringList 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 string array are copied to the values of the the created array.

Examples:

  my $list = StringList->new;
  my $list = StringList->new(["abc", "def", "ghi"]);

new_len

  static method new_len : StringList ($length : int, $capacity = -1 : int);

Creates a new StringList 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.

Exceptions:

The $length must be greater than or equal to 0.

Instance Methods

get

  method get : string ($index : int);

Gets the element of the position of the $index.

Exceptions:

The $index must be greater than or equal to 0.

The $index must be less than the length of the $list.

insert

  method insert : void ($index : int, $element : string);

Inserts an $element to the position of the $index.

Exceptions:

The $index must be greater than or equal to 0.

The $index must be less than or equal to the length of the $list.

pop

  method pop : string ();

Removes the last element and return it.

Exceptions:

The length of the $list must be greater than 0.

push

  method push : void ($element : string);

Adds an $element after the end of the list.

remove

  method remove : string ($index : int);

Removes the element at the position of the $index and return it.

Exceptions:

The $index must be greater than or equal to 0.

The $index must be less than the length of the $list.

replace

  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.

Exceptions:

The $offset must be greater than or equal to 0.

The $remove_length must be greater than or equal to 0.

The $offset + the $removing lenght must be less than or equal to the length of the $list.

reserve

  method reserve : void ($new_capacity : int);

Reserves 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.

Exceptions:

The $new_capacity must be greater than or equal to 0.

resize

  method resize : void ($new_length : int);

Resizes the list with the $new_length.

Exceptions:

The $new_length must be greater than or equal to 0.

set

  method set : void ($index : int, $element : string);

Sets the $element at the position of the $index.

Exceptions:

The $index must be greater than or equal to 0.

The $index must be less than the length of the $list.

set_array

  method set_array : void ($array : string[]);

Sets an $array. Each element of the $array is copied to the element of the list.

Exceptions:

The $array must be defined.

The length of the $array must be the $same as the length of the $list.

shift

  method shift : string ();

Removes the first element and return it.

Exceptions:

The length of the $list must be greater than 0.

to_array

  method to_array : string[] ();

Converts the list to an array.

unshift

  method unshift : void ($element : string);

Inserts an $element at the beginning of the list.

cpanm SPVM

perl -MCPAN -e shell
install SPVM