HH\ImmSet::filter

Returns an ImmSet containing the values of the current ImmSet that meet a supplied condition applied to each value.

Description

public function filter(
  (function(Tv):bool) $callback,
): ImmSet<Tv>

Returns an ImmSet containing the values of the current ImmSet that meet a supplied condition applied to each value.

Only values that meet a certain criteria are affected by a call to filter(), while all values are affected by a call to map().

Parameters

  • (function(Tv):bool) $callback - The callback containing the condition to apply to the current ImmSet values.

Return Values

  • ImmSet<Tv> - an ImmSet containing the values after a user-specified condition is applied.

Examples

See Set::filter for usage examples.