Sets the boost factor hits on this field. This value will be
multiplied into the score of all hits on this this field of this
document.
The boost is multiplied by {@link Lucene.Net.Documents.Document#GetBoost()} of the document
containing this field. If a document has multiple fields with the same
name, all such values are multiplied together. This product is then
used to compute the norm factor for the field. By
default, in the {@link
Lucene.Net.Search.Similarity#ComputeNorm(String,
FieldInvertState)} method, the boost value is multipled
by the {@link
Lucene.Net.Search.Similarity#LengthNorm(String,
int)} and then
rounded by {@link Lucene.Net.Search.Similarity#EncodeNorm(float)} before it is stored in the
index. One should attempt to ensure that this product does not overflow
the range of that encoding.
Namespace: Lucene.Net.DocumentsAssembly: Lucene.Net (in Lucene.Net.dll) Version: 2.9.4.1
Syntax
C# |
---|
public virtual void SetBoost( float boost ) |
Visual Basic |
---|
Public Overridable Sub SetBoost ( _ boost As Single _ ) |
Visual C++ |
---|
public: virtual void SetBoost( float boost ) |
Parameters
- boost
- Type: System..::..Single
[Missing <param name="boost"/> documentation for "M:Lucene.Net.Documents.AbstractField.SetBoost(System.Single)"]