diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/enclosing/EnclosingBall.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/enclosing/EnclosingBall.html | 379 |
1 files changed, 379 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/enclosing/EnclosingBall.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/enclosing/EnclosingBall.html new file mode 100644 index 0000000..852057a --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/enclosing/EnclosingBall.html @@ -0,0 +1,379 @@ +<!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>EnclosingBall (Apache Commons Math 3.6.1 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="EnclosingBall (Apache Commons Math 3.6.1 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/EnclosingBall.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/enclosing/Encloser.html" title="interface in org.apache.commons.math3.geometry.enclosing"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/geometry/enclosing/SupportBallGenerator.html" title="interface in org.apache.commons.math3.geometry.enclosing"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" target="_top">Frames</a></li> +<li><a href="EnclosingBall.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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.enclosing</div> +<h2 title="Class EnclosingBall" class="title">Class EnclosingBall<S extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>,P extends <a href="../../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a><S>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<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> +<li> +<ul class="inheritance"> +<li>org.apache.commons.math3.geometry.enclosing.EnclosingBall<S,P></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - Space type.</dd><dd><code>P</code> - Point type.</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<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></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">EnclosingBall<S extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>,P extends <a href="../../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a><S>></span> +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> +implements <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></pre> +<div class="block">This class represents a ball enclosing some points.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.3</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>, +<a href="../../../../../../org/apache/commons/math3/geometry/enclosing/Encloser.html" title="interface in org.apache.commons.math3.geometry.enclosing"><code>Encloser</code></a>, +<a href="../../../../../../serialized-form.html#org.apache.commons.math3.geometry.enclosing.EnclosingBall">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html#EnclosingBall(P,%20double,%20P...)">EnclosingBall</a></strong>(<a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a> center, + double radius, + <a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a>... support)</code> +<div class="block">Simple constructor.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html#contains(P)">contains</a></strong>(<a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a> point)</code> +<div class="block">Check if a point is within the ball or at boundary.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html#contains(P,%20double)">contains</a></strong>(<a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a> point, + double margin)</code> +<div class="block">Check if a point is within an enlarged ball or at boundary.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html#getCenter()">getCenter</a></strong>()</code> +<div class="block">Get the center of the ball.</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/enclosing/EnclosingBall.html#getRadius()">getRadius</a></strong>()</code> +<div class="block">Get the radius of the ball.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html#getSupport()">getSupport</a></strong>()</code> +<div class="block">Get the support points used to define the ball.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html#getSupportSize()">getSupportSize</a></strong>()</code> +<div class="block">Get the number of support points used to define the ball.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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> +<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> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="EnclosingBall(org.apache.commons.math3.geometry.Point,double,org.apache.commons.math3.geometry.Point[])"> +<!-- --> +</a><a name="EnclosingBall(P, double, P...)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EnclosingBall</h4> +<pre>public EnclosingBall(<a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a> center, + double radius, + <a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a>... support)</pre> +<div class="block">Simple constructor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>center</code> - center of the ball</dd><dd><code>radius</code> - radius of the ball</dd><dd><code>support</code> - support points used to define the ball</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getCenter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCenter</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a> getCenter()</pre> +<div class="block">Get the center of the ball.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>center of the ball</dd></dl> +</li> +</ul> +<a name="getRadius()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRadius</h4> +<pre>public double getRadius()</pre> +<div class="block">Get the radius of the ball.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>radius of the ball (can be negative if the ball is empty)</dd></dl> +</li> +</ul> +<a name="getSupport()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupport</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a>[] getSupport()</pre> +<div class="block">Get the support points used to define the ball.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>support points used to define the ball</dd></dl> +</li> +</ul> +<a name="getSupportSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupportSize</h4> +<pre>public int getSupportSize()</pre> +<div class="block">Get the number of support points used to define the ball.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>number of support points used to define the ball</dd></dl> +</li> +</ul> +<a name="contains(org.apache.commons.math3.geometry.Point)"> +<!-- --> +</a><a name="contains(P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public boolean contains(<a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a> point)</pre> +<div class="block">Check if a point is within the ball or at boundary.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>point</code> - point to test</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the point is within the ball or at boundary</dd></dl> +</li> +</ul> +<a name="contains(org.apache.commons.math3.geometry.Point,double)"> +<!-- --> +</a><a name="contains(P, double)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>contains</h4> +<pre>public boolean contains(<a href="../../../../../../org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" title="type parameter in EnclosingBall">P</a> point, + double margin)</pre> +<div class="block">Check if a point is within an enlarged ball or at boundary.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>point</code> - point to test</dd><dd><code>margin</code> - margin to consider</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the point is within the ball enlarged + by the margin or at boundary</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/EnclosingBall.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/enclosing/Encloser.html" title="interface in org.apache.commons.math3.geometry.enclosing"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/geometry/enclosing/SupportBallGenerator.html" title="interface in org.apache.commons.math3.geometry.enclosing"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/geometry/enclosing/EnclosingBall.html" target="_top">Frames</a></li> +<li><a href="EnclosingBall.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |