src/libsphinxbase/lm/ngram_model_arpa.h

   1 /* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
   2 /* ====================================================================
   3  * Copyright (c) 1999-2007 Carnegie Mellon University.  All rights
   4  * reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  *
  18  * This work was supported in part by funding from the Defense Advanced
  19  * Research Projects Agency and the National Science Foundation of the
  20  * United States of America, and the CMU Sphinx Speech Consortium.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
  23  * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  24  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
  26  * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  * ====================================================================
  35  *
  36  */
  37 /*
  38  * \file ngram_model_arpa.h ARPABO text format for N-Gram models
  39  *
  40  * Author: David Huggins-Daines <dhuggins@cs.cmu.edu>
  41  */
  42
  43 #ifndef __NGRAM_MODEL_ARPA_H__
  44 #define __NGRAM_MODEL_ARPA_H__
  45
  46 #include "ngram_model_internal.h"
  47 #include "lm3g_model.h"
  48
  49 /**
  50  * Bigram structure.
  51  */
  52 struct bigram_s {
  53     uint32 wid; /**< Index of unigram entry for this.  (NOT dictionary id.) */
  54     uint16 prob2;       /**< Index into array of actual bigram probs */
  55     uint16 bo_wt2;      /**< Index into array of actual bigram backoff wts */
  56     uint16 trigrams;    /**< Index of 1st entry in lm_t.trigrams[],
  57                              RELATIVE TO its segment base (see above) */
  58 };
  59
  60 /**
  61  * Trigram structure.
  62  *
  63  * As with bigrams, trigram prob info kept in a separate table for conserving
  64  * memory space.
  65  */
  66 struct trigram_s {
  67     uint32 wid;   /**< Index of unigram entry for this.  (NOT dictionary id.) */
  68     uint16 prob3; /**< Index into array of actual trigram probs */
  69 };
  70
  71
  72 /**
  73  * Subclass of ngram_model for ARPA file reading.
  74  */
  75 typedef struct ngram_model_arpa_s {
  76     ngram_model_t base;  /**< Base ngram_model_t structure */
  77     lm3g_model_t lm3g;  /**< Shared lm3g structure */
  78
  79     /* Arrays of unique bigram probs and bo-wts, and trigram probs
  80      * (these are temporary, actually) */
  81     sorted_list_t sorted_prob2;
  82     sorted_list_t sorted_bo_wt2;
  83     sorted_list_t sorted_prob3;
  84 } ngram_model_arpa_t;
  85
  86 #endif /* __NGRAM_MODEL_ARPA_H__ */