annotate libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/complex/ComplexUtils.html @ 13:cbf34dd4d7e6

commons-math-2.1 added
author dwinter
date Tue, 04 Jan 2011 10:02:07 +0100
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
1 <HTML>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
2 <BODY BGCOLOR="white">
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
3 <PRE>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
4 <FONT color="green">001</FONT> /*<a name="line.1"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
5 <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
6 <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
7 <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
8 <FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
9 <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
10 <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
11 <FONT color="green">008</FONT> *<a name="line.8"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
12 <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
13 <FONT color="green">010</FONT> *<a name="line.10"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
14 <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
15 <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
16 <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
17 <FONT color="green">014</FONT> * See the License for the specific language governing permissions and<a name="line.14"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
18 <FONT color="green">015</FONT> * limitations under the License.<a name="line.15"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
19 <FONT color="green">016</FONT> */<a name="line.16"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
20 <FONT color="green">017</FONT> <a name="line.17"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
21 <FONT color="green">018</FONT> package org.apache.commons.math.complex;<a name="line.18"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
22 <FONT color="green">019</FONT> <a name="line.19"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
23 <FONT color="green">020</FONT> import org.apache.commons.math.MathRuntimeException;<a name="line.20"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
24 <FONT color="green">021</FONT> <a name="line.21"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
25 <FONT color="green">022</FONT> /**<a name="line.22"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
26 <FONT color="green">023</FONT> * Static implementations of common<a name="line.23"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
27 <FONT color="green">024</FONT> * {@link org.apache.commons.math.complex.Complex} utilities functions.<a name="line.24"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
28 <FONT color="green">025</FONT> *<a name="line.25"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
29 <FONT color="green">026</FONT> * @version $Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $<a name="line.26"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
30 <FONT color="green">027</FONT> */<a name="line.27"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
31 <FONT color="green">028</FONT> public class ComplexUtils {<a name="line.28"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
32 <FONT color="green">029</FONT> <a name="line.29"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
33 <FONT color="green">030</FONT> /**<a name="line.30"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
34 <FONT color="green">031</FONT> * Default constructor.<a name="line.31"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
35 <FONT color="green">032</FONT> */<a name="line.32"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
36 <FONT color="green">033</FONT> private ComplexUtils() {<a name="line.33"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
37 <FONT color="green">034</FONT> super();<a name="line.34"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
38 <FONT color="green">035</FONT> }<a name="line.35"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
39 <FONT color="green">036</FONT> <a name="line.36"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
40 <FONT color="green">037</FONT> /**<a name="line.37"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
41 <FONT color="green">038</FONT> * Creates a complex number from the given polar representation.<a name="line.38"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
42 <FONT color="green">039</FONT> * &lt;p&gt;<a name="line.39"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
43 <FONT color="green">040</FONT> * The value returned is &lt;code&gt;r&amp;middot;e&lt;sup&gt;i&amp;middot;theta&lt;/sup&gt;&lt;/code&gt;,<a name="line.40"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
44 <FONT color="green">041</FONT> * computed as &lt;code&gt;r&amp;middot;cos(theta) + r&amp;middot;sin(theta)i&lt;/code&gt;&lt;/p&gt;<a name="line.41"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
45 <FONT color="green">042</FONT> * &lt;p&gt;<a name="line.42"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
46 <FONT color="green">043</FONT> * If either &lt;code&gt;r&lt;/code&gt; or &lt;code&gt;theta&lt;/code&gt; is NaN, or<a name="line.43"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
47 <FONT color="green">044</FONT> * &lt;code&gt;theta&lt;/code&gt; is infinite, {@link Complex#NaN} is returned.&lt;/p&gt;<a name="line.44"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
48 <FONT color="green">045</FONT> * &lt;p&gt;<a name="line.45"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
49 <FONT color="green">046</FONT> * If &lt;code&gt;r&lt;/code&gt; is infinite and &lt;code&gt;theta&lt;/code&gt; is finite,<a name="line.46"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
50 <FONT color="green">047</FONT> * infinite or NaN values may be returned in parts of the result, following<a name="line.47"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
51 <FONT color="green">048</FONT> * the rules for double arithmetic.&lt;pre&gt;<a name="line.48"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
52 <FONT color="green">049</FONT> * Examples:<a name="line.49"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
53 <FONT color="green">050</FONT> * &lt;code&gt;<a name="line.50"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
54 <FONT color="green">051</FONT> * polar2Complex(INFINITY, &amp;pi;/4) = INFINITY + INFINITY i<a name="line.51"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
55 <FONT color="green">052</FONT> * polar2Complex(INFINITY, 0) = INFINITY + NaN i<a name="line.52"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
56 <FONT color="green">053</FONT> * polar2Complex(INFINITY, -&amp;pi;/4) = INFINITY - INFINITY i<a name="line.53"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
57 <FONT color="green">054</FONT> * polar2Complex(INFINITY, 5&amp;pi;/4) = -INFINITY - INFINITY i &lt;/code&gt;&lt;/pre&gt;&lt;/p&gt;<a name="line.54"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
58 <FONT color="green">055</FONT> *<a name="line.55"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
59 <FONT color="green">056</FONT> * @param r the modulus of the complex number to create<a name="line.56"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
60 <FONT color="green">057</FONT> * @param theta the argument of the complex number to create<a name="line.57"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
61 <FONT color="green">058</FONT> * @return &lt;code&gt;r&amp;middot;e&lt;sup&gt;i&amp;middot;theta&lt;/sup&gt;&lt;/code&gt;<a name="line.58"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
62 <FONT color="green">059</FONT> * @throws IllegalArgumentException if r is negative<a name="line.59"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
63 <FONT color="green">060</FONT> * @since 1.1<a name="line.60"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
64 <FONT color="green">061</FONT> */<a name="line.61"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
65 <FONT color="green">062</FONT> public static Complex polar2Complex(double r, double theta) {<a name="line.62"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
66 <FONT color="green">063</FONT> if (r &lt; 0) {<a name="line.63"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
67 <FONT color="green">064</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.64"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
68 <FONT color="green">065</FONT> "negative complex module {0}", r);<a name="line.65"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
69 <FONT color="green">066</FONT> }<a name="line.66"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
70 <FONT color="green">067</FONT> return new Complex(r * Math.cos(theta), r * Math.sin(theta));<a name="line.67"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
71 <FONT color="green">068</FONT> }<a name="line.68"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
72 <FONT color="green">069</FONT> <a name="line.69"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
73 <FONT color="green">070</FONT> }<a name="line.70"></a>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
74
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
75
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
76
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
77
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
78
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
79
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
80
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
81
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
82
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
83
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
84
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
85
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
86
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
87
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
88
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
89
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
90
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
91
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
92
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
93
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
94
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
95
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
96
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
97
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
98
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
99
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
100
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
101
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
102
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
103
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
104
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
105
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
106
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
107
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
108
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
109
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
110
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
111
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
112
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
113
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
114
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
115
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
116
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
117
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
118
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
119
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
120
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
121
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
122
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
123
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
124
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
125
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
126
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
127
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
128
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
129
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
130
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
131
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
132
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
133
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
134 </PRE>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
135 </BODY>
cbf34dd4d7e6 commons-math-2.1 added
dwinter
parents:
diff changeset
136 </HTML>