<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>PocketSphinx: src/libpocketsphinx/ngram_search.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">PocketSphinx <span id="projectnumber">0.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('ngram__search_8c.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>src/libpocketsphinx/ngram_search.c File Reference</h1> </div>
</div>
<div class="contents">
<p>N-Gram based multi-pass search ("FBS")
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <string.h></code><br/>
<code>#include <assert.h></code><br/>
<code>#include <sphinxbase/ckd_alloc.h></code><br/>
<code>#include <sphinxbase/listelem_alloc.h></code><br/>
<code>#include <sphinxbase/err.h></code><br/>
<code>#include "<a class="el" href="pocketsphinx__internal_8h_source.html">pocketsphinx_internal.h</a>"</code><br/>
<code>#include "<a class="el" href="ps__lattice__internal_8h_source.html">ps_lattice_internal.h</a>"</code><br/>
<code>#include "<a class="el" href="ngram__search_8h_source.html">ngram_search.h</a>"</code><br/>
<code>#include "<a class="el" href="ngram__search__fwdtree_8h_source.html">ngram_search_fwdtree.h</a>"</code><br/>
<code>#include "<a class="el" href="ngram__search__fwdflat_8h_source.html">ngram_search_fwdflat.h</a>"</code><br/>
</div>
<p><a href="ngram__search_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa0dcbb86340083bce1412c9309742bc"></a><!-- doxytag: member="ngram_search.c::ngram_search_init" ref="afa0dcbb86340083bce1412c9309742bc" args="(cmd_ln_t *config, acmod_t *acmod, dict_t *dict, dict2pid_t *d2p)" -->
<a class="el" href="structps__search__s.html">ps_search_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ngram__search_8c.html#afa0dcbb86340083bce1412c9309742bc">ngram_search_init</a> (cmd_ln_t *config, <a class="el" href="structacmod__s.html">acmod_t</a> *acmod, <a class="el" href="structdict__t.html">dict_t</a> *dict, <a class="el" href="structdict2pid__t.html">dict2pid_t</a> *d2p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the N-Gram search module. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeaf140dc2bbeaa5c274f73480b5328f3"></a><!-- doxytag: member="ngram_search.c::ngram_search_free" ref="aeaf140dc2bbeaa5c274f73480b5328f3" args="(ps_search_t *search)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="ngram__search_8c.html#aeaf140dc2bbeaa5c274f73480b5328f3">ngram_search_free</a> (<a class="el" href="structps__search__s.html">ps_search_t</a> *search)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize the N-Gram search module. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ngram__search_8c.html#a7772e007b7d7fdf437c87aeb08b59c71">ngram_search_mark_bptable</a> (<a class="el" href="structngram__search__s.html">ngram_search_t</a> *ngs, int frame_idx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Record the current frame's index in the backpointer table. <a href="#a7772e007b7d7fdf437c87aeb08b59c71"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae36649be6f5a2190e759e7ed13bd7b6b"></a><!-- doxytag: member="ngram_search.c::ngram_search_save_bp" ref="ae36649be6f5a2190e759e7ed13bd7b6b" args="(ngram_search_t *ngs, int frame_idx, int32 w, int32 score, int32 path, int32 rc)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="ngram__search_8c.html#ae36649be6f5a2190e759e7ed13bd7b6b">ngram_search_save_bp</a> (<a class="el" href="structngram__search__s.html">ngram_search_t</a> *ngs, int frame_idx, int32 w, int32 score, int32 path, int32 rc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enter a word in the backpointer table. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ngram__search_8c.html#aa4b308f06bdf75b2f5eb0f0559f775ae">ngram_search_find_exit</a> (<a class="el" href="structngram__search__s.html">ngram_search_t</a> *ngs, int frame_idx, int32 *out_best_score)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find the best word exit for the current frame in the backpointer table. <a href="#aa4b308f06bdf75b2f5eb0f0559f775ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="ngram__search_8c.html#aee393a136f8f7e8b98161e6eed7b1dd9">ngram_search_bp_hyp</a> (<a class="el" href="structngram__search__s.html">ngram_search_t</a> *ngs, int bpidx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Backtrace from a given backpointer index to obtain a word hypothesis. <a href="#aee393a136f8f7e8b98161e6eed7b1dd9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ddcc1a9cb3e164ceb2140097ed23a3e"></a><!-- doxytag: member="ngram_search.c::ngram_search_alloc_all_rc" ref="a1ddcc1a9cb3e164ceb2140097ed23a3e" args="(ngram_search_t *ngs, int32 w)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="ngram__search_8c.html#a1ddcc1a9cb3e164ceb2140097ed23a3e">ngram_search_alloc_all_rc</a> (<a class="el" href="structngram__search__s.html">ngram_search_t</a> *ngs, int32 w)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate last phone channels for all possible right contexts for word w. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15477192481dffcb29e9c4167eff6c3c"></a><!-- doxytag: member="ngram_search.c::ngram_search_free_all_rc" ref="a15477192481dffcb29e9c4167eff6c3c" args="(ngram_search_t *ngs, int32 w)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="ngram__search_8c.html#a15477192481dffcb29e9c4167eff6c3c">ngram_search_free_all_rc</a> (<a class="el" href="structngram__search__s.html">ngram_search_t</a> *ngs, int32 w)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate last phone channels for all possible right contexts for word w. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25a80e488425b2bd4e24eb753c9295a5"></a><!-- doxytag: member="ngram_search.c::ngram_search_exit_score" ref="a25a80e488425b2bd4e24eb753c9295a5" args="(ngram_search_t *ngs, bptbl_t *pbe, int rcphone)" -->
int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="ngram__search_8c.html#a25a80e488425b2bd4e24eb753c9295a5">ngram_search_exit_score</a> (<a class="el" href="structngram__search__s.html">ngram_search_t</a> *ngs, <a class="el" href="structbptbl__s.html">bptbl_t</a> *pbe, int rcphone)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the exit score for a backpointer entry with a given right context. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7526cf720a80052770c5b6f82c93749d"></a><!-- doxytag: member="ngram_search.c::ngram_compute_seg_score" ref="a7526cf720a80052770c5b6f82c93749d" args="(ngram_search_t *ngs, bptbl_t *be, float32 lwf, int32 *out_ascr, int32 *out_lscr)" -->
void </td><td class="memItemRight" valign="bottom"><b>ngram_compute_seg_score</b> (<a class="el" href="structngram__search__s.html">ngram_search_t</a> *ngs, <a class="el" href="structbptbl__s.html">bptbl_t</a> *be, float32 lwf, int32 *out_ascr, int32 *out_lscr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac10e5308e0a48948b3c21bb4c2d80c1b"></a><!-- doxytag: member="ngram_search.c::dump_bptable" ref="ac10e5308e0a48948b3c21bb4c2d80c1b" args="(ngram_search_t *ngs)" -->
void </td><td class="memItemRight" valign="bottom"><b>dump_bptable</b> (<a class="el" href="structngram__search__s.html">ngram_search_t</a> *ngs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac30e7dec4bbfeee9f5163abf4bbd1014"></a><!-- doxytag: member="ngram_search.c::ngram_search_lattice" ref="ac30e7dec4bbfeee9f5163abf4bbd1014" args="(ps_search_t *search)" -->
<a class="el" href="structps__lattice__s.html">ps_lattice_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ngram__search_8c.html#ac30e7dec4bbfeee9f5163abf4bbd1014">ngram_search_lattice</a> (<a class="el" href="structps__search__s.html">ps_search_t</a> *search)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a word lattice from the current hypothesis. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>N-Gram based multi-pass search ("FBS") </p>
<p>Definition in file <a class="el" href="ngram__search_8c_source.html">ngram_search.c</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="aee393a136f8f7e8b98161e6eed7b1dd9"></a><!-- doxytag: member="ngram_search.c::ngram_search_bp_hyp" ref="aee393a136f8f7e8b98161e6eed7b1dd9" args="(ngram_search_t *ngs, int bpidx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char const* ngram_search_bp_hyp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structngram__search__s.html">ngram_search_t</a> * </td>
<td class="paramname"><em>ngs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>bpidx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Backtrace from a given backpointer index to obtain a word hypothesis. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a <b>read-only</b> string with the best hypothesis. </dd></dl>
<p>Definition at line <a class="el" href="ngram__search_8c_source.html#l00555">555</a> of file <a class="el" href="ngram__search_8c_source.html">ngram_search.c</a>.</p>
<p>References <a class="el" href="ngram__search_8h_source.html#l00114">bptbl_s::bp</a>, <a class="el" href="pocketsphinx__internal_8h_source.html#l00093">ps_search_s::hyp_str</a>, and <a class="el" href="ngram__search_8h_source.html#l00113">bptbl_s::wid</a>.</p>
</div>
</div>
<a class="anchor" id="aa4b308f06bdf75b2f5eb0f0559f775ae"></a><!-- doxytag: member="ngram_search.c::ngram_search_find_exit" ref="aa4b308f06bdf75b2f5eb0f0559f775ae" args="(ngram_search_t *ngs, int frame_idx, int32 *out_best_score)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ngram_search_find_exit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structngram__search__s.html">ngram_search_t</a> * </td>
<td class="paramname"><em>ngs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>frame_idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 * </td>
<td class="paramname"><em>out_best_score</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find the best word exit for the current frame in the backpointer table. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the backpointer index of the best word exit. </dd></dl>
<p>Definition at line <a class="el" href="ngram__search_8c_source.html#l00513">513</a> of file <a class="el" href="ngram__search_8c_source.html">ngram_search.c</a>.</p>
<p>References <a class="el" href="hmm_8h_source.html#l00085">BETTER_THAN</a>, <a class="el" href="ngram__search_8h_source.html#l00308">ngram_search_s::n_frame</a>, <a class="el" href="ngram__search_8h_source.html#l00115">bptbl_s::score</a>, <a class="el" href="ngram__search_8h_source.html#l00113">bptbl_s::wid</a>, and <a class="el" href="hmm_8h_source.html#l00074">WORST_SCORE</a>.</p>
</div>
</div>
<a class="anchor" id="a7772e007b7d7fdf437c87aeb08b59c71"></a><!-- doxytag: member="ngram_search.c::ngram_search_mark_bptable" ref="a7772e007b7d7fdf437c87aeb08b59c71" args="(ngram_search_t *ngs, int frame_idx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ngram_search_mark_bptable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structngram__search__s.html">ngram_search_t</a> * </td>
<td class="paramname"><em>ngs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>frame_idx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Record the current frame's index in the backpointer table. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the current backpointer index. </dd></dl>
<p>Definition at line <a class="el" href="ngram__search_8c_source.html#l00344">344</a> of file <a class="el" href="ngram__search_8c_source.html">ngram_search.c</a>.</p>
<p>References <a class="el" href="ngram__search_8h_source.html#l00316">ngram_search_s::frm_wordlist</a>, and <a class="el" href="ngram__search_8h_source.html#l00307">ngram_search_s::n_frame_alloc</a>.</p>
<p>Referenced by <a class="el" href="ngram__search__fwdflat_8c_source.html#l00922">ngram_fwdflat_finish()</a>, <a class="el" href="ngram__search__fwdflat_8c_source.html#l00811">ngram_fwdflat_search()</a>, <a class="el" href="ngram__search__fwdtree_8c_source.html#l01499">ngram_fwdtree_finish()</a>, and <a class="el" href="ngram__search__fwdtree_8c_source.html#l01455">ngram_fwdtree_search()</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="ngram__search_8c.html">ngram_search.c</a> </li>
<li class="footer">Generated on Wed Apr 20 2011 for PocketSphinx by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
