source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/search/function/distance/HaversineFunction.html @ 7588

Revision 7588, 27.9 KB checked in by adir, 11 years ago (diff)

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:25 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8HaversineFunction (Solr 4.0.0-ALPHA API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-06-25">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="HaversineFunction (Solr 4.0.0-ALPHA API)";
20    }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40  <TR ALIGN="center" VALIGN="top">
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HaversineFunction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineConstFunction.html" title="class in org.apache.solr.search.function.distance"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/solr/search/function/distance/SquaredEuclideanFunction.html" title="class in org.apache.solr.search.function.distance"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../../index.html?org/apache/solr/search/function/distance/HaversineFunction.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="HaversineFunction.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.solr.search.function.distance</FONT>
92<BR>
93Class HaversineFunction</H2>
94<PRE>
95<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">org.apache.lucene.queries.function.ValueSource</A>
97      <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.search.function.distance.HaversineFunction</B>
98</PRE>
99<HR>
100<DL>
101<DT><PRE>public class <B>HaversineFunction</B><DT>extends <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A></DL>
102</PRE>
103
104<P>
105Calculate the Haversine formula (distance) between any two points on a sphere
106 Takes in four value sources: (latA, lonA); (latB, lonB).
107 <p/>
108 Assumes the value sources are in radians unless
109 <p/>
110 See http://en.wikipedia.org/wiki/Great-circle_distance and
111 http://en.wikipedia.org/wiki/Haversine_formula for the actual formula and
112 also http://www.movable-type.co.uk/scripts/latlong.html
113<P>
114
115<P>
116<HR>
117
118<P>
119
120<!-- ======== CONSTRUCTOR SUMMARY ======== -->
121
122<A NAME="constructor_summary"><!-- --></A>
123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
124<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
125<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
126<B>Constructor Summary</B></FONT></TH>
127</TR>
128<TR BGCOLOR="white" CLASS="TableRowColor">
129<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineFunction.html#HaversineFunction(org.apache.lucene.queries.function.valuesource.MultiValueSource, org.apache.lucene.queries.function.valuesource.MultiValueSource, double)">HaversineFunction</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/valuesource/MultiValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function.valuesource">MultiValueSource</A>&nbsp;p1,
130                  <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/valuesource/MultiValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function.valuesource">MultiValueSource</A>&nbsp;p2,
131                  double&nbsp;radius)</CODE>
132
133<BR>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineFunction.html#HaversineFunction(org.apache.lucene.queries.function.valuesource.MultiValueSource, org.apache.lucene.queries.function.valuesource.MultiValueSource, double, boolean)">HaversineFunction</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/valuesource/MultiValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function.valuesource">MultiValueSource</A>&nbsp;p1,
138                  <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/valuesource/MultiValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function.valuesource">MultiValueSource</A>&nbsp;p2,
139                  double&nbsp;radius,
140                  boolean&nbsp;convertToRads)</CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
144</TR>
145</TABLE>
146&nbsp;
147<!-- ========== METHOD SUMMARY =========== -->
148
149<A NAME="method_summary"><!-- --></A>
150<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
151<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
152<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
153<B>Method Summary</B></FONT></TH>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>&nbsp;void</CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineFunction.html#createWeight(java.util.Map, org.apache.lucene.search.IndexSearcher)">createWeight</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&nbsp;context,
159             <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/IndexSearcher.html?is-external=true" title="class or interface in org.apache.lucene.search">IndexSearcher</A>&nbsp;searcher)</CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
167<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineFunction.html#description()">description</A></B>()</CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<CODE>protected &nbsp;double</CODE></FONT></TD>
175<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineFunction.html#distance(int, org.apache.lucene.queries.function.FunctionValues, org.apache.lucene.queries.function.FunctionValues)">distance</A></B>(int&nbsp;doc,
176         <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/FunctionValues.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">FunctionValues</A>&nbsp;p1DV,
177         <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/FunctionValues.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">FunctionValues</A>&nbsp;p2DV)</CODE>
178
179<BR>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>&nbsp;boolean</CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineFunction.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;o)</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/FunctionValues.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">FunctionValues</A></CODE></FONT></TD>
193<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineFunction.html#getValues(java.util.Map, org.apache.lucene.index.AtomicReaderContext)">getValues</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&nbsp;context,
194          <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/AtomicReaderContext.html?is-external=true" title="class or interface in org.apache.lucene.index">AtomicReaderContext</A>&nbsp;readerContext)</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
200<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201<CODE>&nbsp;int</CODE></FONT></TD>
202<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineFunction.html#hashCode()">hashCode</A></B>()</CODE>
203
204<BR>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<CODE>protected &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineFunction.html#name()">name</A></B>()</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
214</TR>
215</TABLE>
216&nbsp;<A NAME="methods_inherited_from_class_org.apache.lucene.queries.function.ValueSource"><!-- --></A>
217<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
218<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
219<TH ALIGN="left"><B>Methods inherited from class org.apache.lucene.queries.function.<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A></B></TH>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD><CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true#getSortField(boolean)" title="class or interface in org.apache.lucene.queries.function">getSortField</A>, <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true#newContext(org.apache.lucene.search.IndexSearcher)" title="class or interface in org.apache.lucene.queries.function">newContext</A>, <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true#toString()" title="class or interface in org.apache.lucene.queries.function">toString</A></CODE></TD>
223</TR>
224</TABLE>
225&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
226<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
227<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
228<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
232</TR>
233</TABLE>
234&nbsp;
235<P>
236
237<!-- ========= CONSTRUCTOR DETAIL ======== -->
238
239<A NAME="constructor_detail"><!-- --></A>
240<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
241<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
242<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
243<B>Constructor Detail</B></FONT></TH>
244</TR>
245</TABLE>
246
247<A NAME="HaversineFunction(org.apache.lucene.queries.function.valuesource.MultiValueSource, org.apache.lucene.queries.function.valuesource.MultiValueSource, double)"><!-- --></A><H3>
248HaversineFunction</H3>
249<PRE>
250public <B>HaversineFunction</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/valuesource/MultiValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function.valuesource">MultiValueSource</A>&nbsp;p1,
251                         <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/valuesource/MultiValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function.valuesource">MultiValueSource</A>&nbsp;p2,
252                         double&nbsp;radius)</PRE>
253<DL>
254</DL>
255<HR>
256
257<A NAME="HaversineFunction(org.apache.lucene.queries.function.valuesource.MultiValueSource, org.apache.lucene.queries.function.valuesource.MultiValueSource, double, boolean)"><!-- --></A><H3>
258HaversineFunction</H3>
259<PRE>
260public <B>HaversineFunction</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/valuesource/MultiValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function.valuesource">MultiValueSource</A>&nbsp;p1,
261                         <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/valuesource/MultiValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function.valuesource">MultiValueSource</A>&nbsp;p2,
262                         double&nbsp;radius,
263                         boolean&nbsp;convertToRads)</PRE>
264<DL>
265</DL>
266
267<!-- ============ METHOD DETAIL ========== -->
268
269<A NAME="method_detail"><!-- --></A>
270<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
271<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
272<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
273<B>Method Detail</B></FONT></TH>
274</TR>
275</TABLE>
276
277<A NAME="name()"><!-- --></A><H3>
278name</H3>
279<PRE>
280protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>name</B>()</PRE>
281<DL>
282<DD><DL>
283</DL>
284</DD>
285</DL>
286<HR>
287
288<A NAME="distance(int, org.apache.lucene.queries.function.FunctionValues, org.apache.lucene.queries.function.FunctionValues)"><!-- --></A><H3>
289distance</H3>
290<PRE>
291protected double <B>distance</B>(int&nbsp;doc,
292                          <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/FunctionValues.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">FunctionValues</A>&nbsp;p1DV,
293                          <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/FunctionValues.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">FunctionValues</A>&nbsp;p2DV)</PRE>
294<DL>
295<DD><DL>
296<DT><B>Parameters:</B><DD><CODE>doc</CODE> - The doc to score<DD><CODE>p1DV</CODE> - <DD><CODE>p2DV</CODE> -
297<DT><B>Returns:</B><DD>The haversine distance formula</DL>
298</DD>
299</DL>
300<HR>
301
302<A NAME="getValues(java.util.Map, org.apache.lucene.index.AtomicReaderContext)"><!-- --></A><H3>
303getValues</H3>
304<PRE>
305public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/FunctionValues.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">FunctionValues</A> <B>getValues</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&nbsp;context,
306                                <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/AtomicReaderContext.html?is-external=true" title="class or interface in org.apache.lucene.index">AtomicReaderContext</A>&nbsp;readerContext)
307                         throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
308<DL>
309<DD><DL>
310<DT><B>Specified by:</B><DD><CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true#getValues(java.util.Map, org.apache.lucene.index.AtomicReaderContext)" title="class or interface in org.apache.lucene.queries.function">getValues</A></CODE> in class <CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A></CODE></DL>
311</DD>
312<DD><DL>
313
314<DT><B>Throws:</B>
315<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
316</DD>
317</DL>
318<HR>
319
320<A NAME="createWeight(java.util.Map, org.apache.lucene.search.IndexSearcher)"><!-- --></A><H3>
321createWeight</H3>
322<PRE>
323public void <B>createWeight</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&nbsp;context,
324                         <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/IndexSearcher.html?is-external=true" title="class or interface in org.apache.lucene.search">IndexSearcher</A>&nbsp;searcher)
325                  throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
326<DL>
327<DD><DL>
328<DT><B>Overrides:</B><DD><CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true#createWeight(java.util.Map, org.apache.lucene.search.IndexSearcher)" title="class or interface in org.apache.lucene.queries.function">createWeight</A></CODE> in class <CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A></CODE></DL>
329</DD>
330<DD><DL>
331
332<DT><B>Throws:</B>
333<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
334</DD>
335</DL>
336<HR>
337
338<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
339equals</H3>
340<PRE>
341public boolean <B>equals</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;o)</PRE>
342<DL>
343<DD><DL>
344<DT><B>Specified by:</B><DD><CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true#equals(java.lang.Object)" title="class or interface in org.apache.lucene.queries.function">equals</A></CODE> in class <CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A></CODE></DL>
345</DD>
346<DD><DL>
347</DL>
348</DD>
349</DL>
350<HR>
351
352<A NAME="hashCode()"><!-- --></A><H3>
353hashCode</H3>
354<PRE>
355public int <B>hashCode</B>()</PRE>
356<DL>
357<DD><DL>
358<DT><B>Specified by:</B><DD><CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true#hashCode()" title="class or interface in org.apache.lucene.queries.function">hashCode</A></CODE> in class <CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A></CODE></DL>
359</DD>
360<DD><DL>
361</DL>
362</DD>
363</DL>
364<HR>
365
366<A NAME="description()"><!-- --></A><H3>
367description</H3>
368<PRE>
369public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>description</B>()</PRE>
370<DL>
371<DD><DL>
372<DT><B>Specified by:</B><DD><CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true#description()" title="class or interface in org.apache.lucene.queries.function">description</A></CODE> in class <CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A></CODE></DL>
373</DD>
374<DD><DL>
375</DL>
376</DD>
377</DL>
378<!-- ========= END OF CLASS DATA ========= -->
379<HR>
380
381
382<!-- ======= START OF BOTTOM NAVBAR ====== -->
383<A NAME="navbar_bottom"><!-- --></A>
384<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
385<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
386<TR>
387<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
388<A NAME="navbar_bottom_firstrow"><!-- --></A>
389<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
390  <TR ALIGN="center" VALIGN="top">
391  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
392  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
393  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
394  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HaversineFunction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
395  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
396  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
397  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
398  </TR>
399</TABLE>
400</TD>
401<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
402</EM>
403</TD>
404</TR>
405
406<TR>
407<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
408&nbsp;<A HREF="../../../../../../org/apache/solr/search/function/distance/HaversineConstFunction.html" title="class in org.apache.solr.search.function.distance"><B>PREV CLASS</B></A>&nbsp;
409&nbsp;<A HREF="../../../../../../org/apache/solr/search/function/distance/SquaredEuclideanFunction.html" title="class in org.apache.solr.search.function.distance"><B>NEXT CLASS</B></A></FONT></TD>
410<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
411  <A HREF="../../../../../../index.html?org/apache/solr/search/function/distance/HaversineFunction.html" target="_top"><B>FRAMES</B></A>  &nbsp;
412&nbsp;<A HREF="HaversineFunction.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
413&nbsp;<SCRIPT type="text/javascript">
414  <!--
415  if(window==top) {
416    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
417  }
418  //-->
419</SCRIPT>
420<NOSCRIPT>
421  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
422</NOSCRIPT>
423
424
425</FONT></TD>
426</TR>
427<TR>
428<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
429  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
430<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
431DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
432</TR>
433</TABLE>
434<A NAME="skip-navbar_bottom"></A>
435<!-- ======== END OF BOTTOM NAVBAR ======= -->
436
437<HR>
438
439          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
440          <script src='../../../../../../prettify.js' type='text/javascript'></script>
441          <script type='text/javascript'>
442            (function(){
443              var oldonload = window.onload;
444              if (typeof oldonload != 'function') {
445                window.onload = prettyPrint;
446              } else {
447                window.onload = function() {
448                  oldonload();
449                  prettyPrint();
450                }
451              }
452            })();
453          </script>
454       
455</BODY>
456</HTML>
Note: See TracBrowser for help on using the repository browser.