ibi Patterns .NET API
Loading...
Searching...
No Matches
NetricsServerInterface.NetricsPsiEncoding Class Reference

Define encodings for the PSI prefilter. More...

Public Member Functions

  NetricsPsiEncoding (String[] fields, bool[] bwd_flags, int[] match_minima, int num_sfxd_fields, NetricsTable.PsiDensity? density)
  This class is used to define an encoding for the PSI pre-filter.
 

Detailed Description

Define encodings for the PSI prefilter.

Objects of this class are used to define the encodings for the PSI prefilter. If you use the PSI prefilter and do not define any encodings a default set of encodings is created. These default encodings are good for most applications but some applications may require encodings be defined explicitly to achieve the desired performance and accuracy.

It is recommended that you contact ibi for technical assistence before attempting to define encodings.

Constructor & Destructor Documentation

◆ NetricsPsiEncoding()

NetricsServerInterface.NetricsPsiEncoding.NetricsPsiEncoding ( String[]  fields,
bool[]  bwd_flags,
int[]  match_minima,
int  num_sfxd_fields,
NetricsTable::PsiDensity density 
)
inline

This class is used to define an encoding for the PSI pre-filter.

It is recommended that you contact your ibi support representative for advice on which SORT encodings to use for your specific application.

Parameters
fields A list of field names. The first field name will be the primary sort key, the second field will be secondary, and so on.
bwd_flags Fields can also be sorted backwards (from the last characters in the field to the first). Important fields can and should be used as primary sort keys in both their forward and reverse directions. The backwards_fields array should be the same length as the encodings array and the sub-array at each position in the two primary arrays should also be the same length. In this way, there is a flag in the bwd_flags array for each of the fields in the encoding. The flag is true if the field is to be sorted in the backwards direction and false for the forward direction.
match_minima Specifies a minimum number of characters to match for each field in the encoding. During a PSI pre-filter scan for a query, scanning of the encoding stops if none of the minima are met.
num_sfxd_fields Number of to fields to suffix in the encoding. Currently only 0 and 1 are supported.
density Specifies the density of suffixes in the PSI pre-filter index. See NetricsTable.PsiDensity