core/LucyX/Search/ProximityMatcher.cfh

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

parcel Lucy;

/** Matcher for a ProximityQuery.
 */

class LucyX::Search::ProximityMatcher inherits Lucy::Search::Matcher {

    int32_t         doc_id;
    uint32_t        num_elements;
    Similarity     *sim;
    PostingList   **plists;
    ByteBuf        *anchor_set;
    float           proximity_freq;
    float           proximity_boost;
    Compiler       *compiler;
    float           weight;
    bool_t          first_time;
    bool_t          more;
    uint32_t        within;

    inert incremented ProximityMatcher*
    new(Similarity *similarity, VArray *posting_lists, Compiler *compiler,
        uint32_t within);

    inert ProximityMatcher*
    init(ProximityMatcher *self, Similarity *similarity, VArray *posting_lists,
         Compiler *compiler, uint32_t within);

    public void
    Destroy(ProximityMatcher *self);

    public int32_t
    Next(ProximityMatcher *self);

    public int32_t
    Advance(ProximityMatcher *self, int32_t target);

    public int32_t
    Get_Doc_ID(ProximityMatcher *self);

    public float
    Score(ProximityMatcher *self);

    /** Calculate how often the phrase occurs in the current document.
     */
    float
    Calc_Proximity_Freq(ProximityMatcher *self);
}