PHP Ds\Vector Functions

A vector in PHP 7 stores a sequence of values in a single memory area that can grow or shrink as needed. Unlike arrays, vectors automatically manage their size. They are a fast and efficient data structure in PHP 7, offering an alternative to arrays.

Requirements: You need PHP 7 to use vectors and ensure compatibility.

Installation: The easiest way to install the data structure is using the PECL extension:

pecl install ds

Syntax:

public Ds\Vector::function

Example: Here is how to use the `Ds\Vector::find()` function in PHP:

<?php

// Create a vector with elements
$vector = new \Ds\Vector([1, 2, 3, 4, 5]);

// Display the vector elements
var_dump($vector);

// Find the index of the element
var_dump($vector->find(1)); // Finds index of 1
var_dump($vector->find(5)); // Finds index of 5
var_dump($vector->find(8)); // Element not found
var_dump($vector->find("Stephano")); // Element not found

?>

Output:

object(Ds\Vector)#1 (5) {
  [0]=> int(1)
  [1]=> int(2)
  [2]=> int(3)
  [3]=> int(4)
  [4]=> int(5)
}
int(0)   // Index of 1
int(4)   // Index of 5
bool(false) // 8 not found
bool(false) // "Stephano" not found

Key Takeaways:

• Vectors are efficient and manage size automatically.
• PHP 7 is required to use vectors.
• Install the vector data structure using the PECL extension.
• Use `Ds\Vector::find()` to locate elements within a vector.

Using this guide, you can easily understand and implement vectors in PHP 7, making your code more efficient and streamlined.

The complete list of data structure DS\Vector are given below:

Vector Functions	Description
allocate(size)	Allocate memory for the vector to hold a specific number of elements (`size`). This pre-allocates space to potentially avoid performance overhead during insertions.
apply(callback)	Apply a callback function to each element in the vector. The callback function takes the current element value and index as arguments and can modify the element in-place.
capacity()	Return the current maximum number of elements the vector can hold without needing reallocation.
clear()	Remove all elements from the vector.
__construct([initial_size])	**Optional:** Create a new vector instance. In some implementations, a vector can be created without an explicit constructor call. You can optionally provide an initial size for the vector.
contains(value)	Check whether the vector contains a specific value.
copy()	Create a new vector that is a copy of the original vector.
count()	Return the number of elements currently in the vector.
filter(callback)	Create a new vector containing only the elements that pass a test defined by the callback function.
find(value)	Return the index of the first occurrence of a specific value in the vector, or -1 if not found.
first()	Return the first element in the vector (same as get(0)).
get(index)	Return the element at the specified index in the vector.
insert(index, value)	Insert a new element at a specific index in the vector.
isEmpty()	Check whether the vector is empty (contains no elements).
join(separator)	Join all elements of the vector into a string, separated by the provided delimiter (separator).
jsonSerialize()	Implement the `JsonSerializable` interface, allowing the vector to be converted to a JSON representation.
last()	Return the last element in the vector (same as get(count() - 1)).
map(callback)	Create a new vector by applying a callback function to each element of the original vector. The callback function's return value becomes the element in the new vector.
merge(iterable)	Merge all elements from another iterable (like an array) into the vector.
pop()	Remove and return the last element from the vector.
push(value)	Add a new element to the end of the vector.
reduce(callback, initial_value)	Reduce the vector to a single value by applying a callback function to each element sequentially. The callback function takes the accumulated result and the current element as arguments and returns a new accumulated value.
remove(index)	Remove and return the element at the specified index from the vector.
reverse()	Reverse the order of elements in the vector in-place.
rotate(offset)	Rotate the elements in the vector by a specified number of positions. Positive offsets shift elements to the right, negative offsets to the left.
set(index, value)	Set the value at the specified index in the vector.
shift()	Remove and return the first element from the vector.
slice(start, length)	Extract a sub-vector containing a range of elements from the original vector.
sort(comparison_function)	Sort the elements of the vector in-place. You can optionally provide a comparison function to define the sorting order.
sorted(comparison_function)	Create a new vector containing a sorted copy of the elements from the original vector. You can optionally provide a comparison function to define the sorting order.
sum()	Return the sum of all the elements in the vector.
toArray()	Convert the vector to a regular PHP array.
unshift(value)	Add one or more elements to the beginning of the vector.