<?php $isip_window_title = "ISIP Homepage"; ?>
<?php include("/data/isip/www/templates/documentation/header/header.html"); ?>

<!--#set var="isip_page_title" value="NGramNode" -->
<?php include("/data/isip/www/templates/documentation/body/index_class.html"); ?>
<?php include("/data/isip/www/templates/documentation/body/bar.html"); ?>

<a name="name">
<b>

name:
<a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h">NGramNode</a>

</b>
<br><br>

<a name="synopsis">
<b>synopsis:</b>
<br><br>

<blockquote>
<pre>

g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_mmedia.a

#include &lt;NGramNode.h&gt;

boolean setIndex(const long index);
boolean setLmScore(const float lm_score);
boolean setBackoff(const float backoff);
boolean setNextGram(HashTable&lt;Long, NGramNode&gt;* hash);
boolean set(const float lm_score, const float backoff);
long getIndex() const;
float getLmScore() const;
float getBackoff() const;
HashTable&lt;Long, NGramNode&gt;* getNextGram() const;
</pre>
</blockquote>

<a name="quick_start">
<b>quick start:</b>
<br><br>

<blockquote>
<pre>

NGramNode nnode_00;
HashTable<Long, NGramNode> ht1;

nnode_00.setNextGram(ht1);

</pre>
</blockquote>

<a name="description">
<b>description:</b>
<br><br>

This class stores the N-gram probability.

<br><br>

<a name="dependencies">
<b>dependencies:</b>
<br><br>

<ul>
  <li> <a href="../../dstr/HashTable/">HashTable.h</a>
</ul>

<a name="constants">
<b>public constants:</b>
<br><br>

<ul>
  <li> define the class name:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&constant=CLASS_NAME">static const String CLASS_NAME;</a></pre>

  <li> define i/o related constants:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&constant=PARAM_INDEX">static const String PARAM_INDEX;</a></pre>
       
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&constant=PARAM_LM_SCORE">static const String PARAM_LM_SCORE;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&constant=PARAM_BACKOFF">static const String PARAM_BACKOFF;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&constant=PARAM_NEXT_GRAM">static const String PARAM_NEXT_GRAM;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&constant=PARAM_KEYS">static const String PARAM_KEYS;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&constant=PARAM_VALUES">static const String PARAM_VALUES;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&constant=DEF_PARAM">static const String DEF_PARAM;</a></pre>

  <li> define default values and arguments:
       
       <pre>static const long DEF_INDEX;</pre>

       <pre>static const float DEF_LM_SCORE;</pre>

       <pre>static const float DEF_BACKOFF;</pre>

</ul>

<a name="error">
<b>error codes:</b>
<br><br>

<ul>
  <li> error codes indicating general errors:

       <pre><a href="/perl/ifc_document.pl?err=00050700">static const long ERR = (long)50700;</a></pre>

</ul>

<a name="protected">
<b>protected data:</b>
<br><br>

<ul>
  <li> declare symbol string represented in this node:

       <pre>Long index_d;</pre>

  <li> declare language model and backoff score information:

       <pre>Float lm_score_d;</pre>

  <li> declare the backoff weight:

       <pre>Float backoff_d;</pre>

  <li> declare a pointer to the next order ngram hash table:

       <pre>HashTable&lt;Long, NGramNode&gt;* next_gram_d;</pre>

  <li> declare the debugging parameters:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&static=debug_level_d">static Integral::DEBUG debug_level_d;</a></pre>

  <li> declare the memory manager:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&static=mgr_d">static MemoryManager mgr_d;</a></pre>

</ul>

<a name="public">
<b>required public methods:</b>
<br><br>

<ul>
  <li> static methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=name&instance=0">static const String& name();</a></pre>

  <li> debug methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_02.cc&method=diagnose&instance=0">static boolean diagnose(Integral::DEBUG debug_level);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_01.cc&method=debug&instance=0">boolean debug(const unichar* msg) const;</a></pre>

  <li> destructor/constructor(s):

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=destructor&instance=0">~NGramNode();</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=default+constructor&instance=0">NGramNode();</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=copy+constructor&instance=0">NGramNode(const NGramNode& arg);</a></pre>

  <li> assign methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=assign&instance=0">boolean assign(const NGramNode& arg);</a></pre>

  <li> operator= method:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=operator%3D&instance=0">NGramNode& operator= (const NGramNode& arg);</a></pre>

  <li> i/o methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_04.cc&method=sofSize&instance=0">long sofSize() const;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_03.cc&method=read&instance=0">boolean read(Sof& sof, const long tag, const String& cname = CLASS_NAME);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_04.cc&method=write&instance=0">boolean write(Sof& sof, long tag, const String& cname = CLASS_NAME) const;</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_03.cc&method=readData&instance=0">boolean readData(Sof& sof, const String& pname = DEF_PARAM, long size = SofParser::FULL_OBJECT, boolean param = true, boolean nested = false);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_04.cc&method=writeData&instance=0">boolean writeData(Sof& sof, const String& pname = DEF_PARAM) const;</a></pre>

  <li> equality methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/nnode_00.cc&method=eq&instance=0">boolean eq(const NGramNode& arg) const;</a></pre>

  <li> memory management methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=new&instance=0">static void* operator new(size_t size);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=new\[\]&instance=0">static void* operator new[](size_t size);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=delete&instance=0">static void operator delete(void* ptr);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=delete\[\]&instance=0">static void operator delete[](void* ptr);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=setGrowSize&instance=0">static boolean setGrowSize(long grow_size);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=clear&instance=0">boolean clear(Integral::CMODE ctype = Integral::DEF_CMODE);</a></pre>

</ul>

<a name="specific">
<b>class-specific public methods:</b>
<br><br>

<ul>
  <li> declare index methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=setIndex&instance=0">boolean setIndex(const long index);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=getIndex&instance=0">long getIndex() const;</a></pre>
       
  <li> declare score methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=setLmScore&instance=0">boolean setLmScore(const float lm_score);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=getLmScore&instance=0">float getLmScore() const;</a></pre>
       
  <li> declare backoff methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=setBackoff&instance=0">boolean setBackoff(const float backoff);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=getBackoff&instance=0">float getBackoff() const;</a></pre>

  <li> declare ngram manipulation methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=set&instance=0">boolean set(const float lm_score, const float backoff);</a></pre>
       
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=setNextGram&instance=0">boolean setNextGram(HashTable&lt;Long, NGramNode&gt;* hash);</a></pre>

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/mmedia/NGramNode/NGramNode.h&method=getNextGram&instance=0">HashTable&lt;Long, NGramNode&gt;* getNextGram() const;</a></pre>

</ul>

<a name="private">
<b>private methods:</b>
<br><br>

<ul>
  <li> declare private methods:

</ul>

<a name="examples">
<b>examples:</b>
<br><br>

<ul>
  <li> none.

<pre>
</pre>
</ul>

<a name="notes">
<b>notes:</b>
<br><br>

<ul>
  <li> none.
</ul>

<!--#include virtual="/hse/ies/templates/documentation/footer/footer.html" -->
