blob: 8af647241f09e626c99dffc1c3dc2e3b24942ce7 [file] [log] [blame]
<!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>ArcsSet (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="ArcsSet (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/ArcsSet.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/spherical/oned/Arc.html" title="class in org.apache.commons.math3.geometry.spherical.oned"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.InconsistentStateAt2PiWrapping.html" title="class in org.apache.commons.math3.geometry.spherical.oned"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html" target="_top">Frames</a></li>
<li><a href="ArcsSet.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:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.spherical.oned</div>
<h2 title="Class ArcsSet" class="title">Class ArcsSet</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/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><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html" title="class in org.apache.commons.math3.geometry.partitioning">org.apache.commons.math3.geometry.partitioning.AbstractRegion</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>,<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.math3.geometry.spherical.oned.ArcsSet</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;double[]&gt;, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning">Region</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ArcsSet</span>
extends <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractRegion</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>,<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;
implements <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;double[]&gt;</pre>
<div class="block">This class represents a region of a circle: a set of arcs.
<p>
Note that due to the wrapping around \(2 \pi\), barycenter is
ill-defined here. It was defined only in order to fulfill
the requirements of the <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning"><code>Region</code></a>
interface, but its use is discouraged.
</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.3</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: ArcsSet.java 1563714 2014-02-02 20:55:14Z tn $</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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.InconsistentStateAt2PiWrapping.html" title="class in org.apache.commons.math3.geometry.spherical.oned">ArcsSet.InconsistentStateAt2PiWrapping</a></strong></code>
<div class="block">Specialized exception for inconsistent BSP tree state inconsistency.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.Split.html" title="class in org.apache.commons.math3.geometry.spherical.oned">ArcsSet.Split</a></strong></code>
<div class="block">Class holding the results of the <a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html#split(org.apache.commons.math3.geometry.spherical.oned.Arc)"><code>split</code></a> method.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.commons.math3.geometry.partitioning.Region">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.commons.math3.geometry.partitioning.<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning">Region</a></h3>
<code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Region.Location.html" title="enum in org.apache.commons.math3.geometry.partitioning">Region.Location</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">&nbsp;</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/spherical/oned/ArcsSet.html#ArcsSet(org.apache.commons.math3.geometry.partitioning.BSPTree, double)">ArcsSet</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/BSPTree.html" title="class in org.apache.commons.math3.geometry.partitioning">BSPTree</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;&nbsp;tree,
double&nbsp;tolerance)</code>
<div class="block">Build an arcs set from an inside/outside BSP tree.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html#ArcsSet(java.util.Collection, double)">ArcsSet</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;&gt;&nbsp;boundary,
double&nbsp;tolerance)</code>
<div class="block">Build an arcs set from a Boundary REPresentation (B-rep).</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html#ArcsSet(double)">ArcsSet</a></strong>(double&nbsp;tolerance)</code>
<div class="block">Build an arcs set representing the whole circle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html#ArcsSet(double, double, double)">ArcsSet</a></strong>(double&nbsp;lower,
double&nbsp;upper,
double&nbsp;tolerance)</code>
<div class="block">Build an arcs set corresponding to a single arc.</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">&nbsp;</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="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Arc.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Arc</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html#asList()">asList</a></strong>()</code>
<div class="block">Build an ordered list of arcs representing the instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html" title="class in org.apache.commons.math3.geometry.spherical.oned">ArcsSet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html#buildNew(org.apache.commons.math3.geometry.partitioning.BSPTree)">buildNew</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/BSPTree.html" title="class in org.apache.commons.math3.geometry.partitioning">BSPTree</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;&nbsp;tree)</code>
<div class="block">Build a region using the instance as a prototype.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html#computeGeometricalProperties()">computeGeometricalProperties</a></strong>()</code>
<div class="block">Compute some geometrical properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;double[]&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html#iterator()">iterator</a></strong>()</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/BoundaryProjection.html" title="class in org.apache.commons.math3.geometry.partitioning">BoundaryProjection</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html#projectToBoundary(org.apache.commons.math3.geometry.Point)">projectToBoundary</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;&nbsp;point)</code>
<div class="block">Project a point on the boundary of the region.</div>
</td>
</tr>
<tr class="rowColor">
<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/spherical/oned/ArcsSet.html#side(org.apache.commons.math3.geometry.spherical.oned.Arc)">side</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Arc.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Arc</a>&nbsp;arc)</code>
<div class="block">Compute the relative position of the instance with respect
to an arc.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.Split.html" title="class in org.apache.commons.math3.geometry.spherical.oned">ArcsSet.Split</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html#split(org.apache.commons.math3.geometry.spherical.oned.Arc)">split</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Arc.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Arc</a>&nbsp;arc)</code>
<div class="block">Split the instance in two parts by an arc.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.geometry.partitioning.AbstractRegion">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.commons.math3.geometry.partitioning.<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractRegion</a></h3>
<code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#applyTransform(org.apache.commons.math3.geometry.partitioning.Transform)">applyTransform</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#checkPoint(org.apache.commons.math3.geometry.partitioning.BSPTree, org.apache.commons.math3.geometry.Point)">checkPoint</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#checkPoint(org.apache.commons.math3.geometry.partitioning.BSPTree, org.apache.commons.math3.geometry.Vector)">checkPoint</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#checkPoint(org.apache.commons.math3.geometry.Point)">checkPoint</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#checkPoint(org.apache.commons.math3.geometry.Vector)">checkPoint</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#contains(org.apache.commons.math3.geometry.partitioning.Region)">contains</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#copySelf()">copySelf</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#getBarycenter()">getBarycenter</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#getBoundarySize()">getBoundarySize</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#getSize()">getSize</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#getTolerance()">getTolerance</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#getTree(boolean)">getTree</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#intersection(org.apache.commons.math3.geometry.partitioning.SubHyperplane)">intersection</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#isEmpty()">isEmpty</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#isEmpty(org.apache.commons.math3.geometry.partitioning.BSPTree)">isEmpty</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#isFull()">isFull</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#isFull(org.apache.commons.math3.geometry.partitioning.BSPTree)">isFull</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#setBarycenter(org.apache.commons.math3.geometry.Point)">setBarycenter</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#setBarycenter(org.apache.commons.math3.geometry.Vector)">setBarycenter</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#setSize(double)">setSize</a>, <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#side(org.apache.commons.math3.geometry.partitioning.Hyperplane)">side</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" 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="ArcsSet(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ArcsSet</h4>
<pre>public&nbsp;ArcsSet(double&nbsp;tolerance)</pre>
<div class="block">Build an arcs set representing the whole circle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tolerance</code> - tolerance below which close sub-arcs are merged together</dd></dl>
</li>
</ul>
<a name="ArcsSet(double, double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ArcsSet</h4>
<pre>public&nbsp;ArcsSet(double&nbsp;lower,
double&nbsp;upper,
double&nbsp;tolerance)
throws <a href="../../../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></pre>
<div class="block">Build an arcs set corresponding to a single arc.
<p>
If either <code>lower</code> is equals to <code>upper</code> or
the interval exceeds \( 2 \pi \), the arc is considered
to be the full circle and its initial defining boundaries
will be forgotten. <code>lower</code> is not allowed to be greater
than <code>upper</code> (an exception is thrown in this case).
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lower</code> - lower bound of the arc</dd><dd><code>upper</code> - upper bound of the arc</dd><dd><code>tolerance</code> - tolerance below which close sub-arcs are merged together</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if lower is greater than upper</dd></dl>
</li>
</ul>
<a name="ArcsSet(org.apache.commons.math3.geometry.partitioning.BSPTree, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ArcsSet</h4>
<pre>public&nbsp;ArcsSet(<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/BSPTree.html" title="class in org.apache.commons.math3.geometry.partitioning">BSPTree</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;&nbsp;tree,
double&nbsp;tolerance)
throws <a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.InconsistentStateAt2PiWrapping.html" title="class in org.apache.commons.math3.geometry.spherical.oned">ArcsSet.InconsistentStateAt2PiWrapping</a></pre>
<div class="block">Build an arcs set from an inside/outside BSP tree.
<p>The leaf nodes of the BSP tree <em>must</em> have a
<code>Boolean</code> attribute representing the inside status of
the corresponding cell (true for inside cells, false for outside
cells). In order to avoid building too many small objects, it is
recommended to use the predefined constants
<code>Boolean.TRUE</code> and <code>Boolean.FALSE</code></p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tree</code> - inside/outside BSP tree representing the arcs set</dd><dd><code>tolerance</code> - tolerance below which close sub-arcs are merged together</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.InconsistentStateAt2PiWrapping.html" title="class in org.apache.commons.math3.geometry.spherical.oned">ArcsSet.InconsistentStateAt2PiWrapping</a></code> - if the tree leaf nodes are not
consistent across the \( 0, 2 \pi \) crossing</dd></dl>
</li>
</ul>
<a name="ArcsSet(java.util.Collection, double)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ArcsSet</h4>
<pre>public&nbsp;ArcsSet(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning">SubHyperplane</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;&gt;&nbsp;boundary,
double&nbsp;tolerance)
throws <a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.InconsistentStateAt2PiWrapping.html" title="class in org.apache.commons.math3.geometry.spherical.oned">ArcsSet.InconsistentStateAt2PiWrapping</a></pre>
<div class="block">Build an arcs set from a Boundary REPresentation (B-rep).
<p>The boundary is provided as a collection of <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/SubHyperplane.html" title="interface in org.apache.commons.math3.geometry.partitioning"><code>sub-hyperplanes</code></a>. Each sub-hyperplane has the
interior part of the region on its minus side and the exterior on
its plus side.</p>
<p>The boundary elements can be in any order, and can form
several non-connected sets (like for example polygons with holes
or a set of disjoints polyhedrons considered as a whole). In
fact, the elements do not even need to be connected together
(their topological connections are not used here). However, if the
boundary does not really separate an inside open from an outside
open (open having here its topological meaning), then subsequent
calls to the <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html#checkPoint(org.apache.commons.math3.geometry.Point)"><code>checkPoint</code></a> method will not be meaningful anymore.</p>
<p>If the boundary is empty, the region will represent the whole
space.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>boundary</code> - collection of boundary elements</dd><dd><code>tolerance</code> - tolerance below which close sub-arcs are merged together</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.InconsistentStateAt2PiWrapping.html" title="class in org.apache.commons.math3.geometry.spherical.oned">ArcsSet.InconsistentStateAt2PiWrapping</a></code> - if the tree leaf nodes are not
consistent across the \( 0, 2 \pi \) crossing</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.BSPTree)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildNew</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html" title="class in org.apache.commons.math3.geometry.spherical.oned">ArcsSet</a>&nbsp;buildNew(<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/BSPTree.html" title="class in org.apache.commons.math3.geometry.partitioning">BSPTree</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;&nbsp;tree)</pre>
<div class="block">Build a region using the instance as a prototype.
<p>This method allow to create new instances without knowing
exactly the type of the region. It is an application of the
prototype design pattern.</p>
<p>The leaf nodes of the BSP tree <em>must</em> have a
<code>Boolean</code> attribute representing the inside status of
the corresponding cell (true for inside cells, false for outside
cells). In order to avoid building too many small objects, it is
recommended to use the predefined constants
<code>Boolean.TRUE</code> and <code>Boolean.FALSE</code>. The
tree also <em>must</em> have either null internal nodes or
internal nodes representing the boundary as specified in the
<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html#getTree(boolean)"><code>getTree</code></a> method).</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html#buildNew(org.apache.commons.math3.geometry.partitioning.BSPTree)">buildNew</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning">Region</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#buildNew(org.apache.commons.math3.geometry.partitioning.BSPTree)">buildNew</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractRegion</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>,<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>tree</code> - inside/outside BSP tree representing the new region</dd>
<dt><span class="strong">Returns:</span></dt><dd>the built region</dd></dl>
</li>
</ul>
<a name="computeGeometricalProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeGeometricalProperties</h4>
<pre>protected&nbsp;void&nbsp;computeGeometricalProperties()</pre>
<div class="block">Compute some geometrical properties.
<p>The properties to compute are the barycenter and the size.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#computeGeometricalProperties()">computeGeometricalProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractRegion</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>,<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="projectToBoundary(org.apache.commons.math3.geometry.Point)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>projectToBoundary</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/BoundaryProjection.html" title="class in org.apache.commons.math3.geometry.partitioning">BoundaryProjection</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;&nbsp;projectToBoundary(<a href="../../../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;&nbsp;point)</pre>
<div class="block">Project a point on the boundary of the region.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html#projectToBoundary(org.apache.commons.math3.geometry.Point)">projectToBoundary</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Region.html" title="interface in org.apache.commons.math3.geometry.partitioning">Region</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html#projectToBoundary(org.apache.commons.math3.geometry.Point)">projectToBoundary</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/AbstractRegion.html" title="class in org.apache.commons.math3.geometry.partitioning">AbstractRegion</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>,<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Sphere1D.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Sphere1D</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>point</code> - point to check</dd>
<dt><span class="strong">Returns:</span></dt><dd>projection of the point on the boundary</dd><dt><span class="strong">Since:</span></dt>
<dd>3.3</dd></dl>
</li>
</ul>
<a name="asList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asList</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Arc.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Arc</a>&gt;&nbsp;asList()</pre>
<div class="block">Build an ordered list of arcs representing the instance.
<p>This method builds this arcs set as an ordered list of
<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Arc.html" title="class in org.apache.commons.math3.geometry.spherical.oned"><code>Arc</code></a> elements. An empty tree will build an empty list
while a tree representing the whole circle will build a one
element list with bounds set to \( 0 and 2 \pi \).</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a new ordered list containing <a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Arc.html" title="class in org.apache.commons.math3.geometry.spherical.oned"><code>Arc</code></a> elements</dd></dl>
</li>
</ul>
<a name="iterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;double[]&gt;&nbsp;iterator()</pre>
<div class="block">
<p>
The iterator returns the limit angles pairs of sub-arcs in trigonometric order.
</p>
<p>
The iterator does <em>not</em> support the optional <code>remove</code> operation.
</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;double[]&gt;</code></dd>
</dl>
</li>
</ul>
<a name="side(org.apache.commons.math3.geometry.spherical.oned.Arc)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>side</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Side.html" title="enum in org.apache.commons.math3.geometry.partitioning">Side</a>&nbsp;side(<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Arc.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Arc</a>&nbsp;arc)</pre>
<div class="block">Compute the relative position of the instance with respect
to an arc.
<p>
The <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Side.html#MINUS"><code>Side.MINUS</code></a> side of the arc is the one covered by the arc.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>arc</code> - arc 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>
or <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.spherical.oned.Arc)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>split</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.Split.html" title="class in org.apache.commons.math3.geometry.spherical.oned">ArcsSet.Split</a>&nbsp;split(<a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/Arc.html" title="class in org.apache.commons.math3.geometry.spherical.oned">Arc</a>&nbsp;arc)</pre>
<div class="block">Split the instance in two parts by an arc.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>arc</code> - splitting arc</dd>
<dt><span class="strong">Returns:</span></dt><dd>an object containing both the part of the instance
on the plus side of the arc and the part of the
instance on the minus side of the arc</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/ArcsSet.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/spherical/oned/Arc.html" title="class in org.apache.commons.math3.geometry.spherical.oned"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/commons/math3/geometry/spherical/oned/ArcsSet.InconsistentStateAt2PiWrapping.html" title="class in org.apache.commons.math3.geometry.spherical.oned"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/commons/math3/geometry/spherical/oned/ArcsSet.html" target="_top">Frames</a></li>
<li><a href="ArcsSet.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:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2003&#x2013;2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>