diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html | 507 |
1 files changed, 507 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html new file mode 100644 index 0000000..55d5d85 --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html @@ -0,0 +1,507 @@ +<!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>AbstractSubHyperplane (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="AbstractSubHyperplane (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/AbstractSubHyperplane.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/partitioning/AbstractRegion.html" title="class in org.apache.commons.math3.geometry.partitioning"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.html" title="class in org.apache.commons.math3.geometry.partitioning"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" target="_top">Frames</a></li> +<li><a href="AbstractSubHyperplane.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.partitioning</div> +<h2 title="Class AbstractSubHyperplane" class="title">Class AbstractSubHyperplane<S extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>,T 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"> +<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.partitioning.AbstractSubHyperplane<S,T></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> - Type of the embedding space.</dd><dd><code>T</code> - Type of the embedded sub-space.</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><S></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/commons/math3/geometry/spherical/twod/SubCircle.html" title="class in org.apache.commons.math3.geometry.spherical.twod">SubCircle</a>, <a href="../../../../../../org/apache/commons/math3/geometry/spherical/oned/SubLimitAngle.html" title="class in org.apache.commons.math3.geometry.spherical.oned">SubLimitAngle</a>, <a href="../../../../../../org/apache/commons/math3/geometry/euclidean/twod/SubLine.html" title="class in org.apache.commons.math3.geometry.euclidean.twod">SubLine</a>, <a href="../../../../../../org/apache/commons/math3/geometry/euclidean/oned/SubOrientedPoint.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">SubOrientedPoint</a>, <a href="../../../../../../org/apache/commons/math3/geometry/euclidean/threed/SubPlane.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">SubPlane</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractSubHyperplane<S extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>,T extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></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="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><S></pre> +<div class="block">This class implements the dimension-independent parts of <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning"><code>SubHyperplane</code></a>. + + <p>sub-hyperplanes are obtained when parts of an <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning"><code>hyperplane</code></a> are chopped off by other hyperplanes that + intersect it. The remaining part is a convex region. Such objects + appear in <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/BSPTree.html" title="class in org.apache.commons.math3.geometry.partitioning"><code>BSP trees</code></a> as the intersection of a cut + hyperplane with the convex region which it splits, the chopping + hyperplanes are the cut hyperplanes closer to the tree root.</p></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.commons.math3.geometry.partitioning.SubHyperplane"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.commons.math3.geometry.partitioning.<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a></h3> +<code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.SplitSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">SubHyperplane.SplitSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.SplitSubHyperplane.html" title="type parameter in SubHyperplane.SplitSubHyperplane">U</a> extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></code></li> +</ul> +</li> +</ul> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html#AbstractSubHyperplane(org.apache.commons.math3.geometry.partitioning.Hyperplane,%20org.apache.commons.math3.geometry.partitioning.Region)">AbstractSubHyperplane</a></strong>(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">Hyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> hyperplane, + <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning">Region</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> remainingRegion)</code> +<div class="block">Build a sub-hyperplane from an hyperplane and a region.</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><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>,<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html#applyTransform(org.apache.commons.math3.geometry.partitioning.Transform)">applyTransform</a></strong>(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Transform.html" title="interface in org.apache.commons.math3.geometry.partitioning">Transform</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>,<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> transform)</code> +<div class="block">Apply a transform to the instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>,<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html#buildNew(org.apache.commons.math3.geometry.partitioning.Hyperplane,%20org.apache.commons.math3.geometry.partitioning.Region)">buildNew</a></strong>(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">Hyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> hyper, + <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning">Region</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> remaining)</code> +<div class="block">Build a sub-hyperplane from an hyperplane and a region.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>,<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html#copySelf()">copySelf</a></strong>()</code> +<div class="block">Copy the instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">Hyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html#getHyperplane()">getHyperplane</a></strong>()</code> +<div class="block">Get the underlying hyperplane.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning">Region</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html#getRemainingRegion()">getRemainingRegion</a></strong>()</code> +<div class="block">Get the remaining region of the hyperplane.</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/partitioning/AbstractSubHyperplane.html#getSize()">getSize</a></strong>()</code> +<div class="block">Get the size of the instance.</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/partitioning/AbstractSubHyperplane.html#isEmpty()">isEmpty</a></strong>()</code> +<div class="block">Check if the instance is empty.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>,<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html#reunite(org.apache.commons.math3.geometry.partitioning.SubHyperplane)">reunite</a></strong>(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> other)</code> +<div class="block">Compute the union of the instance and another sub-hyperplane.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Side.html" title="enum in org.apache.commons.math3.geometry.partitioning">Side</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html#side(org.apache.commons.math3.geometry.partitioning.Hyperplane)">side</a></strong>(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">Hyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> hyper)</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.SplitSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">SubHyperplane.SplitSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html#split(org.apache.commons.math3.geometry.partitioning.Hyperplane)">split</a></strong>(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">Hyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> hyper)</code> +<div class="block">Split the instance in two parts by an hyperplane.</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="AbstractSubHyperplane(org.apache.commons.math3.geometry.partitioning.Hyperplane, org.apache.commons.math3.geometry.partitioning.Region)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractSubHyperplane</h4> +<pre>protected AbstractSubHyperplane(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">Hyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> hyperplane, + <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning">Region</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> remainingRegion)</pre> +<div class="block">Build a sub-hyperplane from an hyperplane and a region.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hyperplane</code> - underlying hyperplane</dd><dd><code>remainingRegion</code> - remaining region of the hyperplane</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="buildNew(org.apache.commons.math3.geometry.partitioning.Hyperplane, org.apache.commons.math3.geometry.partitioning.Region)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildNew</h4> +<pre>protected abstract <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>,<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> buildNew(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">Hyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> hyper, + <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning">Region</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> remaining)</pre> +<div class="block">Build a sub-hyperplane from an hyperplane and a region.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hyper</code> - underlying hyperplane</dd><dd><code>remaining</code> - remaining region of the hyperplane</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new sub-hyperplane</dd></dl> +</li> +</ul> +<a name="copySelf()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copySelf</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>,<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> copySelf()</pre> +<div class="block">Copy the instance. + <p>The instance created is completely independent of the original + one. A deep copy is used, none of the underlying objects are + shared (except for the nodes attributes and immutable + objects).</p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html#copySelf()">copySelf</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a> extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a new sub-hyperplane, copy of the instance</dd></dl> +</li> +</ul> +<a name="getHyperplane()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHyperplane</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">Hyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> getHyperplane()</pre> +<div class="block">Get the underlying hyperplane.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html#getHyperplane()">getHyperplane</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a> extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>underlying hyperplane</dd></dl> +</li> +</ul> +<a name="getRemainingRegion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainingRegion</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning">Region</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> getRemainingRegion()</pre> +<div class="block">Get the remaining region of the hyperplane. + <p>The returned region is expressed in the canonical hyperplane + frame and has the hyperplane dimension. For example a chopped + hyperplane in the 3D euclidean is a 2D plane and the + corresponding region is a convex 2D polygon.</p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>remaining region of the hyperplane</dd></dl> +</li> +</ul> +<a name="getSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSize</h4> +<pre>public double getSize()</pre> +<div class="block">Get the size of the instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html#getSize()">getSize</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a> extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the size of the instance (this is a length in 1D, an area + in 2D, a volume in 3D ...)</dd></dl> +</li> +</ul> +<a name="reunite(org.apache.commons.math3.geometry.partitioning.SubHyperplane)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reunite</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>,<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> reunite(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> other)</pre> +<div class="block">Compute the union of the instance and another sub-hyperplane.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html#reunite(org.apache.commons.math3.geometry.partitioning.SubHyperplane)">reunite</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a> extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - other sub-hyperplane to union (<em>must</em> be in the + same hyperplane as the instance)</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new sub-hyperplane, union of the instance and other</dd></dl> +</li> +</ul> +<a name="applyTransform(org.apache.commons.math3.geometry.partitioning.Transform)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>applyTransform</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>,<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> applyTransform(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Transform.html" title="interface in org.apache.commons.math3.geometry.partitioning">Transform</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>,<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">T</a>> transform)</pre> +<div class="block">Apply a transform to the instance. + <p>The instance must be a (D-1)-dimension sub-hyperplane with + respect to the transform <em>not</em> a (D-2)-dimension + sub-hyperplane the transform knows how to transform by + itself. The transform will consist in transforming first the + hyperplane and then the all region using the various methods + provided by the transform.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>transform</code> - D-dimension transform to apply</dd> +<dt><span class="strong">Returns:</span></dt><dd>the transformed instance</dd></dl> +</li> +</ul> +<a name="side(org.apache.commons.math3.geometry.partitioning.Hyperplane)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>side</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Side.html" title="enum in org.apache.commons.math3.geometry.partitioning">Side</a> side(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">Hyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> hyper)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Compute the relative position of the instance with respect + to an hyperplane.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html#side(org.apache.commons.math3.geometry.partitioning.Hyperplane)">side</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a> extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>hyper</code> - hyperplane to check instance against</dd> +<dt><span class="strong">Returns:</span></dt><dd>one of <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Side.html#PLUS"><code>Side.PLUS</code></a>, <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Side.html#MINUS"><code>Side.MINUS</code></a>, <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Side.html#BOTH"><code>Side.BOTH</code></a>, + <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Side.html#HYPER"><code>Side.HYPER</code></a></dd></dl> +</li> +</ul> +<a name="split(org.apache.commons.math3.geometry.partitioning.Hyperplane)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>split</h4> +<pre>public abstract <a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.SplitSubHyperplane.html" title="class in org.apache.commons.math3.geometry.partitioning">SubHyperplane.SplitSubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> split(<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/Hyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">Hyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a>> hyper)</pre> +<div class="block">Split the instance in two parts by an hyperplane.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html#split(org.apache.commons.math3.geometry.partitioning.Hyperplane)">split</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a> extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>hyper</code> - splitting hyperplane</dd> +<dt><span class="strong">Returns:</span></dt><dd>an object containing both the part of the instance + on the plus side of the hyperplane and the part of the + instance on the minus side of the hyperplane</dd></dl> +</li> +</ul> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +<div class="block">Check if the instance is empty.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html#isEmpty()">isEmpty</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a><<a href="../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" title="type parameter in AbstractSubHyperplane">S</a> extends <a href="../../../../../../org/apache/commons/math3/geometry/Space.html" title="interface in org.apache.commons.math3.geometry">Space</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the instance is empty</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/AbstractSubHyperplane.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/partitioning/AbstractRegion.html" title="class in org.apache.commons.math3.geometry.partitioning"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/geometry/partitioning/BoundaryAttribute.html" title="class in org.apache.commons.math3.geometry.partitioning"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/geometry/partitioning/AbstractSubHyperplane.html" target="_top">Frames</a></li> +<li><a href="AbstractSubHyperplane.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> |