[jira] Created: (LUCENE-1872) Improve javadocs for Numeric*

classic Classic list List threaded Threaded
31 messages Options
12
Reply | Threaded
Open this post in threaded view
|

[jira] Created: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
Improve javadocs for Numeric*
-----------------------------

                 Key: LUCENE-1872
                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
             Project: Lucene - Java
          Issue Type: Improvement
            Reporter: Michael McCandless
            Assignee: Michael McCandless
            Priority: Minor
             Fix For: 2.9


I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749095#action_12749095 ]

Michael McCandless commented on LUCENE-1872:
--------------------------------------------

Can someone confirm that this is technically accurate (I've added it to the javadoc for NumericField):

bq. You may add the same field name as a NumericField to the same document more than once. Range querying and filtering will be the logical OR of all values, and sorting will sort according to the first value added.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749097#action_12749097 ]

Uwe Schindler commented on LUCENE-1872:
---------------------------------------

This is correct (first part), you can add a field more than once and it really works (there is a test about that). The results are the same like with a normal range query (so the trie terms do not interfere between each other).

About the second one: Sorting is not different from other numeric multi-value fields (in contrast to StringIndex where only one value/doc is allowed). The univerter assigns a value to each document. As it overrides values previously assigned to the document when iterating over all terms in the field, the last term would be the one saved in the FieldCache. So you would sort against the largest value per doc (because the smaller values are overridden by the larger ones in the field cache).

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Issue Comment Edited: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749097#action_12749097 ]

Uwe Schindler edited comment on LUCENE-1872 at 8/29/09 2:40 AM:
----------------------------------------------------------------

This is correct (first part), you can add a field more than once and it really works (there is a test about that: TestMultiValuedNumericRangeQuery). The results are the same like with a normal range query (so the trie terms do not interfere between each other). See SOLR-1322

I think your sentence is a little bit complicated. It would hit all documents in the range, where at least one of the values of a multi-valued doc is in the range.

About the second one: Sorting is not different from other numeric multi-value fields (in contrast to StringIndex where only one value/doc is allowed). The univerter assigns a value to each document. As it overrides values previously assigned to the document when iterating over all terms in the field, the last term would be the one saved in the FieldCache. So you would sort against the largest value per doc (because the smaller values are overridden by the larger ones in the field cache).

      was (Author: thetaphi):
    This is correct (first part), you can add a field more than once and it really works (there is a test about that). The results are the same like with a normal range query (so the trie terms do not interfere between each other).

About the second one: Sorting is not different from other numeric multi-value fields (in contrast to StringIndex where only one value/doc is allowed). The univerter assigns a value to each document. As it overrides values previously assigned to the document when iterating over all terms in the field, the last term would be the one saved in the FieldCache. So you would sort against the largest value per doc (because the smaller values are overridden by the larger ones in the field cache).
 

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749100#action_12749100 ]

Michael McCandless commented on LUCENE-1872:
--------------------------------------------

bq. About the second one: Sorting is not different from other numeric multi-value fields (in contrast to StringIndex where only one value/doc is allowed). The univerter assigns a value to each document. As it overrides values previously assigned to the document when iterating over all terms in the field, the last term would be the one saved in the FieldCache. So you would sort against the largest value per doc (because the smaller values are overridden by the larger ones in the field cache).

Ahh right.

I'm confused on why it's the "largest" value?  EG if I add 4, 17, 10 as a NumericField "x" on my doc, when I then try to sort, wouldn't 10 "win" since it was added last to the document?

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749102#action_12749102 ]

Uwe Schindler commented on LUCENE-1872:
---------------------------------------

bq. I'm confused on why it's the "largest" value? EG if I add 4, 17, 10 as a NumericField "x" on my doc, when I then try to sort, wouldn't 10 "win" since it was added last to the document?

Because of the uninverter. It iterates over all terms, starting from the lowest one in the field. When he comes to term 4, it would add it to the field cache at the document's position. The same with 10 and then 17. Because the TermEnum lists 17 at last, it would win:

{code}
long[] retArray = null;
TermDocs termDocs = reader.termDocs();
TermEnum termEnum = reader.terms (new Term(field));
try {
  do {
    Term term = termEnum.term();
    if (term==null || term.field() != field) break;
    long termval = parser.parseLong(term.text());
    if (retArray == null) // late init
      retArray = new long[reader.maxDoc()];
    termDocs.seek (termEnum);
    while (termDocs.next()) {
      retArray[termDocs.doc()] = termval;
    }
  } while (termEnum.next());
} catch (StopFillCacheException stop) {
} finally {
  termDocs.close();
  termEnum.close();
}
if (retArray == null) // no values
  retArray = new long[reader.maxDoc()];
{code}

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749106#action_12749106 ]

Michael McCandless commented on LUCENE-1872:
--------------------------------------------

bq. Because of the uninverter.

Ahh right!

I think it's best to document that the effect of sorting is undefined/not guaranteed, but filtering/searching by range is defined.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749107#action_12749107 ]

Uwe Schindler commented on LUCENE-1872:
---------------------------------------

Thank you at all for looking after the documentation! A native speaker is always better than my "frankish" English (as my colleague call it). :)

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749111#action_12749111 ]

Michael McCandless commented on LUCENE-1872:
--------------------------------------------

bq. Thank you at all for looking after the documentation! A native speaker is always better than my "frankish" English (as my colleague call it).

