SPVM::DoubleList(3)

πŸ“¦ version 0.990125, in alpine 3.24

πŸ’… Name: SPVM::DoubleList β€” Dynamic double Arrays πŸ’…

SPVM::DoubleList(3) β€” User Contributed Perl Documentation, bestie. πŸ’…

🌸 Description 🌸

The DoubleList class in SPVM has methods to manipulate dynamic double arrays. That's the whole vibe. Periodt. ✨

πŸŽ€ Usage πŸŽ€

  use DoubleList;

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

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

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

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

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

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

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

  # Set value.
  $list->set(2, (double)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 DoubleList object always starts at index 0.

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

🌈 Interfaces 🌈

  • Cloneable
  • Countable

πŸ‘‘ Fields πŸ‘‘

capacity

  • capacity β€” signature: C<has capacity : virtual ro int;> (yes, that's literally what the page shows πŸ’€). It's the capacity: the length of the internally reserved elements used to extend the length of the list.

length

  • length β€” signature: "has length : virtual ro int;". It's the length of the list.

array

  • array β€” signature: "has array : double[];". It's the internal array stored in the DoubleList object.

πŸ’– Class Methods πŸ’–

✨ new ✨

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

Creates a new DoubleList 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 the created array. (keeping the the the, bestie 😭)

Examples:

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

✨ new_len ✨

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

Creates a new DoubleList 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 ✨

Signature: static method new_ref : DoubleList ($array : double[]);

Creates a new DoubleList object, and set array field to the array $array, and return the new object.

Exceptions:

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

🌸 Instance Methods 🌸

get

Signature: method get : double ($index : int);

Gets the element of the position of $index.

If $index is a netative value, $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.

insert

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

Inserts an $element to the position of $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.

pop

Signature: method pop : double ();

Removes the last element and return it.

Exceptions:

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

push

Signature: method push : void ($element : double);

Adds an $element after the end of the list.

remove

Signature: method remove : double ($index : int);

Removes the element at the position of $index and return 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

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

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

Exceptions:

  • Exceptions thrown by splice method could be thrown.

splice

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

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

If $replace is not defined, the replacemnet 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

Signature: 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

Signature: 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

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

Sets $element at the position of $index.

If $index is a netative value, $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

Signature: method shift : double ();

Removes the first element and return it.

Exceptions:

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

to_array

Signature: method to_array : double[] ();

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

Signature: method get_array : double[] ();

Returns the internal "array".

unshift

Signature: method unshift : void ($element : double);

Inserts an $element at the beginning of the list.

clone

Signature: method clone : DoubleList ();

Clones this instance and returns it.

push_

Signature: method push_ : void ($elements : double[]);

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_

Signature: method unshift_ : void ($elements : double[]);

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

Exceptions:

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

Copyright (c) 2023 Yuki Kimoto

MIT License

🫢 and that's the whole page, bestie! source/version: perl v5.42.2; date: 2026-02-03; manual: SPVM::DoubleList(3). slay! πŸ’–
πŸ“¦ where this page comes from