Perl splice Function

Perl splice Function

NEW!!!

Check my new resource: Perl How To Tutorial eBooks

The Perl splice function is for arrays and is used to remove, replace or add elements. It has four syntax forms:

splice ARRAY, OFFSET, LENGTH, LIST
splice ARRAY, OFFSET, LENGTH
splice ARRAY, OFFSET
splice ARRAY

where:

ARRAY is the array to manipulate
OFFSET is the starting array element to be removed
LENGTH is the number of elements to be removed
LIST is an ordered list of elements to replace the removed elements with

The Perl splice function returns:

in scalar context, the last element removed or undef if no elements are removed
in list context, the list of elements removed from the array

The array grows or shrinks as necessary. The OFFSET could be negative and then it starts that far from the end of the array. The LENGTH could be negative too and in this case the Perl splice function will remove the elements from OFFSET onward except for –LENGTH elements at the end of the array.

In this short tutorial, we’ll shortly review every syntax form of this function and you’ll find a few snippets about how to use it in your scripts.

Check my new How To Tutorial eBooks (PDF format):
"Perl Statements - How To Tutorial"
"Perl Scalar and String Functions - How To Tutorial"

to see a lot of fully commented examples that help you use the Perl statements and the Perl buit-in functions in your scripts.

The general syntax form

splice ARRAY, OFFSET, LENGTH, LIST

It is the general form of this function and it uses all its arguments. Here’s an example:

# initialize an array
my @array = qw(1 2 3 11 12 10);
my @returnedArray = splice @array, 3, 2, 4..9;

print "\@array = (@array)\n";
print "\@returnedArray = (@returnedArray)\n";

This code produces as output:

@array = (1 2 3 4 5 6 7 8 9 10)
@returnedArray = (11 12)

As you can notice, the Perl splice function modifies the array passes to it as its first argument. It removes 2 elements (11, 12) starting with the index 3 (the fourth element of the array). Obviously, I assumed that the $[ special variable is set to 0 (i.e. the first element of the array is 0). $[ is the index of the first element in an array and can be modified, anyway be cautious if you are tented to alter it.

4..9 is the list argument containing the numbers from 4 to 9 and replaces the two elements removed. The elements removed will be returned in the @returnedArray.

The second syntax form

splice ARRAY, OFFSET, LENGTH

In this syntax form, the LIST argument is omitted and you can use this format any time you need to remove a chunk of elements from an array. See the example below for this:

# initialize and fill an array
my @array = qw(1 2 3 4 5 6 7 8 9 10);
my @returnedArray = splice @array, 5, 7;

print "\@array = (@array)\n";
print "\@returnedArray = (@returnedArray)\n";

The output:

@array = (1 2 3 4 5)
@returnedArray = (6 7 8 9 10)

This code will remove the elements of the array starting with the index 5 (the sixth element of the array) and it will try to remove 7 elements. Because there are only 5 elements available, it will remove the elements until the end of the array is reached.

The third syntax form

splice ARRAY, OFFSET

In this syntax form, both the LIST and the LENGTH argument are omitted. In this case the Perl splice function will remove all the elements from OFFSET onward. If OFFSET is negative, it starts that far from the end of the array. See the following snippet code:

# initialize and fill an array
my @array = qw(1 2 3 4 5 6 7 8 9 10);

# using a positive OFFSET
splice @array, 8;
# the @array is now (1, 2, 3, 4, 5, 6, 7, 8)

# using a negative OFFSET
splice @array, -3;
# the @array is now (1, 2, 3, 4, 5)

In the last example of this code I used a negative OFFSET (-3) – as result the Perl splice function removed the last 3 elements of the array.

The fourth syntax form

splice ARRAY

In this format, the Perl splice function has only one argument – the array variable. In this case it removes all the elements of the array.

my @array = qw(1 2 3 4 5 6 7 8 9 10);
splice @array;

This code will practically empty the array. If you need to empty an array, you may consider other options, too:

@array = ();  # or
undef @array; # or
$#array = -1

Using the undef function could be preferable, because it frees all the memory associated with the array, as if @array had been declared but never used.

*****

There are also available other functions that manipulate the removing, adding and replacing of the elements into an array, such as:

the shift function that removes the first element of an array
the unshift function that inserts a list at the beginning of an array
the pop function that removes the last element of an array
the push function that appends a list to an array

As you can see, the shift and pop function can remove only one element of an array (the first and the last element). You can now use the Perl slice function to remove a portion of the array, either at the beginning or at the end of the array. And more, you can either insert a list into the middle of an array or remove a portion from an array, starting with any index.

For example, the next snippet code shows you how to delete a portion of an array from the beginning of the array:

my @array = qw(1 2 3 4 5);
splice(@array, 0, 2);

# the array is now: (3, 4, 5)

Or this example that shows you how to insert a list at the beginning of an array:

my @array = qw(6 7 8 9 10);
splice(@array, 0, 0, 1..5);

# the array is now: (1, 2, 3, 4, 5, 6, 7, 8, 9, 10)

The Perl splice function starts at the index 0, removes 0 elements and replaces the removed elements with the list 1..5.

Please click here to download the Perl splice script with all the above examples included.

Subscribe now to my FREE newsletter
(regarding tips and tricks to manipulate multidimensional
arrays and hashes in Perl)
and you'll receive a link to download for FREE my Perl chomp Function Tutorial eBook (a $7.50 value), it's a bonus for you and I hope you'll enjoy it. You can see its Table of Contents here (if you subscribe to my free newsletter, you don't have to pay for this eBook or use your paypal account).

Don't forget to check my new How To Tutorial eBooks (PDF format):
"Perl Statements - How To Tutorial"
"Perl Scalar and String Functions - How To Tutorial"

to see a lot of fully commented examples that help you use the Perl statements and the Perl buit-in functions in your scripts.

NEW!!!

Do you want more information about the basic Perl topics?

Check my new "Perl How To" Tutorial eBooks page where I'll answer the most frequent questions regarding some topics :

Perl How To Tutorial eBooks

Table of Contents:

A Perl Script
Install Perl
Running Perl
Perl Data Types
Perl Variables
Perl Operators
Perl Lists
Perl Arrays
    Array Size
    Array Length
Perl Hashes
Perl Statements
    Perl if
    Perl unless
    Perl switch
    Perl while
    Perl do-while
    Perl until
    Perl do-until
    Perl for
    Perl foreach
Built-in Perl Functions
    Functions by Category
        String Functions
        Array Functions
    Functions in alphabetical order
        chomp
        chop
        chr
        crypt
        defined
        grep
        hex
        index
        join
        lc
        lcfirst
        length
        map
        oct
        ord
        pack
        pop
        push
        qw
        reverse
        rindex
        scalar
        shift
        sort
        splice
        split
        substr
        uc
        undef
        unshift

return from Perl splice function to Perl Basics

Would you like to create your own website like this one?
Hit the Alarm Clock!

footer for perl splice page