Innmind / Immutable

     *

     * @return MapInterface<int, self>

     */

    public function words(string $charlist = ''): MapInterface

    {

        $words = str_word_count($this->value, 2, $charlist);

        $map = new Map('int', self::class);

        foreach ($words as $position => $word) {

            $map = $map->put($position, new self($word, $this->encoding));

        }

        return $map;

    }

    /**

     * Split the string using a regular expression

     *

     * @return StreamInterface<self>

     */

    public function pregSplit(string $regex, int $limit = -1): StreamInterface

    {

        $strings = preg_split($regex, $this->value, $limit);

        $stream = new Stream(self::class);

        foreach ($strings as $string) {

            $stream = $stream->add(new self($string, $this->encoding));

        }

        return $stream;

    }

    /**

     * Check if the string match the given regular expression