• NAME
• SYNOPSIS
• DESCRIPTION
• CONSTRUCTORS
  • new
• METHODS
  • get_offset
  • set_offset
  • get_length
  • set_length
  • get_weight
  • set_weight
  • compare_to
• INHERITANCE

NAME

Lucy::Search::Span - An offset, a length, and a weight.

SYNOPSIS

    my $combined_length = $upper_span->get_length
        + ( $upper_span->get_offset - $lower_span->get_offset );
    my $combined_span = Lucy::Search::Span->new(
        offset => $lower_span->get_offset,
        length => $combined_length,
    );
    ...

DESCRIPTION

Span objects store information about a span across an array of… something. The unit is context-dependent.

Text is one possibility, in which case offset and length might be measured in Unicode code points. However, the Span could also refer to a span within an array of tokens, for example – in which case the start and offset might be measured in token positions.

CONSTRUCTORS

new

    my $span = Lucy::Search::Span->new(
        offset => 75,     # required
        length => 7,      # required
        weight => 1.0,    # default 0.0
    );

Create a new Span.

• offset - Integer offset, unit is context-dependent.

• length - Integer length, unit is context-dependent.

• weight - A floating point weight.

METHODS

get_offset

    my $int = $span->get_offset();

Accessor for offset attribute.

set_offset

    $span->set_offset($offset);

Setter for offset attribute.

get_length

    my $int = $span->get_length();

Accessor for length attribute.

set_length

    $span->set_length($length);

Setter for length attribute.

get_weight

    my $float = $span->get_weight();

Accessor for weight attribute.

set_weight

    $span->set_weight($weight);

Setter for weight attribute.

compare_to

    my $int = $span->compare_to($other);

Indicate whether one object is less than, equal to, or greater than another.

• other - Another Obj.

Returns: 0 if the objects are equal, a negative number if self is less than other, and a positive number if self is greater than other.

INHERITANCE

Lucy::Search::Span isa Clownfish::Obj.