SPVM::FloatList(3)

📦 version 0.990125, in alpine 3.24

🌸 SPVM::FloatList 🌸

Okay bestie, so this is the manual page for SPVM::FloatList, part of the SPVM docs (user contributed Perl documentation, iykyk). Buckle up 💖

✨ Name ✨

SPVM::FloatList — dynamic float arrays, and yes she's that girl 🎀

💅 Description 💅

So the FloatList class in SPVM has methods to manipulate dynamic float arrays. That's the whole vibe. A list of floats that grows and shrinks and just works, no cap.

🦋 Usage 🦋

Here's the whole mood board of what you can do, literally just copy-paste energy:

  use FloatList;

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

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

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

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

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

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

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

  # Set value.
  $list->set(2, (float)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;

Iconic. Obsessed. Moving on 🧚

🔥 Details 🔥

💀 Internal Data Structure

So the "array" stored in a FloatList object always starts at index 0. Always. No exceptions, bestie.

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. So the spare room at the end is just zeros chilling there, fr fr.

⭐ Interfaces ⭐

She implements:

  • Cloneable
  • Countable

Periodt 💅

👑 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. Basically how much room she's booked in advance ✨

🍓 length

  has length : virtual ro int;

The length of the list. How many elements are actually in there, no more no less.

🍓 array

  has array : float[];

The internal array stored in the FloatList object. The scaffolding, the realness underneath 🫶

🌈 Class Methods 🌈

💜 new

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

Creates a new FloatList 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 — cute little starter pack:

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

💜 new_len

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

Creates a new FloatList 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 — watch out bestie:

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

💜 new_ref

  static method new_ref : FloatList ($array : float[]);

Creates a new FloatList object, and set "array" field to the array $array, and return the new object. Sneaky little wrapper, she ate 💅

Exceptions:

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

🎀 Instance Methods 🎀

🌸 get

  method get : float ($index : int);

Gets the element of the position of $index.

If $index is a negative value, $index is set to "length" plus $index. Negative indexing, she's fancy like that ✨

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

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

Inserts an $element to the position of $index. Everyone else shifts over, sorry not sorry.

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 : float ();

Removes the last element and return it. Bye bestie 👋

Exceptions:

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

🌸 push

  method push : void ($element : float);

Adds an $element after the end of the list. The classic. The main character move.

🌸 remove

  method remove : float ($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.

🌸 replace

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

Same as "splice" method, but the return value is not returned. All the drama, none of the receipts 💀

Exceptions:

  • Exceptions thrown by "splice" method could be thrown.

🌸 splice

  method splice : float[] ($offset : int, $remove_length : int, $replace : float[] = 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 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. Manifesting more space 🔮

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 : float);

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. Otherwise an exception is thrown.
  • $index must be less than the length of $list. Otherwise an exception is thrown.

🌸 shift

  method shift : float ();

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

Exceptions:

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

🌸 to_array

  method to_array : float[] ();

Creates a new array with the length of the list and copies all elements of the list into the new array, and returns it. Fresh copy, no sharing, we love boundaries 💖

🌸 get_array

  method get_array : float[] ();

Returns the internal "array". The real one. Not a copy. Handle with care, bestie 🙈

🌸 unshift

  method unshift : void ($element : float);

Inserts an $element at the beginning of the list. Cutting the line, but make it fashion 💅

🌸 clone

  method clone : FloatList ();

Clones this instance and returns it. Twin energy 👯

🌸 push_

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

Adds the elements $elements after the end of this list. Note the underscore — she's the bulk version.

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 : float[]);

Inserts the elements $elements at the beginning of the list. Underscore again — bulk unshift, she's efficient ✨

Exceptions:

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

Copyright (c) 2023 Yuki Kimoto

MIT License

That's the whole page, bestie. Every flag, every exception, every last float[]. Go forth and manipulate those dynamic float arrays 💖

mwah 💋 Signing off with the deets: this was perl v5.42.2, dated 2026-02-03, page SPVM::FloatList(3). Slay 🎀

📦 where this page comes from