PHP - Ds Vector::get() Function

---

---

The PHP Ds\Vector::get() function is used to retrieve a value at a given index in a vector. The index is the position of an element in the vector, which starts from the "0th" index and ends with "n-1", where n is the size of the vector.

This function throws an "OutOfRangeException" if the specified index exceeds the size of the vector or is not valid.

Syntax

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

public Ds\Vector::get(int $index): mixed

Parameters

Following is the parameter of this function −

• $index − The 0th-based index at which accesses the element.

Return value

This function returns a value at the specified index.

Example 1

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

<?php 
   $vector = new \Ds\Vector([10, 20, 30, 40, 50]);
   echo "The vector elements are: \n";
   print_r($vector);
   $index = 0;
   echo "The index value is: ".$index;
   echo "\nThe value at the given index ".$index." is: ";
   #using get() function
   print_r($vector->get($index));
?>

Output

The above program produces the following output −

The vector elements are:
Ds\Vector Object
(
    [0] => 10
    [1] => 20
    [2] => 30
    [3] => 40
    [4] => 50
)
The index value is: 0
The value at the given index 0 is: 10

Example 2

Following is another example of the PHP Ds\Vector::get() function. We use this function to retrieve an element from this vector (["Tutorials", "Point", "Tutorix"]) at the specified index 2 −

<?php 
   $vector = new \Ds\Vector(["Tutorials", "Point", "Tutorix"]); 
   echo "The vector elements are: \n";
   print_r($vector);
   $index = 2;
   echo "The index value is: ".$index;
   echo "\nThe element at the given index ".$index." is: ";
   print_r($vector->get($index));
?>

Output

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

The vector elements are: 
Ds\Vector Object
(
    [0] => Tutorials
    [1] => Point
    [2] => Tutorix
)
The index value is: 2
The element at the given index 2 is: Tutorix

Example 3

If the specified index value is not valid, the get() function throws an "OutOfRangeException" −

<?php 
   $vector = new \Ds\Vector(['a', 'e', 'i', 'o', 'u']); 
   echo "The vector elements are: \n";
   print_r($vector);
   $index = 10;
   echo "The index value is: ".$index;
   echo "\nThe element at the given index ".$index." is: ";
   print_r($vector->get($index));
?>

Output

The above program throws an exception as follows −

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