SPVM::ShortList(3)

🎀 NAME 🎀

SPVM::ShortList — Dynamic short Arrays

💖 DESCRIPTION 💖

Okay so the ShortList class in SPVM has methods to manipulate dynamic short arrays. That’s literally the whole assignment, and it ate. 💅

✨ USAGE ✨

Here’s the group-chat cheat sheet, bestie:

  use ShortList;

  # Create a short list
  my $list = ShortList->new;
  my $list = ShortList->new([(short)1, 2, 3]);

  # Create a short list with array length
  my $list = ShortList->new_len(10);

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

  # Push value
  $list->push(3);

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

  # Unshift value.
  $list->unshift(3);

  # Shift value.
  my $element = $list->shift;

  # Set value.
  $list->set(2, 3);

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

  # Insert value
  $list->insert(1, 3);

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

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

🦋 DETAILS 🦋

🧚 INTERNAL DATA STRUCTURE 🧚

The array stored in a ShortList object always starts at index 0. No cap. 🫶

The elements in the range that is greater than or equal to length field and less than capacity field are filled with 0.

🌈 INTERFACES 🌈

This one implements:

• Cloneable
• Countable

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

array

has array : short[];

The internal array stored in the ShortList object.

🔥 CLASS METHODS 🔥

new

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

Creates a new ShortList 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 elements of the array are copied to the elements of the created array.

Examples:

  my $list = ShortList->new;
  my $list = ShortList->new([(short)1, 2, 3]);

new_len

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

Creates a new ShortList object with $length and $capacity.

If $capacity is less than 0, the capacity is set to the default value.

If $length is greater than $capacity, $capacity is set to $length.

Exceptions:

• $length must be greater than or equal to 0. Otherwise an exception is thrown.

new_ref

static method new_ref : ShortList ($array : short[]);

Creates a new ShortList object, sets the array field to the array $array, and returns the new object.

Exceptions:

• The array $array must be defined. Otherwise an exception is thrown.

👑 INSTANCE METHODS 👑

get

method get : int ($index : int);

Gets the element at position $index.

If $index is negative, $index is set to length plus $index.

Exceptions:

• $index must be greater than or equal to 0. Otherwise an exception is thrown.
• $index must be less than the length of $list. Otherwise an exception is thrown.

insert

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

Inserts an $element at position $index.

Exceptions:

• $index must be greater than or equal to 0. Otherwise an exception is thrown.
• $index must be less than or equal to the length of $list. Otherwise an exception is thrown.

pop

method pop : int ();

Removes the last element and returns it.

Exceptions:

• The length of $list must be greater than 0. Otherwise an exception is thrown.

push

method push : void ($element : int);

Adds an $element after the end of the list.

remove

method remove : int ($index : int);

Removes the element at position $index and returns it.

Exceptions:

• $index must be greater than or equal to 0. Otherwise an exception is thrown.
• $index must be less than the length of $list. Otherwise an exception is thrown.

replace

method replace : void ($offset : int, $remove_length : int, $replace : short[] = undef);

Same as splice method, but the return value is not returned.

Exceptions:

• Exceptions thrown by splice method could be thrown.

splice

method splice : short[] ($offset : int, $remove_length : int, $replace : short[] = undef);

Replaces the elements of the range specified by $offset and $length with the $replace array, and returns removed elements creating a new array.

If $replace is not defined, the replacement is not performed.

Exceptions:

• $offset must be greater than or equal to 0. Otherwise an exception is thrown.
• $remove_length must be greater than or equal to 0. Otherwise an exception is thrown.
• $offset + the removing length must be less than or equal to the length of $list. Otherwise an exception is thrown.

reserve

method reserve : void ($new_capacity : int);

Reserves the elements with $new_capacity.

If $new_capacity is greater than the capacity of the list, the capacity of the list is extended to $new_capacity.

Exceptions:

• $new_capacity must be greater than or equal to 0. Otherwise an exception is thrown.

resize

method resize : void ($new_length : int);

Resize the list with $new_length.

Exceptions:

• $new_length must be greater than or equal to 0. Otherwise an exception is thrown.

set

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

Sets $element at position $index.

If $index is negative, $index is set to length plus $index.

Exceptions:

• $index must be greater than or equal to 0. Otherwise an exception is thrown.
• $index must be less than the length of $list. Otherwise an exception is thrown.

shift

method shift : int ();

Removes the first element and returns it.

Exceptions:

• The length of $list must be greater than 0. Otherwise an exception is thrown.

to_array

method to_array : short[] ();

Creates a new array with the length of the list and copies all elements of the list into the new array, and returns it.

get_array

method get_array : short[] ();

Returns the internal array.

unshift

method unshift : void ($element : int);

Inserts an $element at the beginning of the list.

clone

method clone : ShortList ();

Clones this instance and returns it.

push_

method push_ : void ($elements : short[]);

Adds the elements $elements after the end of this list.

This method calls push method internally.

Exceptions:

• The elements $elements must be defined.
• Exceptions thrown by push method could be thrown.

unshift_

method unshift_ : void ($elements : short[]);

Inserts the elements $elements at the beginning of the list.

Exceptions:

• The elements $elements must be defined.
• Exceptions thrown by unshift method could be thrown.

🍓 COPYRIGHT & LICENSE 🍓

Copyright (c) 2023 Yuki Kimoto

MIT License

---

okay that’s the whole SPVM::ShortList(3) manual, bestie 🫶 source/version: perl v5.42.2; date: 2026-02-03. go slay those short arrays 💅✨