Set

A traversable object or an array to use for the initial values.

Values to add to the set.

Values to check.

Returns a shallow copy of the set.

The custom count as an integer.

The return value is cast to an integer.

A new set containing all values that were not in the other set.

callback ( mixed \$value ): bool
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.

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.

The first value in the set.

The value at the requested index.

An instance of an object implementing Iterator or Traversable

The intersection of the current instance and another set.

data which can be serialized by json_encode, which is a value of any type other than a resource.

The last value in the set.

The callback to apply to each value in the set must have the following signature: callback ( mixed \$value ): mixed

Returns a new Ds\Set instance where each value is the result of applying the callback to each value of the set.

A traversable object or an array.

The result of adding all given values to the set, effectively the same as adding the values to a copy, then returning that copy. The current instance won't be affected.

callback ( mixed \$carry , mixed \$value ): mixed
\$carry - The return value of the previous callback, or initial if it's the first iteration.
\$value - The value of the current iteration.

The initial value of the carry value. Can be null.

The return value of the final callback.

The values to remove.

A reversed copy of the set. The current instance is not affected.

A sub-set of the given range.

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. Returning non-integer values from the comparison function, such as float, will result in an internal cast to int 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.

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. Returning non-integer values from the comparison function, such as float, will result in an internal cast to int 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.

Returns a sorted copy of the set.

The sum of all the values in the set as either a float or int depending on the values in the set.

An array containing all the values in the same order as the set.

A new set containing all the values of the current instance as well as another set.

A new set containing values in the current instance as well as another set, but not in both.

An offset to check for.

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

The offset to retrieve.

Can return all value types.

The offset to assign the value to.

The value to set.

No value is returned.

The offset to unset.

No value is returned.