| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Vector (Apache Commons Math 3.3 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Vector (Apache Commons Math 3.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Vector.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <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> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/commons/math3/geometry/VectorFormat.html" title="class in org.apache.commons.math3.geometry"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/commons/math3/geometry/Vector.html" target="_top">Frames</a></li> |
| <li><a href="Vector.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.commons.math3.geometry</div> |
| <h2 title="Interface Vector" class="title">Interface Vector<S extends <a href="../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - Type of the space.</dd></dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a><S>, <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/commons/math3/geometry/euclidean/oned/Vector1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Vector1D</a>, <a href="../../../../../org/apache/commons/math3/geometry/euclidean/twod/Vector2D.html" title="class in org.apache.commons.math3.geometry.euclidean.twod">Vector2D</a>, <a href="../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Vector<S extends <a href="../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></span> |
| extends <a href="../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a><S></pre> |
| <div class="block">This interface represents a generic vector in a vectorial space or a point in an affine space.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">Version:</span></dt> |
| <dd>$Id: Vector.java 1555175 2014-01-03 18:07:22Z luc $</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry"><code>Space</code></a>, |
| <a href="../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry"><code>Point</code></a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#add(double, org.apache.commons.math3.geometry.Vector)">add</a></strong>(double factor, |
| <a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</code> |
| <div class="block">Add a scaled vector to the instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#add(org.apache.commons.math3.geometry.Vector)">add</a></strong>(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</code> |
| <div class="block">Add a vector to the instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#distance(org.apache.commons.math3.geometry.Vector)">distance</a></strong>(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</code> |
| <div class="block">Compute the distance between the instance and another vector according to the L<sub>2</sub> norm.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#distance1(org.apache.commons.math3.geometry.Vector)">distance1</a></strong>(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</code> |
| <div class="block">Compute the distance between the instance and another vector according to the L<sub>1</sub> norm.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#distanceInf(org.apache.commons.math3.geometry.Vector)">distanceInf</a></strong>(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</code> |
| <div class="block">Compute the distance between the instance and another vector according to the L<sub>∞</sub> norm.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#distanceSq(org.apache.commons.math3.geometry.Vector)">distanceSq</a></strong>(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</code> |
| <div class="block">Compute the square of the distance between the instance and another vector.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#dotProduct(org.apache.commons.math3.geometry.Vector)">dotProduct</a></strong>(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</code> |
| <div class="block">Compute the dot-product of the instance and another vector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#getNorm()">getNorm</a></strong>()</code> |
| <div class="block">Get the L<sub>2</sub> norm for the vector.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#getNorm1()">getNorm1</a></strong>()</code> |
| <div class="block">Get the L<sub>1</sub> norm for the vector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#getNormInf()">getNormInf</a></strong>()</code> |
| <div class="block">Get the L<sub>∞</sub> norm for the vector.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#getNormSq()">getNormSq</a></strong>()</code> |
| <div class="block">Get the square of the norm for the vector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#getZero()">getZero</a></strong>()</code> |
| <div class="block">Get the null vector of the vectorial space or origin point of the affine space.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#isInfinite()">isInfinite</a></strong>()</code> |
| <div class="block">Returns true if any coordinate of this vector is infinite and none are NaN; |
| false otherwise</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#negate()">negate</a></strong>()</code> |
| <div class="block">Get the opposite of the instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#normalize()">normalize</a></strong>()</code> |
| <div class="block">Get a normalized vector aligned with the instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#scalarMultiply(double)">scalarMultiply</a></strong>(double a)</code> |
| <div class="block">Multiply the instance by a scalar.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#subtract(double, org.apache.commons.math3.geometry.Vector)">subtract</a></strong>(double factor, |
| <a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</code> |
| <div class="block">Subtract a scaled vector from the instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#subtract(org.apache.commons.math3.geometry.Vector)">subtract</a></strong>(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</code> |
| <div class="block">Subtract a vector from the instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/geometry/Vector.html#toString(java.text.NumberFormat)">toString</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/text/NumberFormat.html?is-external=true" title="class or interface in java.text">NumberFormat</a> format)</code> |
| <div class="block">Get a string representation of this vector.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.geometry.Point"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.commons.math3.geometry.<a href="../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a></h3> |
| <code><a href="../../../../../org/apache/commons/math3/geometry/Point.html#distance(org.apache.commons.math3.geometry.Point)">distance</a>, <a href="../../../../../org/apache/commons/math3/geometry/Point.html#getSpace()">getSpace</a>, <a href="../../../../../org/apache/commons/math3/geometry/Point.html#isNaN()">isNaN</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getZero()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getZero</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> getZero()</pre> |
| <div class="block">Get the null vector of the vectorial space or origin point of the affine space.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>null vector of the vectorial space or origin point of the affine space</dd></dl> |
| </li> |
| </ul> |
| <a name="getNorm1()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNorm1</h4> |
| <pre>double getNorm1()</pre> |
| <div class="block">Get the L<sub>1</sub> norm for the vector.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>L<sub>1</sub> norm for the vector</dd></dl> |
| </li> |
| </ul> |
| <a name="getNorm()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNorm</h4> |
| <pre>double getNorm()</pre> |
| <div class="block">Get the L<sub>2</sub> norm for the vector.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Euclidean norm for the vector</dd></dl> |
| </li> |
| </ul> |
| <a name="getNormSq()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNormSq</h4> |
| <pre>double getNormSq()</pre> |
| <div class="block">Get the square of the norm for the vector.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>square of the Euclidean norm for the vector</dd></dl> |
| </li> |
| </ul> |
| <a name="getNormInf()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNormInf</h4> |
| <pre>double getNormInf()</pre> |
| <div class="block">Get the L<sub>∞</sub> norm for the vector.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>L<sub>∞</sub> norm for the vector</dd></dl> |
| </li> |
| </ul> |
| <a name="add(org.apache.commons.math3.geometry.Vector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> add(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</pre> |
| <div class="block">Add a vector to the instance.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - vector to add</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new vector</dd></dl> |
| </li> |
| </ul> |
| <a name="add(double, org.apache.commons.math3.geometry.Vector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> add(double factor, |
| <a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</pre> |
| <div class="block">Add a scaled vector to the instance.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>factor</code> - scale factor to apply to v before adding it</dd><dd><code>v</code> - vector to add</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new vector</dd></dl> |
| </li> |
| </ul> |
| <a name="subtract(org.apache.commons.math3.geometry.Vector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>subtract</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> subtract(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</pre> |
| <div class="block">Subtract a vector from the instance.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - vector to subtract</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new vector</dd></dl> |
| </li> |
| </ul> |
| <a name="subtract(double, org.apache.commons.math3.geometry.Vector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>subtract</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> subtract(double factor, |
| <a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</pre> |
| <div class="block">Subtract a scaled vector from the instance.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>factor</code> - scale factor to apply to v before subtracting it</dd><dd><code>v</code> - vector to subtract</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new vector</dd></dl> |
| </li> |
| </ul> |
| <a name="negate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>negate</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> negate()</pre> |
| <div class="block">Get the opposite of the instance.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new vector which is opposite to the instance</dd></dl> |
| </li> |
| </ul> |
| <a name="normalize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>normalize</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> normalize() |
| throws <a href="../../../../../org/apache/commons/math3/exception/MathArithmeticException.html" title="class in org.apache.commons.math3.exception">MathArithmeticException</a></pre> |
| <div class="block">Get a normalized vector aligned with the instance.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new normalized vector</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/MathArithmeticException.html" title="class in org.apache.commons.math3.exception">MathArithmeticException</a></code> - if the norm is zero</dd></dl> |
| </li> |
| </ul> |
| <a name="scalarMultiply(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scalarMultiply</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> scalarMultiply(double a)</pre> |
| <div class="block">Multiply the instance by a scalar.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>a</code> - scalar</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new vector</dd></dl> |
| </li> |
| </ul> |
| <a name="isInfinite()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInfinite</h4> |
| <pre>boolean isInfinite()</pre> |
| <div class="block">Returns true if any coordinate of this vector is infinite and none are NaN; |
| false otherwise</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if any coordinate of this vector is infinite and none are NaN; |
| false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="distance1(org.apache.commons.math3.geometry.Vector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>distance1</h4> |
| <pre>double distance1(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</pre> |
| <div class="block">Compute the distance between the instance and another vector according to the L<sub>1</sub> norm. |
| <p>Calling this method is equivalent to calling: |
| <code>q.subtract(p).getNorm1()</code> except that no intermediate |
| vector is built</p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - second vector</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the distance between the instance and p according to the L<sub>1</sub> norm</dd></dl> |
| </li> |
| </ul> |
| <a name="distance(org.apache.commons.math3.geometry.Vector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>distance</h4> |
| <pre>double distance(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</pre> |
| <div class="block">Compute the distance between the instance and another vector according to the L<sub>2</sub> norm. |
| <p>Calling this method is equivalent to calling: |
| <code>q.subtract(p).getNorm()</code> except that no intermediate |
| vector is built</p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - second vector</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the distance between the instance and p according to the L<sub>2</sub> norm</dd></dl> |
| </li> |
| </ul> |
| <a name="distanceInf(org.apache.commons.math3.geometry.Vector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>distanceInf</h4> |
| <pre>double distanceInf(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</pre> |
| <div class="block">Compute the distance between the instance and another vector according to the L<sub>∞</sub> norm. |
| <p>Calling this method is equivalent to calling: |
| <code>q.subtract(p).getNormInf()</code> except that no intermediate |
| vector is built</p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - second vector</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the distance between the instance and p according to the L<sub>∞</sub> norm</dd></dl> |
| </li> |
| </ul> |
| <a name="distanceSq(org.apache.commons.math3.geometry.Vector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>distanceSq</h4> |
| <pre>double distanceSq(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</pre> |
| <div class="block">Compute the square of the distance between the instance and another vector. |
| <p>Calling this method is equivalent to calling: |
| <code>q.subtract(p).getNormSq()</code> except that no intermediate |
| vector is built</p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - second vector</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the square of the distance between the instance and p</dd></dl> |
| </li> |
| </ul> |
| <a name="dotProduct(org.apache.commons.math3.geometry.Vector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dotProduct</h4> |
| <pre>double dotProduct(<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../org/apache/commons/math3/geometry/Vector.html" title="type parameter in Vector">S</a>> v)</pre> |
| <div class="block">Compute the dot-product of the instance and another vector.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - second vector</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the dot product this.v</dd></dl> |
| </li> |
| </ul> |
| <a name="toString(java.text.NumberFormat)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString(<a href="http://docs.oracle.com/javase/6/docs/api/java/text/NumberFormat.html?is-external=true" title="class or interface in java.text">NumberFormat</a> format)</pre> |
| <div class="block">Get a string representation of this vector.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>format</code> - the custom format for components</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a string representation of this vector</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Vector.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <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> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/commons/math3/geometry/VectorFormat.html" title="class in org.apache.commons.math3.geometry"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/commons/math3/geometry/Vector.html" target="_top">Frames</a></li> |
| <li><a href="Vector.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2003–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
