The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

KIMOTO / SPVM-0.990047 / lib / SPVM / Immutable / ShortList.pm 

            

              
1
2
3
—
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

              
package SPVM::Immutable::ShortList;
1;
=head1 Name
SPVM::Immutable::ShortList - Immutable short Array
=head1 Description
The Immutable::ShortList class has methods to manipulate an immutable short array.
=head1 Usage
   
  use Immutable::ShortList;
   
  # Create a short list
  my $list = Immutable::ShortList->new;
  my $list = Immutable::ShortList->new([(short)1, 2, 3]);
   
  # Create a short list with array length
  my $list = Immutable::ShortList->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;
   
=head1 Fields
=head2 length
  has length : ro int;
Gets the C<length> field.
This field is the length of the elements of the list.
=head1 Class Methods
=head2 new
C<static method new : L<Immutable::ShortList|SPVM::Immutable::ShortList> ($array : short[] = undef);>
Create a new L<Immutable::ShortList|SPVM::Immutable::ShortList> object using L</"new_len">.
The passed length to L</"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.
Examples:
  my $list = Immutable::ShortList->new;
  my $list = Immutable::ShortList->new([(short)1, 2, 3]);
=head2 new_len
C<static method new_len : L<Immutable::ShortList|SPVM::Immutable::ShortList> ($length : int);>
Creates a new L<Immutable::ShortList|SPVM::Immutable::ShortList> object with $length.
Exceptions:
$length must be greater than or equal to 0. Otherwise an exception is thrown.
=head1 Instance Methods
=head2 get
C<method get : int ($index : int);>
Gets the element of the position of $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.
=head2 to_array
C<method to_array : short[] ();>
Converts the list to an array.
=head1 Copyright & License
Copyright (c) 2023 Yuki Kimoto
MIT License