Class::MakeMethods::Utility::ArraySplicer man page on Pidora

Man page or keyword search:  
man Server   31170 pages
apropos Keyword Search (all sections)
Output format
Pidora logo
[printable version]

MakeMethods::Utility::UseryContributed PeMakeMethods::Utility::ArraySplicer(3)

NAME
       Class::MakeMethods::Utility::ArraySplicer - Common array ops

SYNOPSIS
	 use Class::MakeMethods::Utility::ArraySplicer;

	 # Get one or more values
	 $value = array_splicer( $array_ref, $index );
	 @values = array_splicer( $array_ref, $index_array_ref );

	 # Set one or more values
	 array_splicer( $array_ref, $index => $new_value, ... );

	 # Splice selected values in or out
	 array_splicer( $array_ref, [ $start_index, $end_index], [ @values ]);

DESCRIPTION
       This module provides a utility function and several associated
       constants which support a general purpose array-splicer interface, used
       by several of the Standard and Composite method generators.

   array_splicer
       This is a general-purpose array accessor function. Depending on the
       arguments passed to it, it will get, set, slice, splice, or otherwise
       modify your array.

       ·   If called without any arguments, returns the contents of the array
	   in list context, or an array reference in scalar context (or
	   undef).

	     # Get all values
	     $value_ref = array_splicer( $array_ref );
	     @values = array_splicer( $array_ref );

       ·   If called with a single numeric argument, uses that argument as an
	   index to retrieve from the referenced array, and returns that value
	   (or undef).

	     # Get one value
	     $value = array_splicer( $array_ref, $index );

       ·   If called with a single array ref argument, sets the contents of
	   the array to match the contents of the provided one.

	     # Set contents of array
	     array_splicer( $array_ref, [ $value1, $value2, ... ] );

	     # Reset the array contents to empty
	     array_splicer( $array_ref, [] );

       ·   If called with a two arguments, the first undefined and the second
	   an array ref argument, uses that array's contents as a list of
	   indexes to return a slice of the referenced array.

	     # Get slice of values
	     @values = array_splicer( $array_ref, undef, [ $index1, $index2, ... ] );

       ·   If called with a list of argument pairs, each with a numeric index
	   and an associated value, stores the value at the given index in the
	   referenced array. The current value in each position will be
	   overwritten, and later arguments with the same index will override
	   earlier ones. Returns the current array-ref value.

	     # Set one or more values by index
	     array_splicer( $array_ref, $index1 => $value1, $index2 => $value2, ... );

       ·   If called with a list of argument pairs, each with the first item
	   being a reference to an array of up to two numbers, loops over each
	   pair and uses those numbers to splice the value array.

	     # Splice selected values in or out
	     array_splicer( $array_ref, [ $start_index, $count], [ @values ]);

	   The first controlling number is the position at which the splice
	   will begin. Zero will start before the first item in the list.
	   Negative numbers count backwards from the end of the array.

	   The second number is the number of items to be removed from the
	   list. If it is omitted, or undefined, or zero, no items are
	   removed. If it is a positive integer, that many items will be
	   returned.

	   If both numbers are omitted, or are both undefined, they default to
	   containing the entire value array.

	   If the second argument is undef, no values will be inserted; if it
	   is a non-reference value, that one value will be inserted; if it is
	   an array-ref, its values will be copied.

	   The method returns the items that removed from the array, if any.

	   Here are some examples of common splicing operations.

	     # Insert an item at position in the array
	     $obj->bar([3], 'Potatoes' );

	     # Remove 1 item from position 3 in the array
	     $obj->bar([3, 1], undef );

	     # Set a new value at position 2, and return the old value
	     print $obj->bar([2, 1], 'Froth' );

	     # Unshift an item onto the front of the list
	     array_splicer( $array_ref, [0], 'Bubbles' );

	     # Shift the first item off of the front of the list
	     print array_splicer( $array_ref, [0, 1], undef );

	     # Push an item onto the end of the list
	     array_splicer( $array_ref, [undef], 'Bubbles' );

	     # Pop the last item off of the end of the list
	     print array_splicer( $array_ref, [undef, 1], undef );

   Constants
       There are also constants symbols to facilitate some common combinations
       of splicing arguments:

	 # Reset the array contents to empty
	 array_splicer( $array_ref, array_clear );

	 # Set the array contents to provided values
	 array_splicer( $array_ref, array_splice, [ 2, 3 ] );

	 # Unshift an item onto the front of the list
	 array_splicer( $array_ref, array_unshift, 'Bubbles' );

	 # Shift it back off again
	 print array_splicer( $array_ref, array_shift );

	 # Push an item onto the end of the list
	 array_splicer( $array_ref, array_push, 'Bubbles' );

	 # Pop it back off again
	 print array_splicer( $array_ref, array_pop );

SEE ALSO
       See Class::MakeMethods for general information about this distribution.

       See Class::MakeMethods::Standard::Hash and numerous other classes for
       examples of usage.

perl v5.14.2			  2004-09MakeMethods::Utility::ArraySplicer(3)
[top]

List of man pages available for Pidora

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net