lcn_frequencies.h

Go to the documentation of this file.

/* Copyright 2005 The Apache Software Foundation or its licensors, as
 * applicable.
 *
 * Licensed 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.
 */

/**
 * @file lcn_frequencies.h
 * @brief routines for reading the frequencies data for a segment
 */

#ifndef _LCN_FREQUENCIES_H
#define _LCN_FREQUENCIES_H

#include "lcn_types.h"
#include "lcn_terminfos.h"
#include "lcn_directory.h"

#include <apr_pools.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** Opaque structure representing the frequencies file for a segment. */
typedef struct lcn_frequencies_t lcn_frequencies_t;

/** Return the @a freqs for segment @a s in directory @a d, allocated in
 * @a pool.
 */
lcn_error_t *
lcn_frequencies_open (lcn_frequencies_t **freqs,
                      const lcn_directory_t *d,
                      const lcn_char_t *s,
                      apr_pool_t *pool);

/** Return the document numbers @a docs and frequencies @a freqs for all
 * documents that contain the term represented by @c lcn_terminfo_t @a ti
 * within @c lcn_frequencies_t @a f, allocated in @a pool.
 */
lcn_error_t *
lcn_frequencies_get_terminfo_data (apr_uint32_t **docs,
                                   apr_uint32_t **freqs,
                                   lcn_frequencies_t *f,
                                   const lcn_terminfo_t *ti,
                                   apr_pool_t *pool);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif

---