Core Function Splice - Revision history

UberFoX: 1 revision

2015-06-14T12:37:21Z

1 revision

← Older revision

Revision as of 12:37, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:40:58Z

1 revision

← Older revision

Revision as of 21:40, 11 August 2014

UberFoX: /* Example */

2013-02-01T18:00:17Z

Example

← Older revision		Revision as of 18:00, 1 February 2013
Line 136:		Line 136:
	// $array = (1 2 3 4 5 6 7)		// $array = (1 2 3 4 5 6 7)
	// $ret = (8 9 10)		// $ret = (8 9 10)
		+	</syntaxhighlight>
		+
		+	This example that shows you how to insert a list at the beginning of an array:
		+	<syntaxhighlight lang="sputnik">
		+	my $array = qw/6 7 8 9 10/;
		+	splice($array, 0, 0, 1..5);
		+	print "\$array = ($array[<>])\n";
		+	// Prints:
		+	// $array = (1 2 3 4 5 6 7 8 9 10)
		+	</syntaxhighlight>
		+
		+	This shows you how to delete a portion of an array from the beginning of the array:
		+	<syntaxhighlight lang="sputnik">
		+	my $array = qw/1 2 3 4 5/;
		+	splice($array, 0, 2);
		+	print "\$array = ($array[<>])\n";
		+	// Prints:
		+	// $array = (3 4 5)
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX: /* Example */

2013-02-01T17:46:22Z

Example

← Older revision		Revision as of 17:46, 1 February 2013
Line 100:		Line 100:
	printr($Test);		printr($Test);
	printr($Test2);		printr($Test2);
		+	</syntaxhighlight>
		+
		+	Another simple example
		+	<syntaxhighlight lang="sputnik">
		+	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";
		+	// Prints:
		+	// $array = (1 2 3 4 5 6 7 8 9 10)
		+	// $returnedArray = (11 12)
		+	</syntaxhighlight>
		+
		+	Splice array up to index 8 (Everything past index 8 is deleted)
		+	<syntaxhighlight lang="sputnik">
		+	// initialize an array
		+	my $array = qw/1 2 3 4 5 6 7 8 9 10/;
		+	// using a positive OFFSET
		+	splice($array, 8);
		+	print "\$array = ($array[<>])\n";
		+	// Prints:
		+	// $array = (1 2 3 4 5 6 7 8)
		+	</syntaxhighlight>
		+
		+	Splice array by removing 3 elements from the beginning (using -3 offset)
		+	<syntaxhighlight lang="sputnik">
		+	// initialize an array
		+	my $array = qw/1 2 3 4 5 6 7 8 9 10/;
		+	// using a positive OFFSET
		+	$ret = splice($array, -3);
		+	print "\$array = ($array[<>])\n";
		+	print "\$ret = ($ret[<>])\n";
		+	// Prints:
		+	// $array = (1 2 3 4 5 6 7)
		+	// $ret = (8 9 10)
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX: Created page with "

 Splice( , , ,  ... )

=== Description === Cut out and return a chunk or portion of an array and optionally replace the cut out ..."

2013-02-01T15:41:16Z

Created page with "<pre> Splice( <array>, <offset>, <length>, <replace_with> ... ) </pre> === Description === Cut out and return a chunk or portion of an array and optionally replace the cut out ..."

New page

<pre>
Splice( <array>, <offset>, <length>, <replace_with> ... )
</pre>

=== Description ===

Cut out and return a chunk or portion of an array and optionally replace the cut out section with new data.

=== Parameters ===

==== array ====

The array to use.

==== offset ====

The offset within the array to begin splicing at (Index number).

==== length ====

Optional; How many splices to make counting up from the offset

If this parameter is not specified the length will be the full extent of the array.

==== replace_with ====

Optional; Data to insert at the

=== Return Value ===

Success: Returns new array of the spliced data.

Failure: Returns empty array.

=== Remarks ===

Works very similar to Perls Splice() function for them who know it.

=== Example ===

A simple example with commentary
<syntaxhighlight lang="sputnik">
/*
Sputniks's splice() function is used to cut out and return
a chunk or portion of an array. The portion that is cut out
starts at the OFFSET element of the array and continues for LENGTH
elements. If the LENGTH is not specified, it will cut to the end of the array.
*/

$myNames = array('Jacob', 'Michael', 'Joshua', 'Matthew', 'Ethan', 'Andrew');
$someNames = splice($myNames, 1, 3);
println("#################################");
println("First example");
println("Orig array modified:");
printr($myNames);
println("New array:");
printr($someNames);
println("#################################");

/*
Think of the $myNames array as a row of numbered boxes, going from left to right,
numbered starting with a zero. The splice() function would cut a chunk out of the
$myNames array starting with the element in the #1 position (in this case, Michael)
and ending 3 elements later at Matthew. The value of $someNames then becomes
('Michael', 'Joshua', 'Matthew'), and $myNames is shortened to ('Jacob', 'Ethan', 'Andrew').

As an option, you can replace the portion removed with another array by passing it in
the REPLACE_WITH argument.
*/

$myNames = array('Jacob', 'Michael', 'Joshua', 'Matthew', 'Ethan', 'Andrew');
$moreName = array('Daniel', 'William', 'Joseph');
$someNames = splice($myNames, 1, 3, $moreName);

println("#################################");
println("Second example");
println("Orig array modified:");
printr($myNames);
println("New array:");
printr($someNames);
println("#################################");

/*
In the above example, the splice() function would cut a chunk out of the $myNames array
starting with the element in the #1 position (in this case, Michael and ending 3 elements
later at Matthew. It then replaces those names with the contents of the $moreNames array.
The value of $someNames then becomes ('Michael', 'Joshua', 'Matthew'), and $myNames is
changed to ('Jacob', 'Daniel', 'William', 'Joseph', 'Ethan', 'Andrew').
*/
</syntaxhighlight>

A relatively complex example where elements are removed from an array and replaced and a new array is created from the removed elements.
<syntaxhighlight lang="sputnik">
$Replace = array("ONE", "TWO", "THREE");
$hehe = array("fox", "cow");

$Test = array("Zero", "One", "Two", "Three", "Four", "Five", "Six", "Seven", "Eight");
$Test2 = splice($Test, 1, 3, $Replace, "cat", "dog", $hehe);

printr($Test);
printr($Test2);
</syntaxhighlight>

[[Category:Core Function]]