SPVM::IntList(3)

💖 NAME 💖

SPVM::IntList — Dynamic int Arrays. Bestie, this is the User Contributed Perl Documentation page for it, and it's genuinely giving dynamic int array main character energy. 💅

✨ DESCRIPTION ✨

The IntList class in SPVM has methods to manipulate dynamic int arrays. That's the whole vibe: a list that grows, shifts, and does the little array dance, no cap. 🦋

🎀 USAGE 🎀

Okay so here's the group-chat demo, literally exactly:

use IntList;

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

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

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

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

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

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

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

# Set value.
$list->set(2, (int)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 an IntList object always starts at index 0. Iconic, stable, zero-drama.

The elements in the range that is greater than or equal to the length field and less than the capacity field are filled with 0. iykyk, that's the padding zone.

🔌 INTERFACES 🔌

The interfaces are:

• Cloneable
• Countable

🗃️ FIELDS 🗃️

💅 capacity

has capacity : virtual ro int;

The capacity. This is the length of the internally reserved elements to extend the length of the list. Reserved-element runway, basically.

💅 length

has length : virtual ro int;

The length of the list. Short and iconic.

💅 array

has array : int[];

The internal array stored in the IntList object. Main character storage.

👑 CLASS METHODS 👑

🆕 new

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

Create a new IntList 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 = IntList->new;
my $list = IntList->new([(int)1, 2, 3]);

🆕 new_len

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

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

🆕 new_ref

static method new_ref : IntList ($array : int[]);

Creates a new IntList 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 the position of $index.

If $index is a negative value, $index is set to length plus $index. Negative-index girlies, that's the rule.

Exceptions:

• $index must be greater than or equal to 0.
• $index must be less than the length of $list.

🍓 insert

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

Inserts an $element at the position of $index.

Exceptions:

• $index must be greater than or equal to 0.
• $index must be less than or equal to the length of $list.

🍓 pop

method pop : int ();

Removes the last element and returns it. Bye bestie, you're out.

Exceptions:

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

🍓 push

method push : void ($element : int);

Adds an $element after the end of the list. Tail-end placement, slay.

🍓 remove

method remove : int ($index : int);

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

Exceptions:

• $index must be greater than or equal to 0.
• $index must be less than the length of $list.

🍓 replace

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

Same as the splice method, but the return value is not returned. It's giving splice's quieter sibling.

Exceptions:

• Exceptions thrown by the splice method could be thrown.

🍓 splice

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

Replaces the elements of the range specified by $offset and $length with the $replace array, and returns the removed elements as 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 + $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. Capacity glow-up moment.

Exceptions:

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

🍓 resize

method resize : void ($new_length : int);

Resizes the list with $new_length. New length, new vibe check.

Exceptions:

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

🍓 set

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

Sets $element at the position of $index.

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

Exceptions:

• $index must be greater than or equal to 0.
• $index must be less than the length of $list.

🍓 shift

method shift : int ();

Removes the first element and returns it. Front of the line, you're up.

Exceptions:

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

🍓 to_array

method to_array : int[] ();

Creates a new array with the length of the list, copies all elements of the list into the new array, and returns it. Array-ified and ready to go.

🍓 get_array

method get_array : int[] ();

Returns the internal array. Direct access, iykyk.

🍓 unshift

method unshift : void ($element : int);

Inserts an $element at the beginning of the list. Front-row seat, literally.

🍓 clone

method clone : IntList ();

Clones this instance and returns it. Clone moment, iconic.

🫶 push_

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

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

This method calls the push method internally.

Exceptions:

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

🫶 unshift_

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

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

Exceptions:

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

📜 COPYRIGHT & LICENSE 📜

Copyright (c) 2023 Yuki Kimoto

MIT License

Okay bestie, that's the page. Signing off with perl v5.42.2 energy on 2026-02-03 — SPVM::IntList(3), periodt. 💅✨