<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="appstream-as-stemmer">
<refmeta>
<refentrytitle role="top_of_page" id="appstream-as-stemmer.top_of_page">as-stemmer</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>APPSTREAM Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>as-stemmer</refname>
<refpurpose>Stemming helper singleton for AppStream searches.</refpurpose>
</refnamediv>

<refsect1 id="appstream-as-stemmer.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="AsStemmer"><returnvalue>AsStemmer</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-stemmer-get">as_stemmer_get</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-stemmer-reload">as_stemmer_reload</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-stemmer-stem">as_stemmer_stem</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<anchor id="AsStemmer"/><refsect1 id="appstream-as-stemmer.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="AS-TYPE-STEMMER:CAPS">AS_TYPE_STEMMER</link></entry></row>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="AsStemmer-struct">AsStemmer</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="appstream-as-stemmer.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> AsStemmer
</screen>
</refsect1>


<refsect1 id="appstream-as-stemmer.description" role="desc">
<title role="desc.title">Description</title>

</refsect1>
<refsect1 id="appstream-as-stemmer.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="as-stemmer-get" role="function">
<title>as_stemmer_get&#160;()</title>
<indexterm zone="as-stemmer-get"><primary>as_stemmer_get</primary></indexterm>
<programlisting language="C"><link linkend="AsStemmer"><returnvalue>AsStemmer</returnvalue></link>&#160;*
as_stemmer_get (<parameter><type>void</type></parameter>);</programlisting>
<para>Gets the global <link linkend="AsStemmer"><type>AsStemmer</type></link> instance.</para>
<refsect3 id="as-stemmer-get.returns" role="returns">
<title>Returns</title>
<para> an <link linkend="AsStemmer"><type>AsStemmer</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-stemmer-reload" role="function">
<title>as_stemmer_reload&#160;()</title>
<indexterm zone="as-stemmer-reload"><primary>as_stemmer_reload</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_stemmer_reload (<parameter><link linkend="AsStemmer"><type>AsStemmer</type></link> *stemmer</parameter>,
                   <parameter>const <link linkend="gchar"><type>gchar</type></link> *lang</parameter>);</programlisting>
<para>Allows realoading the <link linkend="AsStemmer"><type>AsStemmer</type></link> with a different language.</para>
<refsect3 id="as-stemmer-reload.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>stemmer</para></entry>
<entry role="parameter_description"><para>A <link linkend="AsStemmer"><type>AsStemmer</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>lang</para></entry>
<entry role="parameter_description"><para>The stemming language.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="as-stemmer-stem" role="function">
<title>as_stemmer_stem&#160;()</title>
<indexterm zone="as-stemmer-stem"><primary>as_stemmer_stem</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_stemmer_stem (<parameter><link linkend="AsStemmer"><type>AsStemmer</type></link> *stemmer</parameter>,
                 <parameter>const <link linkend="gchar"><type>gchar</type></link> *term</parameter>);</programlisting>
<para>Stems a string using Snowball.</para>
<refsect3 id="as-stemmer-stem.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>stemmer</para></entry>
<entry role="parameter_description"><para>A <link linkend="AsStemmer"><type>AsStemmer</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>term</para></entry>
<entry role="parameter_description"><para>The input term to stem.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-stemmer-stem.returns" role="returns">
<title>Returns</title>
<para> A stemmed string.</para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="appstream-as-stemmer.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AS-TYPE-STEMMER:CAPS" role="macro">
<title>AS_TYPE_STEMMER</title>
<indexterm zone="AS-TYPE-STEMMER:CAPS"><primary>AS_TYPE_STEMMER</primary></indexterm>
<programlisting language="C">#define AS_TYPE_STEMMER&#160;(as_stemmer_get_type ())
</programlisting>
<para>
</para>
</refsect2>
<refsect2 id="AsStemmer-struct" role="struct">
<title>AsStemmer</title>
<indexterm zone="AsStemmer-struct"><primary>AsStemmer</primary></indexterm>
<programlisting language="C">typedef struct _AsStemmer AsStemmer;</programlisting>
<para>
</para>
</refsect2>

</refsect1>

</refentry>
