Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

include/xapian/types.h File Reference

Common types used. More...

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Typedefs

typedef unsigned int docid
 A unique id for a document. More...

typedef docid doccount
 Type for counts of documents. More...

typedef int doccount_diff
 Type for signed difference between counts of documents. More...

typedef unsigned int termcount
 Type for counts of terms (eg, wdf, wqf). More...

typedef int termcount_diff
 Type for signed difference between counts of terms. More...

typedef unsigned int termpos
 Type for term positions within documents. More...

typedef int termpos_diff
 Type for signed difference between term positions. More...

typedef double doclength
 Type for (normalised) lengths of documents. More...

typedef unsigned int valueno
 Type for referring to the number of a value in document. More...

typedef int valueno_diff
 Type for signed difference between two valueno-s. More...

typedef double weight
 A calculated weight, for a term or document. More...

typedef int percent
 A percentage weight, for a term or document. More...

typedef unsigned int timeout
 Type for specifying a timeout. More...


Detailed Description

Common types used.

Copyright 1999,2000,2001 BrightStation PLC Copyright 2002 Ananova Ltd Copyright 2002 Olly Betts

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


Typedef Documentation

typedef docid doccount
 

Type for counts of documents.

typedef int doccount_diff
 

Type for signed difference between counts of documents.

typedef unsigned int docid
 

A unique id for a document.

Document ids start at 1. A zero docid isn't valid, and may be used to indicate "no document".

typedef double doclength
 

Type for (normalised) lengths of documents.

typedef int percent
 

A percentage weight, for a term or document.

typedef unsigned int termcount
 

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

typedef int termcount_diff
 

Type for signed difference between counts of terms.

typedef unsigned int termpos
 

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.

typedef int termpos_diff
 

Type for signed difference between term positions.

typedef unsigned int timeout
 

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.

typedef unsigned int valueno
 

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

typedef int valueno_diff
 

Type for signed difference between two valueno-s.

typedef double weight
 

A calculated weight, for a term or document.


Documentation for Xapian (version 0.6.3).
Generated on 24 Dec 2002 by Doxygen 1.2.15.