677 lines
31 KiB
HTML
677 lines
31 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_51) on Wed Apr 06 13:11:04 EDT 2016 -->
|
|
<title>XYSeriesComplex (Parallel Java 2 Library Documentation)</title>
|
|
<meta name="date" content="2016-04-06">
|
|
<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="XYSeriesComplex (Parallel Java 2 Library Documentation)";
|
|
}
|
|
//-->
|
|
</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/XYSeriesComplex.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../edu/rit/numeric/XYSeries.Regression.html" title="class in edu.rit.numeric"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../edu/rit/numeric/XYZSeries.html" title="class in edu.rit.numeric"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?edu/rit/numeric/XYSeriesComplex.html" target="_top">Frames</a></li>
|
|
<li><a href="XYSeriesComplex.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">edu.rit.numeric</div>
|
|
<h2 title="Class XYSeriesComplex" class="title">Class XYSeriesComplex</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>edu.rit.numeric.XYSeriesComplex</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public abstract class <span class="strong">XYSeriesComplex</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></pre>
|
|
<div class="block">Class XYSeriesComplex is the abstract base class for a series of (<I>x,y</I>)
|
|
pairs of values where the <I>x</I> values are real (type <TT>double</TT>) and
|
|
the <I>y</I> values are complex (type <TT>double</TT>).</div>
|
|
</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="../../../edu/rit/numeric/XYSeriesComplex.html#XYSeriesComplex()">XYSeriesComplex</a></strong>()</code>
|
|
<div class="block">Construct a new complex XY series.</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>abstract double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#imag(int)">imag</a></strong>(int i)</code>
|
|
<div class="block">Returns the imaginary part of the given complex <I>y</I> value in this
|
|
complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Series.html" title="class in edu.rit.numeric">Series</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#imagSeries()">imagSeries</a></strong>()</code>
|
|
<div class="block">Returns a new series consisting of the imaginary parts of the complex
|
|
<I>y</I> values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/numeric/XYSeries.html" title="class in edu.rit.numeric">XYSeries</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#imagXYSeries()">imagXYSeries</a></strong>()</code>
|
|
<div class="block">Returns a new XY series consisting of the <I>x</I> values and the
|
|
imaginary parts of the complex <I>y</I> values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#isEmpty()">isEmpty</a></strong>()</code>
|
|
<div class="block">Determine if this complex XY series is empty.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>abstract int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#length()">length</a></strong>()</code>
|
|
<div class="block">Returns the number of values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#magnitude(int)">magnitude</a></strong>(int i)</code>
|
|
<div class="block">Returns the magnitude of the given complex <I>y</I> value in this complex
|
|
XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Series.html" title="class in edu.rit.numeric">Series</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#magnitudeSeries()">magnitudeSeries</a></strong>()</code>
|
|
<div class="block">Returns a new series consisting of the magnitudes of the complex <I>y</I>
|
|
values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/numeric/XYSeries.html" title="class in edu.rit.numeric">XYSeries</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#magnitudeXYSeries()">magnitudeXYSeries</a></strong>()</code>
|
|
<div class="block">Returns a new XY series consisting of the <I>x</I> values and the
|
|
magnitudes of the complex <I>y</I> values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#phase(int)">phase</a></strong>(int i)</code>
|
|
<div class="block">Returns the phase of the given complex <I>y</I> value in this complex XY
|
|
series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Series.html" title="class in edu.rit.numeric">Series</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#phaseSeries()">phaseSeries</a></strong>()</code>
|
|
<div class="block">Returns a new series consisting of the phases of the complex <I>y</I>
|
|
values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/numeric/XYSeries.html" title="class in edu.rit.numeric">XYSeries</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#phaseXYSeries()">phaseXYSeries</a></strong>()</code>
|
|
<div class="block">Returns a new XY series consisting of the <I>x</I> values and the phases
|
|
of the complex <I>y</I> values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#print()">print</a></strong>()</code>
|
|
<div class="block">Print this complex XY series on the standard output.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#print(java.io.PrintStream)">print</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> theStream)</code>
|
|
<div class="block">Print this complex XY series on the given print stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#print(java.io.PrintWriter)">print</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> theWriter)</code>
|
|
<div class="block">Print this complex XY series on the given print writer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>abstract double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#real(int)">real</a></strong>(int i)</code>
|
|
<div class="block">Returns the real part of the given complex <I>y</I> value in this complex
|
|
XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Series.html" title="class in edu.rit.numeric">Series</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#realSeries()">realSeries</a></strong>()</code>
|
|
<div class="block">Returns a new series consisting of the real parts of the complex <I>y</I>
|
|
values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/numeric/XYSeries.html" title="class in edu.rit.numeric">XYSeries</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#realXYSeries()">realXYSeries</a></strong>()</code>
|
|
<div class="block">Returns a new XY series consisting of the <I>x</I> values and the real
|
|
parts of the complex <I>y</I> values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#squaredMagnitude(int)">squaredMagnitude</a></strong>(int i)</code>
|
|
<div class="block">Returns the squared magnitude of the given complex <I>y</I> value in this
|
|
complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Series.html" title="class in edu.rit.numeric">Series</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#squaredMagnitudeSeries()">squaredMagnitudeSeries</a></strong>()</code>
|
|
<div class="block">Returns a new series consisting of the squared magnitudes of the complex
|
|
<I>y</I> values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/numeric/XYSeries.html" title="class in edu.rit.numeric">XYSeries</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#squaredMagnitudeXYSeries()">squaredMagnitudeXYSeries</a></strong>()</code>
|
|
<div class="block">Returns a new XY series consisting of the <I>x</I> values and the squared
|
|
magnitudes of the complex <I>y</I> values in this complex XY series.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>abstract double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/XYSeriesComplex.html#x(int)">x</a></strong>(int i)</code>
|
|
<div class="block">Returns the given <I>x</I> value in this complex XY series.</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, 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="XYSeriesComplex()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>XYSeriesComplex</h4>
|
|
<pre>public XYSeriesComplex()</pre>
|
|
<div class="block">Construct a new complex XY series.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="length()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>length</h4>
|
|
<pre>public abstract int length()</pre>
|
|
<div class="block">Returns the number of values in this complex XY series.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="isEmpty()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isEmpty</h4>
|
|
<pre>public boolean isEmpty()</pre>
|
|
<div class="block">Determine if this complex XY series is empty.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>True if this series is empty (length = 0), false otherwise.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="x(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>x</h4>
|
|
<pre>public abstract double x(int i)</pre>
|
|
<div class="block">Returns the given <I>x</I> value in this complex XY series.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - Index.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The <I>x</I> value in this series at index <TT>i</TT>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">ArrayIndexOutOfBoundsException</a></code> - (unchecked exception) Thrown if <TT>i</TT> is not in the range
|
|
<TT>0</TT> .. <TT>length()-1</TT>.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="real(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>real</h4>
|
|
<pre>public abstract double real(int i)</pre>
|
|
<div class="block">Returns the real part of the given complex <I>y</I> value in this complex
|
|
XY series.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - Index.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The real part of the complex <I>y</I> value in this series at
|
|
index <TT>i</TT>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">ArrayIndexOutOfBoundsException</a></code> - (unchecked exception) Thrown if <TT>i</TT> is not in the range
|
|
<TT>0</TT> .. <TT>length()-1</TT>.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="imag(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>imag</h4>
|
|
<pre>public abstract double imag(int i)</pre>
|
|
<div class="block">Returns the imaginary part of the given complex <I>y</I> value in this
|
|
complex XY series.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - Index.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The imaginary part of the complex <I>y</I> value in this series
|
|
at index <TT>i</TT>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">ArrayIndexOutOfBoundsException</a></code> - (unchecked exception) Thrown if <TT>i</TT> is not in the range
|
|
<TT>0</TT> .. <TT>length()-1</TT>.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="magnitude(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>magnitude</h4>
|
|
<pre>public double magnitude(int i)</pre>
|
|
<div class="block">Returns the magnitude of the given complex <I>y</I> value in this complex
|
|
XY series. The magnitude is greater than or equal to 0.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - Index.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The magnitude of the complex <I>y</I> value in this series at
|
|
index <TT>i</TT>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">ArrayIndexOutOfBoundsException</a></code> - (unchecked exception) Thrown if <TT>i</TT> is not in the range
|
|
<TT>0</TT> .. <TT>length()-1</TT>.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="squaredMagnitude(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>squaredMagnitude</h4>
|
|
<pre>public double squaredMagnitude(int i)</pre>
|
|
<div class="block">Returns the squared magnitude of the given complex <I>y</I> value in this
|
|
complex XY series.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - Index.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The squared magnitude of the complex <I>y</I> value in this
|
|
series at index <TT>i</TT>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">ArrayIndexOutOfBoundsException</a></code> - (unchecked exception) Thrown if <TT>i</TT> is not in the range
|
|
<TT>0</TT> .. <TT>length()-1</TT>.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="phase(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>phase</h4>
|
|
<pre>public double phase(int i)</pre>
|
|
<div class="block">Returns the phase of the given complex <I>y</I> value in this complex XY
|
|
series. The phase is in the range -pi to +pi.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - Index.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The phase of the complex <I>y</I> value in this series at index
|
|
<TT>i</TT>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">ArrayIndexOutOfBoundsException</a></code> - (unchecked exception) Thrown if <TT>i</TT> is not in the range
|
|
<TT>0</TT> .. <TT>length()-1</TT>.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="realSeries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>realSeries</h4>
|
|
<pre>public <a href="../../../edu/rit/numeric/Series.html" title="class in edu.rit.numeric">Series</a> realSeries()</pre>
|
|
<div class="block">Returns a new series consisting of the real parts of the complex <I>y</I>
|
|
values in this complex XY series.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Series of real parts.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="imagSeries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>imagSeries</h4>
|
|
<pre>public <a href="../../../edu/rit/numeric/Series.html" title="class in edu.rit.numeric">Series</a> imagSeries()</pre>
|
|
<div class="block">Returns a new series consisting of the imaginary parts of the complex
|
|
<I>y</I> values in this complex XY series.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Series of imaginary parts.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="magnitudeSeries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>magnitudeSeries</h4>
|
|
<pre>public <a href="../../../edu/rit/numeric/Series.html" title="class in edu.rit.numeric">Series</a> magnitudeSeries()</pre>
|
|
<div class="block">Returns a new series consisting of the magnitudes of the complex <I>y</I>
|
|
values in this complex XY series. Each magnitude is greater than or equal
|
|
to 0.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Series of magnitudes.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="squaredMagnitudeSeries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>squaredMagnitudeSeries</h4>
|
|
<pre>public <a href="../../../edu/rit/numeric/Series.html" title="class in edu.rit.numeric">Series</a> squaredMagnitudeSeries()</pre>
|
|
<div class="block">Returns a new series consisting of the squared magnitudes of the complex
|
|
<I>y</I> values in this complex XY series.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Series of squared magnitudes.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="phaseSeries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>phaseSeries</h4>
|
|
<pre>public <a href="../../../edu/rit/numeric/Series.html" title="class in edu.rit.numeric">Series</a> phaseSeries()</pre>
|
|
<div class="block">Returns a new series consisting of the phases of the complex <I>y</I>
|
|
values in this complex XY series. Each phase is in the range -pi to +pi.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Series of phases.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="realXYSeries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>realXYSeries</h4>
|
|
<pre>public <a href="../../../edu/rit/numeric/XYSeries.html" title="class in edu.rit.numeric">XYSeries</a> realXYSeries()</pre>
|
|
<div class="block">Returns a new XY series consisting of the <I>x</I> values and the real
|
|
parts of the complex <I>y</I> values in this complex XY series.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>XY series of real parts.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="imagXYSeries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>imagXYSeries</h4>
|
|
<pre>public <a href="../../../edu/rit/numeric/XYSeries.html" title="class in edu.rit.numeric">XYSeries</a> imagXYSeries()</pre>
|
|
<div class="block">Returns a new XY series consisting of the <I>x</I> values and the
|
|
imaginary parts of the complex <I>y</I> values in this complex XY series.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>XY series of imaginary parts.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="magnitudeXYSeries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>magnitudeXYSeries</h4>
|
|
<pre>public <a href="../../../edu/rit/numeric/XYSeries.html" title="class in edu.rit.numeric">XYSeries</a> magnitudeXYSeries()</pre>
|
|
<div class="block">Returns a new XY series consisting of the <I>x</I> values and the
|
|
magnitudes of the complex <I>y</I> values in this complex XY series. Each
|
|
magnitude is greater than or equal to 0.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>XY series of magnitudes.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="squaredMagnitudeXYSeries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>squaredMagnitudeXYSeries</h4>
|
|
<pre>public <a href="../../../edu/rit/numeric/XYSeries.html" title="class in edu.rit.numeric">XYSeries</a> squaredMagnitudeXYSeries()</pre>
|
|
<div class="block">Returns a new XY series consisting of the <I>x</I> values and the squared
|
|
magnitudes of the complex <I>y</I> values in this complex XY series.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>XY series of squared magnitudes.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="phaseXYSeries()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>phaseXYSeries</h4>
|
|
<pre>public <a href="../../../edu/rit/numeric/XYSeries.html" title="class in edu.rit.numeric">XYSeries</a> phaseXYSeries()</pre>
|
|
<div class="block">Returns a new XY series consisting of the <I>x</I> values and the phases
|
|
of the complex <I>y</I> values in this complex XY series. Each phase is
|
|
in the range -pi to +pi.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>XY series of phases.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="print()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>print</h4>
|
|
<pre>public void print()</pre>
|
|
<div class="block">Print this complex XY series on the standard output. Each line of output
|
|
consists of the index, the <I>x</I> value, the <I>y</I> value's real
|
|
part, the <I>y</I> value's imaginary part, the <I>y</I> value's
|
|
magnitude, and the <I>y</I> value's phase, separated by tabs.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="print(java.io.PrintStream)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>print</h4>
|
|
<pre>public void print(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> theStream)</pre>
|
|
<div class="block">Print this complex XY series on the given print stream. Each line of
|
|
output consists of the index, the <I>x</I> value, the <I>y</I> value's
|
|
real part, the <I>y</I> value's imaginary part, the <I>y</I> value's
|
|
magnitude, and the <I>y</I> value's phase, separated by tabs.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theStream</code> - Print stream.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="print(java.io.PrintWriter)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>print</h4>
|
|
<pre>public void print(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> theWriter)</pre>
|
|
<div class="block">Print this complex XY series on the given print writer. Each line of
|
|
output consists of the index, the <I>x</I> value, the <I>y</I> value's
|
|
real part, the <I>y</I> value's imaginary part, the <I>y</I> value's
|
|
magnitude, and the <I>y</I> value's phase, separated by tabs.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theWriter</code> - Print writer.</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/XYSeriesComplex.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../edu/rit/numeric/XYSeries.Regression.html" title="class in edu.rit.numeric"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../edu/rit/numeric/XYZSeries.html" title="class in edu.rit.numeric"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?edu/rit/numeric/XYSeriesComplex.html" target="_top">Frames</a></li>
|
|
<li><a href="XYSeriesComplex.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><FONT SIZE="-2">Copyright © 2013–2016 by Alan Kaminsky. All rights reserved. Send comments to ark</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">@</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">cs.rit.edu.</FONT></small></p>
|
|
</body>
|
|
</html>
|