php8.5
Home/ Manual/ ds / vector/ Ds\Vector::rotate

Ds\Vector::rotate

PHP function Edit on GitHub ✎

(PECL ds >= 1.0.0)

Rotates the vector by a given number of rotations

Description

Ds\Vector::rotate(int $rotations): void

Rotates the vector by a given number of rotations, which is equivalent to successively calling $vector->push($vector->shift()) if the number of rotations is positive, or $vector->unshift($vector->pop()) if negative.

Parameters

rotations

The number of times the vector should be rotated.

Return Values

Void. The vector of the current instance will be rotated.

Examples

Ds\Vector::rotate() example

php
<?php
$vector = new \Ds\Vector(["a", "b", "c", "d"]);

$vector->rotate(1);  // "a" is shifted, then pushed.
print_r($vector);

$vector->rotate(2);  // "b" and "c" are both shifted, then pushed.
print_r($vector);
?>

The above example will output something similar to:

output
(
    [0] => b
    [1] => c
    [2] => d
    [3] => a
)
Ds\Vector Object
(
    [0] => d
    [1] => a
    [2] => b
    [3] => c
)

Source: reference/ds/ds/vector/rotate.xml · from the official PHP manual (php/doc-en)