Name

SPVM::Immutable::DoubleList - Immutable double Array

Description

The Immutable::DoubleList class has methods to manipulate an immutable double array.

Usage

  use Immutable::DoubleList;
  
  # Create a double list
  my $list = Immutable::DoubleList->new;
  my $list = Immutable::DoubleList->new([(double)1, 2, 3]);
  
  # Create a double list with array length
  my $list = Immutable::DoubleList->new_len(10);
  
  # Get list length
  my $length = $list->length;
  
  # Get value.
  my $element = $list->get(2);
  
  # Convert list to array.
  my $array = $list->to_array;
  

Fields

length

  has length : ro int;

Gets the length field.

This field is the length of the elements of the list.

Class Methods

new

  static method new : Immutable::DoubleList ($array = undef : double[]);

Create a new Immutable::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 values of the the created array.

Examples:

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

new_len

  static method new_len : Immutable::DoubleList ($length : int);

Creates a new Immutable::DoubleList object with the $length and the $capacity.

Exceptions:

The $length must be greater than or equal to 0. Otherwize an exception is thrown.

Instance Methods

get

  method get : double ($index : int);

Gets the element of the position of the $index.

Exceptions:

The $index must be greater than or equal to 0. Otherwize an exception is thrown.

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

to_array

  method to_array : double[] ();

Converts the list to an array.

Copyright & License

Copyright (c) 2023 Yuki Kimoto

MIT License

cpanm SPVM

perl -MCPAN -e shell
install SPVM