---
name: "Lucy::Search::Span"
section: "3pm"
platform: "linux"
package: "liblucy-perl"
version: "0.3.3-7+b1"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/Lucy::Search::Span"
---

# Lucy::Search::Span(3pm)

An offset, a length, and a weight.

## 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( *\[labeled params\]* )

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

- •

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

- •

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

- •

  **weight** - A floating point weight.

## METHODS

### set\_offset(offset)

Setter for `"offset"` attribute.

### *get\_offset()*

Accessor for `"offset"` attribute.

### set\_length(length)

Setter for `"length"` attribute.

### *get\_length()*

Accessor for `"length"` attribute.

### set\_weight(weight)

Setter for `"weight"` attribute.

### *get\_weight()*

Accessor for `"weight"` attribute.

## INHERITANCE

Lucy::Search::Span isa Lucy::Object::Obj.