PHP - Ds Vector::set() Function

---

---

The PHP Ds\Vector::set() function is used to update the existing value at a given index with the specified in a vector.

If the specified index value is not valid, this function will throw an "OutOfRangeException". The invalid index can be negative or exceeds the vector size.

Syntax

Following is the syntax of the PHP Ds\Vector::set() function −

public void Ds\Vector::set( int $index, mixed $value )

Parameters

Following are the parameters of the this function −

• $index − The index of the value to update.
• $value − The new value will be replaced exiting.

Return value

This function doesn't return any value.

Example 1

The following is the basic example of the PHP Ds\Vector::set() function −

<?php 
   $vector = new \Ds\Vector([1, 2, 3, 4, 5]);
   echo "The original vector: \n";   
   print_r($vector);
   $index = 1;
   $value = 10;
   echo "The index is: ".$index;
   echo "\nThe given value is: ".$value;
   #using vector() function
   $vector->set($index, $value);
   echo("\nThe vector after updating an element: \n"); 
   print_r($vector); 
?>

Output

The above program produces the following output −

The original vector:
Ds\Vector Object
(
    [0] => 1
    [1] => 2
    [2] => 3
    [3] => 4
    [4] => 5
)
The index is: 1
The given value is: 10
The vector after updating an element:
Ds\Vector Object
(
    [0] => 1
    [1] => 10
    [2] => 3
    [3] => 4
    [4] => 5
)

Example 2

Following is another example of the PHP Ds\Vector::set() function. We use this function to update the existing value at the specified index "2" of this vector (["Tutorials", "Point", "India"]) −

<?php 
   $vector = new \Ds\Vector(["Tutorials", "Point", "India"]);
   echo "The original vector: \n";   
   print_r($vector);
   $index = 2;
   $value = "Tutorix";
   echo "The index is: ".$index;
   echo "\nThe given value: ".$value;
   #using set() function
   $vector->set($index, $value);
   echo("\nThe vector after updating an element: \n"); 
   print_r($vector); 
?>

Output

After executing the above program, the following output will displayed −

The original vector:
Ds\Vector Object
(
    [0] => Tutorials
    [1] => Point
    [2] => India
)
The index is: 2
The given value: Tutorix
The vector after updating an element:
Ds\Vector Object
(
    [0] => Tutorials
    [1] => Point
    [2] => Tutorix
)

Example 3

If the given index is not valid, the set() function will throw an "OutOfRangeException" −

<?php 
   $vector = new \Ds\Vector(['a', 'e', 'i', 'o', 'u']);
   echo "The original vector: \n";   
   print_r($vector);
   $index = -1;
   $value = "A";
   echo "The index is: ".$index;
   echo "\nThe given value: ".$value;
   #using set() function
   $vector->set($index, $value);
   echo("\nThe vector after updating an element: \n"); 
   print_r($vector); 
?>

Output

Once the above program is executed, it generates the following output −

The original vector:
Ds\Vector Object
(
    [0] => a
    [1] => e
    [2] => i
    [3] => o
    [4] => u
)
The index is: -1
The given value: APHP Fatal error:  Uncaught OutOfRangeException:
 Index out of range: -1, expected 0 <= x <= 4 in C:\Apache24\htdocs\index.php:10
Stack trace:
#0 C:\Apache24\htdocs\index.php(10): Ds\Vector->set(-1, 'A')
#1 {main}
  thrown in C:\Apache24\htdocs\index.php on line 10