| Methods |
public
|
__construct(iterable $values = [])
Creates a new instance, using either a traversable object or an array
for the initial values.
Creates a new instance, using either a traversable object or an array
for the initial values.
Parameters
| $values |
A traversable object of an array to
use the initial values.
|
|
#
|
public
|
add(mixed ...$values)
Adds all given values to the set that haven't already been added.
Adds all given values to the set that haven't already been added.
Note: Values of type object are supported. If an object implements
Ds\Hashable, equality will be determined by the object's equals
function. If an object does not implement Ds\Hashable, objects must
be references to the same instance to be considered equal.
Caution: All comparisons are strict (type and value).
Parameters
| ...$values |
Values to add to the set.
|
|
#
|
public
|
allocate(int $capacity)
Allocates enough memory for a required capacity.
Allocates enough memory for a required capacity.
Parameters
| $capacity |
The number of values for which capacity should
be allocated.
|
|
#
|
public
|
contains(mixed ...$values): bool
Determines if the set contains all values.
Determines if the set contains all values.
Values of type object are supported. If an object implements
Ds\Hashable, equality will be determined by the object's equals
function. If an object does not implement Ds\Hashable, objects must
be references to the same instance to be considered equal.
Caution: All comparisons are strict (type and value).
Parameters
| ...$values |
Values to check.
|
|
#
|
public
|
capacity(): int
Returns the current capacity.
Returns the current capacity.
|
#
|
public
|
clear(): void
Removes all values from the set.
Removes all values from the set.
Implements
|
#
|
public
|
count(): int
Count elements of an object
Count elements of an object
Returns
The custom count as an integer.
The return value is cast to an integer.
Implements
|
#
|
public
|
copy(): Set
Returns a shallow copy of the set.
Returns a shallow copy of the set.
Implements
|
#
|
public
|
diff(Set $set): Set
Creates a new set using values that aren't in another set.
Creates a new set using values that aren't in another set.
A \ B = {x ∈ A | x ∉ B}
Parameters
| $set |
Set containing the values to exclude.
|
Returns
A new set containing all values that were not in the
other set.
|
#
|
public
|
filter(null|callable $callback = null): Set
Creates a new set using a callable to determine which values to
include
Creates a new set using a callable to determine which values to
include
Parameters
| $callback |
Optional callable which returns TRUE if the
value should be included, FALSE otherwise.
If a callback is not provided, only values which are TRUE (see
converting to boolean) will be included.
|
Returns
A new set containing all the values for which either the
callback returned TRUE, or all values that convert to TRUE if a
callback was not provided.
|
#
|
public
|
first(): mixed
Returns the first value in the set.
Returns the first value in the set.
Returns
The first value in the set.
|
#
|
public
|
get(int $index): mixed
Returns the value at a given index.
Returns the value at a given index.
Parameters
| $index |
The index to access, starting at 0.
|
Returns
The value at the requested index.
|
#
|
public
|
getIterator(): Traversable
|
#
|
public
|
intersect(Set $set): Set
Creates a new set using values common to both the current instance
and another set. In other words, returns a copy of…
Creates a new set using values common to both the current instance
and another set. In other words, returns a copy of the current
instance with all values removed that are not in the other set.
A ∩ B = {x : x ∈ A ∧ x ∈ B}
Parameters
Returns
The intersection of the current instance and another set.
|
#
|
public
|
isEmpty(): bool
Returns whether the set is empty.
Returns whether the set is empty.
Implements
|
#
|
public
|
join(null|string $glue = null): string
Joins all values together as a string using an optional separator
between each value.
Joins all values together as a string using an optional separator
between each value.
Parameters
| $glue |
An optional string to separate each value.
|
|
#
|
public
|
map(callable $callback): Set
Returns the result of applying a callback function to each value in
the set.
Returns the result of applying a callback function to each value in
the set.
Parameters
| $callback |
A callable to apply to each value in the
set.
The callable should return what the new value will be in the new
set.
callback ( mixed $value ) : mixed
|
Returns
The result of applying a callback to each value in
the set.
Note: The values of the current instance won't be affected.
|
#
|
public
|
merge(iterable $values): Set
Returns the result of adding all given values to the set.
Returns the result of adding all given values to the set.
Note: The current instance won't be affected.
Parameters
| $values |
A traversable object or an array.
|
Returns
The result of adding all given values to the set,
effectively the same as adding the values to a copy, then returning
that copy.
|
#
|
public
|
reduce(callable $callback, mixed|null $initial = null): mixed
Reduces the set to a single value using a callback function.
Reduces the set to a single value using a callback function.
Parameters
| $initial |
The initial value of the carry value. Can be
NULL.
|
Returns
The return value of the final callback.
|
#
|
public
|
remove(mixed ...$values)
Removes all given values from the set, ignoring any that are not in
the set.
Removes all given values from the set, ignoring any that are not in
the set.
Parameters
| ...$values |
The values to remove.
|
|
#
|
public
|
reverse()
Reverses the set in-place.
Reverses the set in-place.
|
#
|
public
|
reversed(): Set
Returns a reversed copy of the set.
Returns a reversed copy of the set.
Returns
A reversed copy of the set.
|
#
|
public
|
slice(int $index, int|null $length = null): Set
Returns a sub-set of a given range
Returns a sub-set of a given range
Parameters
| $index |
The index at which the sub-set starts. If positive,
the set will start at that index in
the set. If negative, the set will start that far from the end.
|
| $length |
If a length is given and is positive, the
resulting set will have up to that many values in it. If the length
results in an overflow, only values up to the end of the set will be
included. If a length is given and is negative, the set will stop
that many values from the end. If a length is not provided, the
resulting set will contain all values between the index and the end
of the set.
|
Returns
A sub-set of the given range.
|
#
|
public
|
last(): mixed
Returns the last value in the set.
Returns the last value in the set.
Returns
The last value in the set.
Throws
|
#
|
public
|
sort(callable|null $comparator = null)
Sorts the set in-place, using an optional comparator function.
Sorts the set in-place, using an optional comparator function.
Parameters
| $comparator |
The comparison function must return
an integer less than, equal to, or greater than zero if the first
argument is considered to be respectively less than, equal to, or
greater than the second. Note that before PHP 7.0.0 this integer had
to be in the range from -2147483648 to 2147483647.
callback ( mixed $a, mixed $b ) : int
Caution: Returning non-integer values from the comparison
function, such as float, will result in an internal cast to integer
of the callback's return value. So values such as 0.99 and 0.1 will
both be cast to an integer value of 0, which will compare such values
as equal.
|
|
#
|
public
|
sorted(null|callable $comparator = null): Set
Returns a sorted copy, using an optional comparator function.
Returns a sorted copy, using an optional comparator function.
Parameters
| $comparator |
The comparison function must return an
integer less than, equal to, or greater than zero if the first
argument is considered to be respectively less than, equal to, or
greater than the second. Note that before PHP 7.0.0 this integer had
to be in the range from -2147483648 to 2147483647.
|
Returns
Returns a sorted copy of the set.
|
#
|
public
|
sum(): float|int
Returns the sum of all values in the set.
Returns the sum of all values in the set.
Note: Arrays and objects are considered equal to zero when
calculating the sum.
Returns
The sum of all the values in the set as either a
float or int depending on the values in the set.
|
#
|
public
|
union(Set $set): Set
Creates a new set that contains the values of the current instance as
well as the values of another set.
Creates a new set that contains the values of the current instance as
well as the values of another set.
A ∪ B = {x: x ∈ A ∨ x ∈ B}
Parameters
| $set |
The other set, to combine with the current instance.
|
Returns
A new set containing all the values of the current
instance as well as another set.
|
#
|
public
|
xor(Set $set): Set
Creates a new set using values in either the current instance or in
another set, but not in both.
Creates a new set using values in either the current instance or in
another set, but not in both.
A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)}
Parameters
Returns
A new set containing values in the current instance as
well as another set, but not in both.
|
#
|
public
|
toArray(): array
Converts the set to an array.
<p><b>Note:</b> Casting to an array is not supported yet.</p>
Converts the set to an array.
Note: Casting to an array is not supported yet.
Returns
An array containing all the values in the same order as
the collection.
Implements
|
#
|
public
|
jsonSerialize(): mixed
Specify data which should be serialized to JSON
Specify data which should be serialized to JSON
Returns
data which can be serialized by json_encode,
which is a value of any type other than a resource.
Implements
|
#
|