types_8h.tex

xapian 是一个“Xapian 是一个开源概率论信息检索库

\hypertarget{types_8h}{
\section{include/xapian/types.h File Reference}
\label{types_8h}\index{include/xapian/types.h@{include/xapian/types.h}}
}
Common types used. 



This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=420pt]{types_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef unsigned int \hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{docid}
\begin{CompactList}\small\item\em A unique id for a document. \item\end{CompactList}\item 
typedef \hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{docid} \hyperlink{types_8h_b4166dca4ac15d88c933bbb8e0d55d23}{doccount}
\begin{CompactList}\small\item\em Type for counts of documents. \item\end{CompactList}\item 
typedef int \hyperlink{types_8h_d8243c2a1cbe7e9f88ab4704233f531e}{doccount\_\-diff}
\begin{CompactList}\small\item\em Type for signed difference between counts of documents. \item\end{CompactList}\item 
typedef unsigned int \hyperlink{types_8h_6979d98ebbe67186bd31e5ee2a7585cb}{termcount}
\begin{CompactList}\small\item\em Type for counts of terms (eg, wdf, wqf). \item\end{CompactList}\item 
typedef int \hyperlink{types_8h_992fbdbe6bdbfc25fb14ffcd6a83692a}{termcount\_\-diff}
\begin{CompactList}\small\item\em Type for signed difference between counts of terms. \item\end{CompactList}\item 
typedef unsigned int \hyperlink{types_8h_5cdae0172ef811a7c08017eb4429c311}{termpos}
\begin{CompactList}\small\item\em Type for term positions within documents. \item\end{CompactList}\item 
typedef int \hyperlink{types_8h_800ebcc9f3f0de991f2755f28cca8ea7}{termpos\_\-diff}
\begin{CompactList}\small\item\em Type for signed difference between term positions. \item\end{CompactList}\item 
typedef double \hyperlink{types_8h_7272583216038f810105df7dc927723c}{doclength}
\begin{CompactList}\small\item\em Type for (normalised) lengths of documents. \item\end{CompactList}\item 
typedef unsigned int \hyperlink{types_8h_f24564a367ebbc8f80cf9a1dbd1e81fd}{valueno}
\begin{CompactList}\small\item\em Type for referring to the number of a value in document. \item\end{CompactList}\item 
typedef int \hyperlink{types_8h_609c717d551f258db5cc883c3861b645}{valueno\_\-diff}
\begin{CompactList}\small\item\em Type for signed difference between two valueno-s. \item\end{CompactList}\item 
typedef double \hyperlink{types_8h_167860ee249b702eb746dca0d245f808}{weight}
\begin{CompactList}\small\item\em A calculated weight, for a term or document. \item\end{CompactList}\item 
typedef int \hyperlink{types_8h_d9213278aaed43f1ab0110c87a6b7476}{percent}
\begin{CompactList}\small\item\em A percentage weight, for a term or document. \item\end{CompactList}\item 
typedef unsigned int \hyperlink{types_8h_d963f87f47b8bb630701c1128f204aaf}{timeout}
\begin{CompactList}\small\item\em Type for specifying a timeout. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Common types used. 



\subsection{Typedef Documentation}
\hypertarget{types_8h_b4166dca4ac15d88c933bbb8e0d55d23}{
\index{types.h@{types.h}!doccount@{doccount}}
\index{doccount@{doccount}!types.h@{types.h}}
\subsubsection[doccount]{\setlength{\rightskip}{0pt plus 5cm}typedef \hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{docid} \hyperlink{types_8h_b4166dca4ac15d88c933bbb8e0d55d23}{doccount}}}
\label{types_8h_b4166dca4ac15d88c933bbb8e0d55d23}


Type for counts of documents. 

\hypertarget{types_8h_d8243c2a1cbe7e9f88ab4704233f531e}{
\index{types.h@{types.h}!doccount_diff@{doccount\_\-diff}}
\index{doccount_diff@{doccount\_\-diff}!types.h@{types.h}}
\subsubsection[doccount\_\-diff]{\setlength{\rightskip}{0pt plus 5cm}typedef int \hyperlink{types_8h_d8243c2a1cbe7e9f88ab4704233f531e}{doccount\_\-diff}}}
\label{types_8h_d8243c2a1cbe7e9f88ab4704233f531e}


Type for signed difference between counts of documents. 

\hypertarget{types_8h_53073891e45d892a8d8a5d8f87f41402}{
\index{types.h@{types.h}!docid@{docid}}
\index{docid@{docid}!types.h@{types.h}}
\subsubsection[docid]{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned int \hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{docid}}}
\label{types_8h_53073891e45d892a8d8a5d8f87f41402}


A unique id for a document. 

Document ids start at 1. A zero docid isn't valid, and may be used to indicate \char`\"{}no document\char`\"{}. \hypertarget{types_8h_7272583216038f810105df7dc927723c}{
\index{types.h@{types.h}!doclength@{doclength}}
\index{doclength@{doclength}!types.h@{types.h}}
\subsubsection[doclength]{\setlength{\rightskip}{0pt plus 5cm}typedef double \hyperlink{types_8h_7272583216038f810105df7dc927723c}{doclength}}}
\label{types_8h_7272583216038f810105df7dc927723c}


