• NAME
• SYNOPSIS
• DESCRIPTION
• CONSTRUCTORS
  • new
• METHODS
  • append
  • next
  • reset
• INHERITANCE

NAME

Lucy::Analysis::Inversion - A collection of Tokens.

SYNOPSIS

    my $result = Lucy::Analysis::Inversion->new;

    while (my $token = $inversion->next) {
        $result->append($token);
    }

DESCRIPTION

An Inversion is a collection of Token objects which you can add to, then iterate over.

CONSTRUCTORS

new

    my $inversion = Lucy::Analysis::Inversion->new(
        $seed,  # optional
    );

Create a new Inversion.

• seed - An initial Token to start things off, which may be undef.

METHODS

append

    $inversion->append($token);

Tack a token onto the end of the Inversion.

• token - A Token.

next

    my $token = $inversion->next();

Return the next token in the Inversion until out of tokens.

reset

    $inversion->reset();

Reset the Inversion’s iterator, so that the next call to next() returns the first Token in the inversion.

INHERITANCE

Lucy::Analysis::Inversion isa Clownfish::Obj.