Project Lucy has retired. For details please refer to its Attic page.
Lucy::Analysis::Inversion – C API Documentation
Apache Lucy™

Lucy::Analysis::Inversion

parcel Lucy
class variable LUCY_INVERSION
struct symbol lucy_Inversion
class nickname lucy_Inversion
header file Lucy/Analysis/Inversion.h

Name

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

Description

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

Functions

new
lucy_Inversion* // incremented
lucy_Inversion_new(
    lucy_Token *seed
);

Create a new Inversion.

seed

An initial Token to start things off, which may be NULL.

Methods

Append
void
lucy_Inversion_Append(
    lucy_Inversion *self,
    lucy_Token *token // decremented
);

Tack a token onto the end of the Inversion.

token

A Token.

Next
lucy_Token*
lucy_Inversion_Next(
    lucy_Inversion *self
);

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

Reset
void
lucy_Inversion_Reset(
    lucy_Inversion *self
);

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

Inheritance

Lucy::Analysis::Inversion is a Clownfish::Obj.