Type for (normalised) lengths of documents. 

\hypertarget{types_8h_d9213278aaed43f1ab0110c87a6b7476}{
\index{types.h@{types.h}!percent@{percent}}
\index{percent@{percent}!types.h@{types.h}}
\subsubsection[percent]{\setlength{\rightskip}{0pt plus 5cm}typedef int \hyperlink{types_8h_d9213278aaed43f1ab0110c87a6b7476}{percent}}}
\label{types_8h_d9213278aaed43f1ab0110c87a6b7476}


A percentage weight, for a term or document. 

\hypertarget{types_8h_6979d98ebbe67186bd31e5ee2a7585cb}{
\index{types.h@{types.h}!termcount@{termcount}}
\index{termcount@{termcount}!types.h@{types.h}}
\subsubsection[termcount]{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned int \hyperlink{types_8h_6979d98ebbe67186bd31e5ee2a7585cb}{termcount}}}
\label{types_8h_6979d98ebbe67186bd31e5ee2a7585cb}


Type for counts of terms (eg, wdf, wqf). 

\hypertarget{types_8h_992fbdbe6bdbfc25fb14ffcd6a83692a}{
\index{types.h@{types.h}!termcount_diff@{termcount\_\-diff}}
\index{termcount_diff@{termcount\_\-diff}!types.h@{types.h}}
\subsubsection[termcount\_\-diff]{\setlength{\rightskip}{0pt plus 5cm}typedef int \hyperlink{types_8h_992fbdbe6bdbfc25fb14ffcd6a83692a}{termcount\_\-diff}}}
\label{types_8h_992fbdbe6bdbfc25fb14ffcd6a83692a}


Type for signed difference between counts of terms. 

\hypertarget{types_8h_5cdae0172ef811a7c08017eb4429c311}{
\index{types.h@{types.h}!termpos@{termpos}}
\index{termpos@{termpos}!types.h@{types.h}}
\subsubsection[termpos]{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned int \hyperlink{types_8h_5cdae0172ef811a7c08017eb4429c311}{termpos}}}
\label{types_8h_5cdae0172ef811a7c08017eb4429c311}


Type for term positions within documents. 

These start at 1. A value of 0 means that the positional information is not available for that term. \hypertarget{types_8h_800ebcc9f3f0de991f2755f28cca8ea7}{
\index{types.h@{types.h}!termpos_diff@{termpos\_\-diff}}
\index{termpos_diff@{termpos\_\-diff}!types.h@{types.h}}
\subsubsection[termpos\_\-diff]{\setlength{\rightskip}{0pt plus 5cm}typedef int \hyperlink{types_8h_800ebcc9f3f0de991f2755f28cca8ea7}{termpos\_\-diff}}}
\label{types_8h_800ebcc9f3f0de991f2755f28cca8ea7}


Type for signed difference between term positions. 

\hypertarget{types_8h_d963f87f47b8bb630701c1128f204aaf}{
\index{types.h@{types.h}!timeout@{timeout}}
\index{timeout@{timeout}!types.h@{types.h}}
\subsubsection[timeout]{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned int \hyperlink{types_8h_d963f87f47b8bb630701c1128f204aaf}{timeout}}}
\label{types_8h_d963f87f47b8bb630701c1128f204aaf}


Type for specifying a timeout. 

This refers to a time in microseconds: ie. a timeout value of 1000000 corresponds to a timeout of 1 second. \hypertarget{types_8h_f24564a367ebbc8f80cf9a1dbd1e81fd}{
\index{types.h@{types.h}!valueno@{valueno}}
\index{valueno@{valueno}!types.h@{types.h}}
\subsubsection[valueno]{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned int \hyperlink{types_8h_f24564a367ebbc8f80cf9a1dbd1e81fd}{valueno}}}
\label{types_8h_f24564a367ebbc8f80cf9a1dbd1e81fd}


Type for referring to the number of a value in document. 

\hypertarget{types_8h_609c717d551f258db5cc883c3861b645}{
\index{types.h@{types.h}!valueno_diff@{valueno\_\-diff}}
\index{valueno_diff@{valueno\_\-diff}!types.h@{types.h}}
\subsubsection[valueno\_\-diff]{\setlength{\rightskip}{0pt plus 5cm}typedef int \hyperlink{types_8h_609c717d551f258db5cc883c3861b645}{valueno\_\-diff}}}
\label{types_8h_609c717d551f258db5cc883c3861b645}


Type for signed difference between two valueno-s. 

\hypertarget{types_8h_167860ee249b702eb746dca0d245f808}{
\index{types.h@{types.h}!weight@{weight}}
\index{weight@{weight}!types.h@{types.h}}
\subsubsection[weight]{\setlength{\rightskip}{0pt plus 5cm}typedef double \hyperlink{types_8h_167860ee249b702eb746dca0d245f808}{weight}}}
\label{types_8h_167860ee249b702eb746dca0d245f808}


A calculated weight, for a term or document.