PageRenderTime 57ms CodeModel.GetById 28ms RepoModel.GetById 0ms app.codeStats 0ms

/external/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ml/distance/ManhattanDistance.html

https://gitlab.com/geomois/ec23
HTML | 282 lines | 238 code | 0 blank | 44 comment | 0 complexity | ffb1aa46f83970e00c99804990460558 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="en">
    4. 

  4. <head>
    5. 

  5. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    6. 

  6. <title>ManhattanDistance (Apache Commons Math 3.6.1 API)</title>
    7. 

  7. <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <script type="text/javascript"><!--
    11. 

  11.     if (location.href.indexOf('is-external=true') == -1) {
    12. 

  12.         parent.document.title="ManhattanDistance (Apache Commons Math 3.6.1 API)";
    13. 

  13.     }
    14. 

  14. //-->
    15. 

  15. </script>
    16. 

  16. <noscript>
    17. 

  17. <div>JavaScript is disabled on your browser.</div>
    18. 

  18. </noscript>
    19. 

  19. <!-- ========= START OF TOP NAVBAR ======= -->
    20. 

  20. <div class="topNav"><a name="navbar_top">
    21. 

  21. <!--   -->
    22. 

  22. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    23. 

  23. <!--   -->
    24. 

  24. </a>
    25. 

  25. <ul class="navList" title="Navigation">
    26. 

  26. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
    27. 

  27. <li><a href="package-summary.html">Package</a></li>
    28. 

  28. <li class="navBarCell1Rev">Class</li>
    29. 

  29. <li><a href="class-use/ManhattanDistance.html">Use</a></li>
    30. 

  30. <li><a href="package-tree.html">Tree</a></li>
    31. 

  31. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
    32. 

  32. <li><a href="../../../../../../index-all.html">Index</a></li>
    33. 

  33. <li><a href="../../../../../../help-doc.html">Help</a></li>
    34. 

  34. </ul>
    35. 

  35. <div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
    36. 

  36. </div>
    37. 

  37. <div class="subNav">
    38. 

  38. <ul class="navList">
    39. 

  39. <li><a href="../../../../../../org/apache/commons/math3/ml/distance/EuclideanDistance.html" title="class in org.apache.commons.math3.ml.distance"><span class="strong">Prev Class</span></a></li>
    40. 

  40. <li>Next Class</li>
    41. 

  41. </ul>
    42. 

  42. <ul class="navList">
    43. 

  43. <li><a href="../../../../../../index.html?org/apache/commons/math3/ml/distance/ManhattanDistance.html" target="_top">Frames</a></li>
    44. 

  44. <li><a href="ManhattanDistance.html" target="_top">No Frames</a></li>
    45. 

  45. </ul>
    46. 

  46. <ul class="navList" id="allclasses_navbar_top">
    47. 

  47. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
    48. 

  48. </ul>
    49. 

  49. <div>
    50. 

  50. <script type="text/javascript"><!--
    51. 

  51.   allClassesLink = document.getElementById("allclasses_navbar_top");
    52. 

  52.   if(window==top) {
    53. 

  53.     allClassesLink.style.display = "block";
    54. 

  54.   }
    55. 

  55.   else {
    56. 

  56.     allClassesLink.style.display = "none";
    57. 

  57.   }
    58. 

  58.   //-->
    59. 

  59. </script>
    60. 

  60. </div>
    61. 

  61. <div>
    62. 

  62. <ul class="subNavList">
    63. 

  63. <li>Summary:&nbsp;</li>
    64. 

  64. <li>Nested&nbsp;|&nbsp;</li>
    65. 

  65. <li>Field&nbsp;|&nbsp;</li>
    66. 

  66. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
    67. 

  67. <li><a href="#method_summary">Method</a></li>
    68. 

  68. </ul>
    69. 

  69. <ul class="subNavList">
    70. 

  70. <li>Detail:&nbsp;</li>
    71. 

  71. <li>Field&nbsp;|&nbsp;</li>
    72. 

  72. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
    73. 

  73. <li><a href="#method_detail">Method</a></li>
    74. 

  74. </ul>
    75. 

  75. </div>
    76. 

  76. <a name="skip-navbar_top">
    77. 

  77. <!--   -->
    78. 

  78. </a></div>
    79. 

  79. <!-- ========= END OF TOP NAVBAR ========= -->
    80. 

  80. <!-- ======== START OF CLASS DATA ======== -->
    81. 

  81. <div class="header">
    82. 

  82. <div class="subTitle">org.apache.commons.math3.ml.distance</div>
    83. 

  83. <h2 title="Class ManhattanDistance" class="title">Class ManhattanDistance</h2>
    84. 

  84. </div>
    85. 

  85. <div class="contentContainer">
    86. 

  86. <ul class="inheritance">
    87. 

  87. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
    88. 

  88. <li>
    89. 

  89. <ul class="inheritance">
    90. 

  90. <li>org.apache.commons.math3.ml.distance.ManhattanDistance</li>
    91. 

  91. </ul>
    92. 

  92. </li>
    93. 

  93. </ul>
    94. 

  94. <div class="description">
    95. 

  95. <ul class="blockList">
    96. 

  96. <li class="blockList">
    97. 

  97. <dl>
    98. 

  98. <dt>All Implemented Interfaces:</dt>
    99. 

  99. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../../org/apache/commons/math3/ml/distance/DistanceMeasure.html" title="interface in org.apache.commons.math3.ml.distance">DistanceMeasure</a></dd>
    100. 

  100. </dl>
    101. 

  101. <hr>
    102. 

  102. <br>
    103. 

  103. <pre>public class <span class="strong">ManhattanDistance</span>
    104. 

  104. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
    105. 

  105. implements <a href="../../../../../../org/apache/commons/math3/ml/distance/DistanceMeasure.html" title="interface in org.apache.commons.math3.ml.distance">DistanceMeasure</a></pre>
    106. 

  106. <div class="block">Calculates the L<sub>1</sub> (sum of abs) distance between two points.</div>
    107. 

  107. <dl><dt><span class="strong">Since:</span></dt>
    108. 

  108.   <dd>3.2</dd>
    109. 

  109. <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../serialized-form.html#org.apache.commons.math3.ml.distance.ManhattanDistance">Serialized Form</a></dd></dl>
    110. 

  110. </li>
    111. 

  111. </ul>
    112. 

  112. </div>
    113. 

  113. <div class="summary">
    114. 

  114. <ul class="blockList">
    115. 

  115. <li class="blockList">
    116. 

  116. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    117. 

  117. <ul class="blockList">
    118. 

  118. <li class="blockList"><a name="constructor_summary">
    119. 

  119. <!--   -->
    120. 

  120. </a>
    121. 

  121. <h3>Constructor Summary</h3>
    122. 

  122. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
    123. 

  123. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
    124. 

  124. <tr>
    125. 

  125. <th class="colOne" scope="col">Constructor and Description</th>
    126. 

  126. </tr>
    127. 

  127. <tr class="altColor">
    128. 

  128. <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/distance/ManhattanDistance.html#ManhattanDistance()">ManhattanDistance</a></strong>()</code>&nbsp;</td>
    129. 

  129. </tr>
    130. 

  130. </table>
    131. 

  131. </li>
    132. 

  132. </ul>
    133. 

  133. <!-- ========== METHOD SUMMARY =========== -->
    134. 

  134. <ul class="blockList">
    135. 

  135. <li class="blockList"><a name="method_summary">
    136. 

  136. <!--   -->
    137. 

  137. </a>
    138. 

  138. <h3>Method Summary</h3>
    139. 

  139. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    140. 

  140. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
    141. 

  141. <tr>
    142. 

  142. <th class="colFirst" scope="col">Modifier and Type</th>
    143. 

  143. <th class="colLast" scope="col">Method and Description</th>
    144. 

  144. </tr>
    145. 

  145. <tr class="altColor">
    146. 

  146. <td class="colFirst"><code>double</code></td>
    147. 

  147. <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ml/distance/ManhattanDistance.html#compute(double[],%20double[])">compute</a></strong>(double[]&nbsp;a,
    148. 

  148.        double[]&nbsp;b)</code>
    149. 

  149. <div class="block">Compute the distance between two n-dimensional vectors.</div>
    150. 

  150. </td>
    151. 

  151. </tr>
    152. 

  152. </table>
    153. 

  153. <ul class="blockList">
    154. 

  154. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
    155. 

  155. <!--   -->
    156. 

  156. </a>
    157. 

  157. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
    158. 

  158. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
    159. 

  159. </ul>
    160. 

  160. </li>
    161. 

  161. </ul>
    162. 

  162. </li>
    163. 

  163. </ul>
    164. 

  164. </div>
    165. 

  165. <div class="details">
    166. 

  166. <ul class="blockList">
    167. 

  167. <li class="blockList">
    168. 

  168. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    169. 

  169. <ul class="blockList">
    170. 

  170. <li class="blockList"><a name="constructor_detail">
    171. 

  171. <!--   -->
    172. 

  172. </a>
    173. 

  173. <h3>Constructor Detail</h3>
    174. 

  174. <a name="ManhattanDistance()">
    175. 

  175. <!--   -->
    176. 

  176. </a>
    177. 

  177. <ul class="blockListLast">
    178. 

  178. <li class="blockList">
    179. 

  179. <h4>ManhattanDistance</h4>
    180. 

  180. <pre>public&nbsp;ManhattanDistance()</pre>
    181. 

  181. </li>
    182. 

  182. </ul>
    183. 

  183. </li>
    184. 

  184. </ul>
    185. 

  185. <!-- ============ METHOD DETAIL ========== -->
    186. 

  186. <ul class="blockList">
    187. 

  187. <li class="blockList"><a name="method_detail">
    188. 

  188. <!--   -->
    189. 

  189. </a>
    190. 

  190. <h3>Method Detail</h3>
    191. 

  191. <a name="compute(double[], double[])">
    192. 

  192. <!--   -->
    193. 

  193. </a>
    194. 

  194. <ul class="blockListLast">
    195. 

  195. <li class="blockList">
    196. 

  196. <h4>compute</h4>
    197. 

  197. <pre>public&nbsp;double&nbsp;compute(double[]&nbsp;a,
    198. 

  198.              double[]&nbsp;b)
    199. 

  199.                throws <a href="../../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre>
    200. 

  200. <div class="block">Compute the distance between two n-dimensional vectors.
    201. 

  201.  <p>
    202. 

  202.  The two vectors are required to have the same dimension.</div>
    203. 

  203. <dl>
    204. 

  204. <dt><strong>Specified by:</strong></dt>
    205. 

  205. <dd><code><a href="../../../../../../org/apache/commons/math3/ml/distance/DistanceMeasure.html#compute(double[],%20double[])">compute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/commons/math3/ml/distance/DistanceMeasure.html" title="interface in org.apache.commons.math3.ml.distance">DistanceMeasure</a></code></dd>
    206. 

  206. <dt><span class="strong">Parameters:</span></dt><dd><code>a</code> - the first vector</dd><dd><code>b</code> - the second vector</dd>
    207. 

  207. <dt><span class="strong">Returns:</span></dt><dd>the distance between the two vectors</dd>
    208. 

  208. <dt><span class="strong">Throws:</span></dt>
    209. 

  209. <dd><code><a href="../../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the array lengths differ.</dd></dl>
    210. 

  210. </li>
    211. 

  211. </ul>
    212. 

  212. </li>
    213. 

  213. </ul>
    214. 

  214. </li>
    215. 

  215. </ul>
    216. 

  216. </div>
    217. 

  217. </div>
    218. 

  218. <!-- ========= END OF CLASS DATA ========= -->
    219. 

  219. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    220. 

  220. <div class="bottomNav"><a name="navbar_bottom">
    221. 

  221. <!--   -->
    222. 

  222. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    223. 

  223. <!--   -->
    224. 

  224. </a>
    225. 

  225. <ul class="navList" title="Navigation">
    226. 

  226. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
    227. 

  227. <li><a href="package-summary.html">Package</a></li>
    228. 

  228. <li class="navBarCell1Rev">Class</li>
    229. 

  229. <li><a href="class-use/ManhattanDistance.html">Use</a></li>
    230. 

  230. <li><a href="package-tree.html">Tree</a></li>
    231. 

  231. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
    232. 

  232. <li><a href="../../../../../../index-all.html">Index</a></li>
    233. 

  233. <li><a href="../../../../../../help-doc.html">Help</a></li>
    234. 

  234. </ul>
    235. 

  235. <div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
    236. 

  236. </div>
    237. 

  237. <div class="subNav">
    238. 

  238. <ul class="navList">
    239. 

  239. <li><a href="../../../../../../org/apache/commons/math3/ml/distance/EuclideanDistance.html" title="class in org.apache.commons.math3.ml.distance"><span class="strong">Prev Class</span></a></li>
    240. 

  240. <li>Next Class</li>
    241. 

  241. </ul>
    242. 

  242. <ul class="navList">
    243. 

  243. <li><a href="../../../../../../index.html?org/apache/commons/math3/ml/distance/ManhattanDistance.html" target="_top">Frames</a></li>
    244. 

  244. <li><a href="ManhattanDistance.html" target="_top">No Frames</a></li>
    245. 

  245. </ul>
    246. 

  246. <ul class="navList" id="allclasses_navbar_bottom">
    247. 

  247. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
    248. 

  248. </ul>
    249. 

  249. <div>
    250. 

  250. <script type="text/javascript"><!--
    251. 

  251.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    252. 

  252.   if(window==top) {
    253. 

  253.     allClassesLink.style.display = "block";
    254. 

  254.   }
    255. 

  255.   else {
    256. 

  256.     allClassesLink.style.display = "none";
    257. 

  257.   }
    258. 

  258.   //-->
    259. 

  259. </script>
    260. 

  260. </div>
    261. 

  261. <div>
    262. 

  262. <ul class="subNavList">
    263. 

  263. <li>Summary:&nbsp;</li>
    264. 

  264. <li>Nested&nbsp;|&nbsp;</li>
    265. 

  265. <li>Field&nbsp;|&nbsp;</li>
    266. 

  266. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
    267. 

  267. <li><a href="#method_summary">Method</a></li>
    268. 

  268. </ul>
    269. 

  269. <ul class="subNavList">
    270. 

  270. <li>Detail:&nbsp;</li>
    271. 

  271. <li>Field&nbsp;|&nbsp;</li>
    272. 

  272. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
    273. 

  273. <li><a href="#method_detail">Method</a></li>
    274. 

  274. </ul>
    275. 

  275. </div>
    276. 

  276. <a name="skip-navbar_bottom">
    277. 

  277. <!--   -->
    278. 

  278. </a></div>
    279. 

  279. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    280. 

  280. <p class="legalCopy"><small>Copyright &#169; 2003&#x2013;2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
    281. 

  281. </body>
    282. 

  282. </html>
    283. 

  283.