No problem!  This is how open source works :)  It's great.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Updated: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

     [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael McCandless updated LUCENE-1872:
---------------------------------------

    Attachment: LUCENE-1872.patch

Only javadoc fixes, mostly for Numeric* but also some small fixes to a few other classes.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749113#action_12749113 ]

Uwe Schindler commented on LUCENE-1872:
---------------------------------------

Will we mark it as experimental or not? In some classes you remove the experimental warning, in others not. I will review it more detailed later!

By the way, I also reviewd the LIA chapter and have also seen the reference to DateTools (will send you my updates soon). ate to a String with a special date resolution and then convertin back to numeric is somehow ineffective. When indexing only hour resolution, I would take Date.getTime() / 3600L / 1000L.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749114#action_12749114 ]

Uwe Schindler commented on LUCENE-1872:
---------------------------------------

Maybe you could copy some of your explanations also to NumericTokenStream, e.g. the example. In the original, both classes had similar introduction texts.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749117#action_12749117 ]

Michael McCandless commented on LUCENE-1872:
--------------------------------------------

bq. Will we mark it as experimental or not?

Yes, I think we should keep the experimental warning.  I didn't mean to remove any -- I'll make sure they're all still there.

bq. By the way, I also reviewd the LIA chapter and have also seen the reference to DateTools (will send you my updates soon)

Excellent, thanks!

bq.  ate to a String with a special date resolution and then convertin back to numeric is somehow ineffective. When indexing only hour resolution, I would take Date.getTime() / 3600L / 1000L.

True, and that'll work for DAY as well, but not for MONTH / YEAR resolution.

bq. Maybe you could copy some of your explanations also to NumericTokenStream, e.g. the example. In the original, both classes had similar introduction texts.

OK I'll update NumericTokenStream too.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Updated: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

     [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael McCandless updated LUCENE-1872:
---------------------------------------

    Attachment: LUCENE-1872.patch

New rev.

As far as I can tell, I didn't lose any of the experimental warnings -- Uwe where did you see that?

I worked on NumericTokenStream's javadocs too.

Finally, I removed reference to DateTools entirely and suggested either quantizing by dividing getTime()'s returned result, or, using Date's getters (getYear, getMonth, etc.) to construct a numeric value.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch, LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749127#action_12749127 ]

Uwe Schindler commented on LUCENE-1872:
---------------------------------------

bq. As far as I can tell, I didn't lose any of the experimental warnings - Uwe where did you see that?

My fault. I did not see that you moved the warning to the top in NumericRangeQuery.

Looks good.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch, LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749132#action_12749132 ]

Uwe Schindler commented on LUCENE-1872:
---------------------------------------

One small thing (I found this also in the LIA chapter):
"Trie" is the whole "prefix tree". So "trie" means the whole list of different precision terms for one numeric value. You have this explanation which suggests one trie is one term:
{code}
+ * <p>Within lucene, each numeric value is indexed as
+ * multiple encoded terms representing larger and larger
+ * pre-defined brackets called <em>trie</em>s.  The step
+ * size between each successive trie is called the
+ * <code>precisionStep</code> in this API.  Smaller
{code}

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch, LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Issue Comment Edited: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749132#action_12749132 ]

Uwe Schindler edited comment on LUCENE-1872 at 8/29/09 6:39 AM:
----------------------------------------------------------------

One small thing (I found this also in the LIA chapter):
"Trie" is the whole "prefix tree". So "trie" means the whole list of different precision terms for one numeric value. You have this explanation which suggests one trie is one term:
{code}
+ * <p>Within lucene, each numeric value is indexed as
+ * multiple encoded terms representing larger and larger
+ * pre-defined brackets called <em>trie</em>s.  The step
+ * size between each successive trie is called the
+ * <code>precisionStep</code> in this API.  Smaller
{code}
There should also be the explanation that the precStep is in "bits".

      was (Author: thetaphi):
    One small thing (I found this also in the LIA chapter):
"Trie" is the whole "prefix tree". So "trie" means the whole list of different precision terms for one numeric value. You have this explanation which suggests one trie is one term:
{code}
+ * <p>Within lucene, each numeric value is indexed as
+ * multiple encoded terms representing larger and larger
+ * pre-defined brackets called <em>trie</em>s.  The step
+ * size between each successive trie is called the
+ * <code>precisionStep</code> in this API.  Smaller
{code}
 

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch, LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749148#action_12749148 ]

Michael McCandless commented on LUCENE-1872:
--------------------------------------------

bq. "Trie" is the whole "prefix tree".

OK -- I tweaked NumericField to fix that.  I'll fix LIA2's manuscript too... thanks!

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch, LUCENE-1872.patch, LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Updated: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

     [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael McCandless updated LUCENE-1872:
---------------------------------------

    Attachment: LUCENE-1872.patch

State that precSteps is "bits", and trie is the entire data structure.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch, LUCENE-1872.patch, LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (LUCENE-1872) Improve javadocs for Numeric*

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/LUCENE-1872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12749179#action_12749179 ]

Uwe Schindler commented on LUCENE-1872:
---------------------------------------

I think this is fine now! Thanks.

> Improve javadocs for Numeric*
> -----------------------------
>
>                 Key: LUCENE-1872
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1872
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Michael McCandless
>            Assignee: Michael McCandless
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1872.patch, LUCENE-1872.patch, LUCENE-1872.patch
>
>
> I'm working on improving Numeric* javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

12