This is an automated email from the ASF dual-hosted git repository. nightowl888 pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit 8c404e914996f32c39bb19a6932d1d7a525749fe Author: Shad Storhaug <[email protected]> AuthorDate: Tue Mar 30 19:41:26 2021 +0700 docs: Lucene.Net.Facet: Fixed broken formatting and links (see #284, #300) --- src/Lucene.Net.Facet/SortedSet/package.md | 4 ++-- src/Lucene.Net.Facet/Taxonomy/package.md | 11 ++++------- src/Lucene.Net.Facet/package.md | 12 ++++++++---- 3 files changed, 14 insertions(+), 13 deletions(-) diff --git a/src/Lucene.Net.Facet/SortedSet/package.md b/src/Lucene.Net.Facet/SortedSet/package.md index b62ecbb..8569652 100644 --- a/src/Lucene.Net.Facet/SortedSet/package.md +++ b/src/Lucene.Net.Facet/SortedSet/package.md @@ -1,4 +1,4 @@ ---- +--- uid: Lucene.Net.Facet.SortedSet summary: *content --- @@ -20,4 +20,4 @@ summary: *content limitations under the License. --> -Provides faceting capabilities over facets that were indexed with <xref:Lucene.Net.Facet.Sortedset.SortedSetDocValuesFacetField>. +Provides faceting capabilities over facets that were indexed with <xref:Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetField>. diff --git a/src/Lucene.Net.Facet/Taxonomy/package.md b/src/Lucene.Net.Facet/Taxonomy/package.md index 4c91b30..98d5dd2 100644 --- a/src/Lucene.Net.Facet/Taxonomy/package.md +++ b/src/Lucene.Net.Facet/Taxonomy/package.md @@ -1,4 +1,4 @@ ---- +--- uid: Lucene.Net.Facet.Taxonomy summary: *content --- @@ -22,8 +22,7 @@ summary: *content # Taxonomy of Categories - Facets are defined using a hierarchy of categories, known as a _Taxonomy_. - For example, the taxonomy of a book store application might have the following structure: +Facets are defined using a hierarchy of categories, known as a _Taxonomy_. For example, the taxonomy of a book store application might have the following structure: * Author @@ -41,7 +40,5 @@ summary: *content * 2009 - The _Taxonomy_ translates category-paths into interger identifiers (often termed _ordinals_) and vice versa. - The category `Author/Mark Twain` adds two nodes to the taxonomy: `Author` and - `Author/Mark Twain`, each is assigned a different ordinal. The taxonomy maintains the invariant that a - node always has an ordinal that is < all its children. \ No newline at end of file +The _Taxonomy_ translates category-paths into interger identifiers (often termed _ordinals_) and vice versa. +The category `Author/Mark Twain` adds two nodes to the taxonomy: `Author` and `Author/Mark Twain`, each is assigned a different ordinal. The taxonomy maintains the invariant that a node always has an ordinal that is < all its children. \ No newline at end of file diff --git a/src/Lucene.Net.Facet/package.md b/src/Lucene.Net.Facet/package.md index b2bdfb2..3b54f41 100644 --- a/src/Lucene.Net.Facet/package.md +++ b/src/Lucene.Net.Facet/package.md @@ -1,4 +1,4 @@ ---- +--- uid: Lucene.Net.Facet summary: *content --- @@ -20,10 +20,14 @@ summary: *content limitations under the License. --> -# faceted search +# Lucene.Net.Facet Faceted Search + + This module provides multiple methods for computing facet counts and value aggregations: - This module provides multiple methods for computing facet counts and value aggregations: * Taxonomy-based methods rely on a separate taxonomy index to map hierarchical facet paths to global int ordinals for fast counting at search time; these methods can compute counts ((<xref:Lucene.Net.Facet.Taxonomy.FastTaxonomyFacetCounts>, <xref:Lucene.Net.Facet.Taxonomy.TaxonomyFacetCounts>) aggregate long or double values <xref:Lucene.Net.Facet.Taxonomy.TaxonomyFacetSumIntAssociations>, <xref:Luc [...] +* Taxonomy-based methods rely on a separate taxonomy index to map hierarchical facet paths to global int ordinals for fast counting at search time; these methods can compute counts ((<xref:Lucene.Net.Facet.Taxonomy.FastTaxonomyFacetCounts>, <xref:Lucene.Net.Facet.Taxonomy.TaxonomyFacetCounts>) aggregate long or double values <xref:Lucene.Net.Facet.Taxonomy.TaxonomyFacetSumInt32Associations>, <xref:Lucene.Net.Facet.Taxonomy.TaxonomyFacetSumSingleAssociations>, <xref:Lucene.Net.Facet.Taxon [...] +* Sorted-set doc values method does not require a separate taxonomy index, and computes counts based on sorted set doc values fields (<xref:Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetCounts>). Add <xref:Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetField> to your documents at index time to use sorted set facet counts. +* Range faceting <xref:Lucene.Net.Facet.Range.Int64RangeFacetCounts>, <xref:Lucene.Net.Facet.Range.DoubleRangeFacetCounts> compute counts for a dynamic numeric range from a provided <xref:Lucene.Net.Queries.Function.ValueSource> (previously indexed numeric field, or a dynamic expression such as distance). At search time you first run your search, but pass a <xref:Lucene.Net.Facet.FacetsCollector> to gather all hits (and optionally, scores for each hit). Then, instantiate whichever facet methods you'd like to use to compute aggregates. Finally, all methods implement a common <xref:Lucene.Net.Facet.Facets> base API that you use to obtain specific facet counts. - The various [#search](xref:Lucene.Net.Facet.FacetsCollector) utility methods are useful for doing an "ordinary" search (sorting by score, or by a specified Sort) but also collecting into a <xref:Lucene.Net.Facet.FacetsCollector> for subsequent faceting. \ No newline at end of file + The various [FacetsCollector.Search()](xref:Lucene.Net.Facet.FacetsCollector#Lucene_Net_Facet_FacetsCollector_Search_Lucene_Net_Search_IndexSearcher_Lucene_Net_Search_Query_Lucene_Net_Search_Filter_System_Int32_Lucene_Net_Search_ICollector_) utility methods are useful for doing an "ordinary" search (sorting by score, or by a specified Sort) but also collecting into a <xref:Lucene.Net.Facet.FacetsCollector> for subsequent faceting. \ No newline at end of file
