C# Class Lucene.Net.Analysis.Shingle.ShingleFilter.CircularSequence

An instance of this class is used to maintain the number of input stream tokens that will be used to compose the next unigram or shingle: #gramSize.

gramSize will take on values from the circular sequence { [ 1, ] #minShingleSize [ , ... , #maxShingleSize ] }.

1 is included in the circular sequence only if #outputUnigrams = true.

Datei anzeigen Open project: apache/lucenenet

Public Methods

Method Description
CircularSequence ( ShingleFilter outerInstance ) : System
advance ( ) : void

Increments this circular number's value to the next member in the circular sequence gramSize will take on values from the circular sequence { [ 1, ] #minShingleSize [ , ... , #maxShingleSize ] }.

1 is included in the circular sequence only if #outputUnigrams = true.

atMinValue ( ) : bool

Returns true if the current value is the first member of the circular sequence.

If #outputUnigrams = true, the first member of the circular sequence will be 1; otherwise, it will be #minShingleSize.

reset ( ) : void

Sets this circular number's value to the first member of the circular sequence

gramSize will take on values from the circular sequence { [ 1, ] #minShingleSize [ , ... , #maxShingleSize ] }.

1 is included in the circular sequence only if #outputUnigrams = true.

Method Details

CircularSequence() public method

public CircularSequence ( ShingleFilter outerInstance ) : System
outerInstance ShingleFilter
return System

advance() public method

Increments this circular number's value to the next member in the circular sequence gramSize will take on values from the circular sequence { [ 1, ] #minShingleSize [ , ... , #maxShingleSize ] }.

1 is included in the circular sequence only if #outputUnigrams = true.

public advance ( ) : void
return void

atMinValue() public method

Returns true if the current value is the first member of the circular sequence.

If #outputUnigrams = true, the first member of the circular sequence will be 1; otherwise, it will be #minShingleSize.

public atMinValue ( ) : bool
return bool

reset() public method

Sets this circular number's value to the first member of the circular sequence

gramSize will take on values from the circular sequence { [ 1, ] #minShingleSize [ , ... , #maxShingleSize ] }.

1 is included in the circular sequence only if #outputUnigrams = true.

public reset ( ) : void
return void