MySQL 8.0.29
Source Code Documentation
ftdefs.h
Go to the documentation of this file.
1/* Copyright (c) 2000, 2021, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is also distributed with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have included with MySQL.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License, version 2.0, for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22
23/* Written by Sergei A. Golubchik, who has a shared copyright to this code */
24
25/**
26 @file storage/myisam/ftdefs.h
27 Some definitions for full-text indices.
28*/
29
30#include <math.h>
31#include <mysql/plugin.h>
32
33#include "m_ctype.h"
34#include "my_tree.h"
37
38#define true_word_char(ctype, character) \
39 ((ctype) & (_MY_U | _MY_L | _MY_NMR) || (character) == '_')
40
41#define FT_MAX_WORD_LEN_FOR_SORT 31
42
43#define FTPARSER_MEMROOT_ALLOC_SIZE 65536
44
45/* Interested readers may consult SMART
46 (ftp://ftp.cs.cornell.edu/pub/smart/smart.11.0.tar.Z)
47 for an excellent implementation of vector space model we use.
48 It also demonstrate the usage of different weghting techniques.
49 This code, though, is completely original and is not based on the
50 SMART code but was in some cases inspired by it.
51
52 NORM_PIVOT was taken from the article
53 A.Singhal, C.Buckley, M.Mitra, "Pivoted Document Length Normalization",
54 ACM SIGIR'96, 21-29, 1996
55 */
56
57#define LWS_FOR_QUERY LWS_TF
58#define LWS_IN_USE LWS_LOG
59#define PRENORM_IN_USE PRENORM_AVG
60#define NORM_IN_USE NORM_PIVOT
61#define GWS_IN_USE GWS_PROB
62/*==============================================================*/
63#define LWS_TF (count)
64#define LWS_BINARY (count > 0)
65#define LWS_SQUARE (count * count)
66#define LWS_LOG (count ? (log((double)count) + 1) : 0)
67/*--------------------------------------------------------------*/
68#define PRENORM_NONE (p->weight)
69#define PRENORM_MAX (p->weight / docstat.max)
70#define PRENORM_AUG (0.4 + 0.6 * p->weight / docstat.max)
71#define PRENORM_AVG (p->weight / docstat.sum * docstat.uniq)
72#define PRENORM_AVGLOG \
73 ((1 + log(p->weight)) / (1 + log(docstat.sum / docstat.uniq)))
74/*--------------------------------------------------------------*/
75#define NORM_NONE (1)
76#define NORM_SUM (docstat.nsum)
77#define NORM_COS (sqrt(docstat.nsum2))
78
79#define PIVOT_VAL (0.0115)
80#define NORM_PIVOT (1 + PIVOT_VAL * docstat.uniq)
81/*---------------------------------------------------------------*/
82#define GWS_NORM (1 / sqrt(sum2))
83#define GWS_GFIDF (sum / doc_cnt)
84/* Mysterious, but w/o (double) GWS_IDF performs better :-o */
85#define GWS_IDF log(aio->info->state->records / doc_cnt)
86#define GWS_IDF1 log((double)aio->info->state->records / doc_cnt)
87#define GWS_PROB \
88 ((aio->info->state->records > doc_cnt) \
89 ? log(((double)(aio->info->state->records - doc_cnt)) / doc_cnt) \
90 : 0)
91#define GWS_FREQ (1.0 / doc_cnt)
92#define GWS_SQUARED pow(log((double)aio->info->state->records / doc_cnt), 2)
93#define GWS_CUBIC pow(log((double)aio->info->state->records / doc_cnt), 3)
94#define GWS_ENTROPY \
95 (1 - (suml / sum - log(sum)) / log(aio->info->state->records))
96/*=================================================================*/
97
98/* Boolean search operators */
99#define FTB_YES (ft_boolean_syntax[0])
100#define FTB_EGAL (ft_boolean_syntax[1])
101#define FTB_NO (ft_boolean_syntax[2])
102#define FTB_INC (ft_boolean_syntax[3])
103#define FTB_DEC (ft_boolean_syntax[4])
104#define FTB_LBR (ft_boolean_syntax[5])
105#define FTB_RBR (ft_boolean_syntax[6])
106#define FTB_NEG (ft_boolean_syntax[7])
107#define FTB_TRUNC (ft_boolean_syntax[8])
108#define FTB_LQUOT (ft_boolean_syntax[10])
109#define FTB_RQUOT (ft_boolean_syntax[11])
110
111#ifdef __cplusplus
112extern "C" {
113#endif
114
115struct FT_WORD {
116 uchar *pos;
117 uint len;
118 double weight;
119};
120
121int is_stopword(char *word, uint len);
122
124
127uchar ft_simple_get_word(const CHARSET_INFO *, uchar **, const uchar *,
128 FT_WORD *, bool);
129
130typedef struct _st_ft_seg_iterator {
133 const uchar *rec, *pos;
135
139
140void ft_parse_init(TREE *, const CHARSET_INFO *);
141int ft_parse(TREE *, uchar *, int, struct st_mysql_ftparser *parser,
145uint _mi_ft_parse(TREE *, MI_INFO *, uint, const uchar *,
147
150 const CHARSET_INFO *);
151
152extern const struct _ft_vft _ft_vft_nlq;
153int ft_nlq_read_next(FT_INFO *, char *);
159
160extern const struct _ft_vft _ft_vft_boolean;
161
162int ft_boolean_read_next(FT_INFO *, char *);
168
171 uint keynr,
172 uint paramnr);
174
175#ifdef __cplusplus
176} // extern "C"
177#endif
FT_WORD * ft_linearize(TREE *, MEM_ROOT *)
Definition: ft_parser.cc:65
void ftparser_call_deinitializer(MI_INFO *info)
Definition: ft_parser.cc:361
void ft_parse_init(TREE *, const CHARSET_INFO *)
Definition: ft_parser.cc:242
FT_INFO * ft_init_nlq_search(MI_INFO *, uint, uchar *, uint, uint, uchar *)
Definition: ft_nlq_search.cc:217
int ft_nlq_read_next(FT_INFO *, char *)
Definition: ft_nlq_search.cc:306
const struct _ft_vft _ft_vft_boolean
Definition: ft_static.cc:59
const struct _ft_vft _ft_vft_nlq
Definition: ft_static.cc:56
int ft_parse(TREE *, uchar *, int, struct st_mysql_ftparser *parser, MYSQL_FTPARSER_PARAM *, MEM_ROOT *)
Definition: ft_parser.cc:288
float ft_nlq_find_relevance(FT_INFO *, uchar *, uint)
Definition: ft_nlq_search.cc:329
void ft_boolean_close_search(FT_INFO *)
Definition: ft_boolean_search.cc:939
void _mi_ft_segiterator_dummy_init(const uchar *, uint, FT_SEG_ITERATOR *)
Definition: ft_update.cc:47
void ft_nlq_close_search(FT_INFO *)
Definition: ft_nlq_search.cc:354
float ft_boolean_find_relevance(FT_INFO *, uchar *, uint)
Definition: ft_boolean_search.cc:882
uchar ft_get_word(const CHARSET_INFO *, uchar **, uchar *, FT_WORD *, MYSQL_FTPARSER_BOOLEAN_INFO *)
Definition: ft_parser.cc:118
void ft_nlq_reinit_search(FT_INFO *)
Definition: ft_nlq_search.cc:361
float ft_nlq_get_relevance(FT_INFO *)
Definition: ft_nlq_search.cc:356
my_off_t ft_nlq_get_docid(FT_INFO *)
MYSQL_FTPARSER_PARAM * ftparser_call_initializer(MI_INFO *info, uint keynr, uint paramnr)
Definition: ft_parser.cc:332
uint _mi_ft_parse(TREE *, MI_INFO *, uint, const uchar *, MYSQL_FTPARSER_PARAM *, MEM_ROOT *)
Definition: ft_update.cc:100
FT_WORD * _mi_ft_parserecord(MI_INFO *, uint, const uchar *, MEM_ROOT *)
Definition: ft_update.cc:119
struct _st_ft_seg_iterator FT_SEG_ITERATOR
FT_INFO * ft_init_boolean_search(MI_INFO *, uint, uchar *, uint, const CHARSET_INFO *)
Definition: ft_boolean_search.cc:514
int is_stopword(char *word, uint len)
Definition: ft_stopwords.cc:122
uint _mi_ft_segiterator(FT_SEG_ITERATOR *)
Definition: ft_update.cc:66
my_off_t ft_boolean_get_docid(FT_INFO *)
MYSQL_FTPARSER_PARAM * ftparser_alloc_param(MI_INFO *info)
Definition: ft_parser.cc:310
uchar ft_simple_get_word(const CHARSET_INFO *, uchar **, const uchar *, FT_WORD *, bool)
Definition: ft_parser.cc:208
void _mi_ft_segiterator_init(MI_INFO *, uint, const uchar *, FT_SEG_ITERATOR *)
Definition: ft_update.cc:38
int ft_boolean_read_next(FT_INFO *, char *)
Definition: ft_boolean_search.cc:741
uint _ft_make_key(MI_INFO *, uint, uchar *, FT_WORD *, my_off_t)
Definition: ft_update.cc:264
float ft_boolean_get_relevance(FT_INFO *)
Definition: ft_boolean_search.cc:948
void ft_boolean_reinit_search(FT_INFO *)
Definition: ft_boolean_search.cc:953
Some definitions for full-text indices.
A better implementation of the UNIX ctype(3) library.
ulonglong my_off_t
Definition: my_inttypes.h:71
unsigned char uchar
Definition: my_inttypes.h:51
Log info(cout, "NOTE")
struct Parser parser
Code for handling of priority queues.
Definition: m_ctype.h:354
Definition: ft_global.h:71
FTS query token.
Definition: fts0tokenize.h:57
uint len
word len
Definition: fts0tokenize.h:59
double weight
word weight, unused in innodb
Definition: fts0tokenize.h:60
uchar * pos
word start pointer
Definition: fts0tokenize.h:58
Definition: my_compare.h:59
The MEM_ROOT is a simple arena, where allocations are carved out of larger blocks.
Definition: my_alloc.h:82
Definition: myisamdef.h:251
Definition: plugin_ftparser.h:128
Definition: plugin_ftparser.h:190
Definition: my_tree.h:67
Definition: ft_global.h:47
Definition: ftdefs.h:130
uint len
Definition: ftdefs.h:131
HA_KEYSEG * seg
Definition: ftdefs.h:132
const uchar * rec
Definition: ftdefs.h:133
uint num
Definition: ftdefs.h:131
const uchar * pos
Definition: ftdefs.h:133
Definition: plugin_ftparser.h:211
unsigned int uint
Definition: uca-dump.cc:29