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

<!--#set var="isip_page_title" value="SearchSymbol" -->
<?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/search/SearchSymbol/SearchSymbol.h">SearchSymbol</a> : public <a href="../../math/scalar/String/index.html">String</a>
</b>

<br><br>

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

<blockquote>
<pre>
g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_search.a

#include &lt;SearchSymbol.h&gt;

~SearchSymbol();
SearchSymbol();
SearchSymbol(const SearchSymbol& copy_sym);
SearchSymbol(const String& symbol);
</pre>
</blockquote>

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

<blockquote>
<pre>
#include &lt;SearchSymbol.h&gt;
#include &lt;Vector.h&gt;

SearchSymbol start_sym;
start_sym.assign(L"_START_");
SearchSymbol end_sym;
start_sym.assign(L"_END_");

Vector<SearchSymbol> word_syms(3);
word_syms(0).assign(L"one");
word_syms(1).assign(L"two");
word_syms(2).assign(L"oh");  

Vector<SearchSymbol> phone_syms(6);
phone_syms(0).assign(L"w");
phone_syms(1).assign(L"ae");
phone_syms(2).assign(L"n");
phone_syms(3).assign(L"t");
phone_syms(4).assign(L"uw");
phone_syms(5).assign(L"ow");
 
Vector<SearchSymbol> state_syms(6);
state_syms(0).assign(L"w_1");
state_syms(1).assign(L"ae_1");
state_syms(2).assign(L"n_1");
state_syms(3).assign(L"t_1");
state_syms(4).assign(L"uw_1");
state_syms(5).assign(L"ow_1");
</pre>
</blockquote>

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

<ul>
The SearchSymbol class is a string identifier of the search node.
</ul>

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

<ul>
  <li> <a href="../../math/scalar/String/index.html">String</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/search/SearchSymbol/ssym_00.cc&constant=CLASS_NAME">static const String CLASS_NAME = L"SearchSymbol";</a></pre>
  <li> define i/o related constants:
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/ssym_00.cc&constant=DEF_PARAM">static const String SearchSymbol::DEF_PARAM = L"search";</a></pre>
  <li> other constants
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/ssym_00.cc&constant=NO_LEFT_CONTEXT">static const SearchSymbol SearchSymbol::NO_LEFT_CONTEXT = L"!NO_LEFT_CONTEXT";</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/ssym_00.cc&constant=NO_RIGHT_CONTEXT">static const SearchSymbol SearchSymbol::NO_RIGHT_CONTEXT = L"!NO_RIGHT_CONTEXT";</a></pre>
</ul>
	 
<a name="error">       
<b>error codes:</b>
<br><br>

<ul>
  <li> error code indicating a general error:
       <pre><a href="/perl/ifc_document.pl?err=00090400">static const long ERR = 90400;</a></pre>
</ul>

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

<ul>
  <li> memory manager:
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/ssym_00.cc&static=mgr_d">static MemoryManager mgr_d;</a></pre>
  <li> debug level:
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/ssym_00.cc&static=debug_level_d">static Integral::DEBUG debug_level_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/search/SearchSymbol/SearchSymbol.h&method=name">static const String& name();</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/ssym_02.cc&method=diagnose">static boolean diagnose(Integral::DEBUG debug_level);</a></pre>

  <li> <pre>debug methods: setDebug method is inherited from the <a href="../../math/scalar/String/index.html">String</a>
class</pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=setDebug">static boolean setDebug(Integral::DEBUG debug_level);</a></pre>

  <li> destructor/constructor(s):
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=destructor">~SearchSymbol();</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=default constructor">SearchSymbol();</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=copy+constructor">SearchSymbol(const SearchSymbol& arg);</a></pre>

  <li> <pre>assign methods: assign method is inherited from the <a href="../../math/scalar/String/index.html">String</a>
class</pre>

  <li> operator= methods:
      <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=operator%3D&instance=0">SearchSymbol& operator=(const SearchSymbol& arg)</a></pre>

  <li> <pre>i/o methods: readData and writeData methods are inherited from the <a href="../../math/scalar/String/index.html">String</a>
class</pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=sofSize">long sofSize() const;</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/ssym_03.cc&method=read">boolean read(Sof& sof, long tag, const String& name = CLASS_NAME);</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/ssym_04.cc&method=write">boolean write(Sof& sof, long tag, const String& name = CLASS_NAME) const;</a></pre>

  <li> memory management methods:

       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=new">static void* operator new(size_t size);</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=new[]">static void* operator new[](size_t size);</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=delete">static void operator delete(void* ptr);</a></pre>
       <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=delete[]">static void operator delete[](void* ptr);</a></pre>  
        <pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=setGrowSize">static boolean setGrowSize(long grow_size);</a></pre>  
</ul>

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

<ul>
  <li> constructor method:
<pre><a href="/perl/ifc_document.pl?file=$isip/class/search/SearchSymbol/SearchSymbol.h&method=constructor">SearchSymbol(const String& symbol);</a></pre>
</ul>

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

<ul>       
  <li> none
</ul>

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

<ul>
  <li> This <a href="/perl/ifc_document.pl?file=$isip/doc/examples/class/search/search_example_00/example.cc">example</a> shows how to build a simple search structure and how to generate all paths through it.
</ul>

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

<ul>
  <li> none
</ul>

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