1;
=head1 Name
SPVM::List - Dynamic Object Array
=head1 Usage
my
$list
= List->new;
my
$list
= List->new([(object)Byte->new(1), Int->new(2), Long->new(3)]);
my
$list
= List->new([Int->new(1), Int->new(2), Int->new(3)]);
my
$list
= List->new_len([], 3);
my
$list
= List->new_len(new Int[0], 3);
my
$length
=
$list
->
length
;
$list
->
push
(Int->new(3));
my
$element
=
$list
->
pop
;
$list
->
unshift
(Int->new(3));
my
$element
=
$list
->
shift
;
$list
->set(2, Int->new(3));
my
$element
=
$list
->get(2);
$list
->insert(1, Int->new(3));
my
$element
=
$list
->remove(1);
my
$int_array
=
$list
->to_array;
my
$int_array
= (Int[])
$list
->to_array;
=head1 Description
C<List> is the dynamic object array that
has
a specified object array type.
=head1 Fields
=head2 capacity
has
capacity : ro
int
;
The capacity. This is the
length
of the internally reserved elements to extend the
length
of the list.
=head2
length
has
length
: ro
int
;
The
length
of the list.
=head1 Class Methods
=head2 new
C<static method new : L<List|SPVM::List> (
$array
: object[] =
undef
,
$capacity
:
int
= -1);>
Creates a new C<List> object using L</
"new_len"
>.
The passed
length
to L</
"new_len"
> is the
length
of
$array
. If the array is
undef
, the
length
is 0.
The element's addresses of the object array are copied to the elements of the the created array.
my
$list
= List->new([(object)Byte->new(1), Int->new(2), Long->new(3)]);
my
$list
= List->new([Int->new(1), Int->new(2), Int->new(3)]);
=head2 new_len
C<static method new_len : L<List|SPVM::List> (
$proto_array
: object[],
$length
:
int
,
$capacity
:
int
= -1);>
Creates a new C<StringList> object
with
$protot_array
,
$length
and
$capacity
.
If
$protot_array
is undefined,
$protot_array
is set to an C<object[]> object.
If
$capacity
is less than 0,
$capacity
is set to the
default
value.
If
$length
is greater than
$capacity
,
$capacity
is set to the
length
.
Exceptions:
$length
must be greater than or equal to 0. Otherwise an exception is thrown.
Examples:
my
$list
= List->new_len(new Int[0], 3);
=head1 Instance Methods
=head2 get
C<method get : object (
$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 insert
C<method insert : void (
$index
:
int
,
$element
: object);>
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
. Otherwise an exception is thrown.
=head2
pop
C<method
pop
: object ();>
Removes the
last
element and
return
it.
Exceptions:
The
length
of
$list
must be greater than 0. Otherwise an exception is thrown.
=head2
push
C<method
push
: void (
$element
: object);>
Adds an
$element
after
the end of the list.
=head2 remove
C<method remove : object (
$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.
=head2 replace
C<method replace : void (
$index
:
int
,
$remove_length
:
int
,
$replace
: string[]);>
Replaces the elements of the range specified by
$index
and
$length
with
$replace
array.
Exceptions:
$index
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.
$index
+
$removing
length
must be less than or equal to the
length
of
$list
. Otherwise an exception is thrown.
=head2 reserve
C<method reserve : void (
$new_capacity
:
int
);>
If
$new_capacity
is greater than the capacity of the list, the capacity of the list is extended to
$new_capacity
.
=head2 resize
C<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.
=head2 replace
C<method replace : void (
$offset
:
int
,
$remove_length
:
int
,
$replace
: object[]);>
Replaces the elements of the range specified by
$offset
and
$remove_length
with
the replacement array.
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.
=head2 set
C<method set : void (
$index
:
int
,
$element
: object);>
Sets
$element
at 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
shift
C<method
shift
: object ();>
Removes the first element and
return
it.
Exceptions:
The
length
of
$list
must be greater than 0. Otherwise an exception is thrown.
=head2 to_array
C<method to_array : object[] ();>
Creates a new array and copies all elements of the list into the new array, and returns it.
=head2
unshift
C<method
unshift
: void (
$element
: object);>
Inserts an
$element
at the beginning of the list.
=head1 Copyright & License
Copyright (c) 2023 Yuki Kimoto
MIT License