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

commons-math-2.1 added
author dwinter
date Tue, 04 Jan 2011 10:02:07 +0100
parents
children
line wrap: on
line source

<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.math.complex;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.text.FieldPosition;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.text.NumberFormat;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.text.ParseException;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.text.ParsePosition;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.Locale;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.commons.math.MathRuntimeException;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.commons.math.util.CompositeFormat;<a name="line.27"></a>
<FONT color="green">028</FONT>    <a name="line.28"></a>
<FONT color="green">029</FONT>    /**<a name="line.29"></a>
<FONT color="green">030</FONT>     * Formats a Complex number in cartesian format "Re(c) + Im(c)i".  'i' can<a name="line.30"></a>
<FONT color="green">031</FONT>     * be replaced with 'j' (or anything else), and the number format for both real<a name="line.31"></a>
<FONT color="green">032</FONT>     * and imaginary parts can be configured.<a name="line.32"></a>
<FONT color="green">033</FONT>     *<a name="line.33"></a>
<FONT color="green">034</FONT>     * @version $Revision: 811783 $ $Date: 2009-09-06 04:56:58 -0400 (Sun, 06 Sep 2009) $<a name="line.34"></a>
<FONT color="green">035</FONT>     */<a name="line.35"></a>
<FONT color="green">036</FONT>    public class ComplexFormat extends CompositeFormat {<a name="line.36"></a>
<FONT color="green">037</FONT>    <a name="line.37"></a>
<FONT color="green">038</FONT>        /** Serializable version identifier */<a name="line.38"></a>
<FONT color="green">039</FONT>        private static final long serialVersionUID = -3343698360149467646L;<a name="line.39"></a>
<FONT color="green">040</FONT>    <a name="line.40"></a>
<FONT color="green">041</FONT>         /** The default imaginary character. */<a name="line.41"></a>
<FONT color="green">042</FONT>        private static final String DEFAULT_IMAGINARY_CHARACTER = "i";<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>        /** The notation used to signify the imaginary part of the complex number. */<a name="line.44"></a>
<FONT color="green">045</FONT>        private String imaginaryCharacter;<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>        /** The format used for the imaginary part. */<a name="line.47"></a>
<FONT color="green">048</FONT>        private NumberFormat imaginaryFormat;<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>        /** The format used for the real part. */<a name="line.50"></a>
<FONT color="green">051</FONT>        private NumberFormat realFormat;<a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>        /**<a name="line.53"></a>
<FONT color="green">054</FONT>         * Create an instance with the default imaginary character, 'i', and the<a name="line.54"></a>
<FONT color="green">055</FONT>         * default number format for both real and imaginary parts.<a name="line.55"></a>
<FONT color="green">056</FONT>         */<a name="line.56"></a>
<FONT color="green">057</FONT>        public ComplexFormat() {<a name="line.57"></a>
<FONT color="green">058</FONT>            this(DEFAULT_IMAGINARY_CHARACTER, getDefaultNumberFormat());<a name="line.58"></a>
<FONT color="green">059</FONT>        }<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>        /**<a name="line.61"></a>
<FONT color="green">062</FONT>         * Create an instance with a custom number format for both real and<a name="line.62"></a>
<FONT color="green">063</FONT>         * imaginary parts.<a name="line.63"></a>
<FONT color="green">064</FONT>         * @param format the custom format for both real and imaginary parts.<a name="line.64"></a>
<FONT color="green">065</FONT>         */<a name="line.65"></a>
<FONT color="green">066</FONT>        public ComplexFormat(NumberFormat format) {<a name="line.66"></a>
<FONT color="green">067</FONT>            this(DEFAULT_IMAGINARY_CHARACTER, format);<a name="line.67"></a>
<FONT color="green">068</FONT>        }<a name="line.68"></a>
<FONT color="green">069</FONT>    <a name="line.69"></a>
<FONT color="green">070</FONT>        /**<a name="line.70"></a>
<FONT color="green">071</FONT>         * Create an instance with a custom number format for the real part and a<a name="line.71"></a>
<FONT color="green">072</FONT>         * custom number format for the imaginary part.<a name="line.72"></a>
<FONT color="green">073</FONT>         * @param realFormat the custom format for the real part.<a name="line.73"></a>
<FONT color="green">074</FONT>         * @param imaginaryFormat the custom format for the imaginary part.<a name="line.74"></a>
<FONT color="green">075</FONT>         */<a name="line.75"></a>
<FONT color="green">076</FONT>        public ComplexFormat(NumberFormat realFormat, NumberFormat imaginaryFormat) {<a name="line.76"></a>
<FONT color="green">077</FONT>            this(DEFAULT_IMAGINARY_CHARACTER, realFormat, imaginaryFormat);<a name="line.77"></a>
<FONT color="green">078</FONT>        }<a name="line.78"></a>
<FONT color="green">079</FONT>    <a name="line.79"></a>
<FONT color="green">080</FONT>        /**<a name="line.80"></a>
<FONT color="green">081</FONT>         * Create an instance with a custom imaginary character, and the default<a name="line.81"></a>
<FONT color="green">082</FONT>         * number format for both real and imaginary parts.<a name="line.82"></a>
<FONT color="green">083</FONT>         * @param imaginaryCharacter The custom imaginary character.<a name="line.83"></a>
<FONT color="green">084</FONT>         */<a name="line.84"></a>
<FONT color="green">085</FONT>        public ComplexFormat(String imaginaryCharacter) {<a name="line.85"></a>
<FONT color="green">086</FONT>            this(imaginaryCharacter, getDefaultNumberFormat());<a name="line.86"></a>
<FONT color="green">087</FONT>        }<a name="line.87"></a>
<FONT color="green">088</FONT>    <a name="line.88"></a>
<FONT color="green">089</FONT>        /**<a name="line.89"></a>
<FONT color="green">090</FONT>         * Create an instance with a custom imaginary character, and a custom number<a name="line.90"></a>
<FONT color="green">091</FONT>         * format for both real and imaginary parts.<a name="line.91"></a>
<FONT color="green">092</FONT>         * @param imaginaryCharacter The custom imaginary character.<a name="line.92"></a>
<FONT color="green">093</FONT>         * @param format the custom format for both real and imaginary parts.<a name="line.93"></a>
<FONT color="green">094</FONT>         */<a name="line.94"></a>
<FONT color="green">095</FONT>        public ComplexFormat(String imaginaryCharacter, NumberFormat format) {<a name="line.95"></a>
<FONT color="green">096</FONT>            this(imaginaryCharacter, format, (NumberFormat)format.clone());<a name="line.96"></a>
<FONT color="green">097</FONT>        }<a name="line.97"></a>
<FONT color="green">098</FONT>    <a name="line.98"></a>
<FONT color="green">099</FONT>        /**<a name="line.99"></a>
<FONT color="green">100</FONT>         * Create an instance with a custom imaginary character, a custom number<a name="line.100"></a>
<FONT color="green">101</FONT>         * format for the real part, and a custom number format for the imaginary<a name="line.101"></a>
<FONT color="green">102</FONT>         * part.<a name="line.102"></a>
<FONT color="green">103</FONT>         * @param imaginaryCharacter The custom imaginary character.<a name="line.103"></a>
<FONT color="green">104</FONT>         * @param realFormat the custom format for the real part.<a name="line.104"></a>
<FONT color="green">105</FONT>         * @param imaginaryFormat the custom format for the imaginary part.<a name="line.105"></a>
<FONT color="green">106</FONT>         */<a name="line.106"></a>
<FONT color="green">107</FONT>        public ComplexFormat(String imaginaryCharacter, NumberFormat realFormat,<a name="line.107"></a>
<FONT color="green">108</FONT>                NumberFormat imaginaryFormat) {<a name="line.108"></a>
<FONT color="green">109</FONT>            super();<a name="line.109"></a>
<FONT color="green">110</FONT>            setImaginaryCharacter(imaginaryCharacter);<a name="line.110"></a>
<FONT color="green">111</FONT>            setImaginaryFormat(imaginaryFormat);<a name="line.111"></a>
<FONT color="green">112</FONT>            setRealFormat(realFormat);<a name="line.112"></a>
<FONT color="green">113</FONT>        }<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>        /**<a name="line.115"></a>
<FONT color="green">116</FONT>         * Get the set of locales for which complex formats are available.<a name="line.116"></a>
<FONT color="green">117</FONT>         * &lt;p&gt;This is the same set as the {@link NumberFormat} set.&lt;/p&gt;<a name="line.117"></a>
<FONT color="green">118</FONT>         * @return available complex format locales.<a name="line.118"></a>
<FONT color="green">119</FONT>         */<a name="line.119"></a>
<FONT color="green">120</FONT>        public static Locale[] getAvailableLocales() {<a name="line.120"></a>
<FONT color="green">121</FONT>            return NumberFormat.getAvailableLocales();<a name="line.121"></a>
<FONT color="green">122</FONT>        }<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>        /**<a name="line.124"></a>
<FONT color="green">125</FONT>         * This static method calls {@link #format(Object)} on a default instance of<a name="line.125"></a>
<FONT color="green">126</FONT>         * ComplexFormat.<a name="line.126"></a>
<FONT color="green">127</FONT>         *<a name="line.127"></a>
<FONT color="green">128</FONT>         * @param c Complex object to format<a name="line.128"></a>
<FONT color="green">129</FONT>         * @return A formatted number in the form "Re(c) + Im(c)i"<a name="line.129"></a>
<FONT color="green">130</FONT>         */<a name="line.130"></a>
<FONT color="green">131</FONT>        public static String formatComplex(Complex c) {<a name="line.131"></a>
<FONT color="green">132</FONT>            return getInstance().format(c);<a name="line.132"></a>
<FONT color="green">133</FONT>        }<a name="line.133"></a>
<FONT color="green">134</FONT>    <a name="line.134"></a>
<FONT color="green">135</FONT>        /**<a name="line.135"></a>
<FONT color="green">136</FONT>         * Formats a {@link Complex} object to produce a string.<a name="line.136"></a>
<FONT color="green">137</FONT>         *<a name="line.137"></a>
<FONT color="green">138</FONT>         * @param complex the object to format.<a name="line.138"></a>
<FONT color="green">139</FONT>         * @param toAppendTo where the text is to be appended<a name="line.139"></a>
<FONT color="green">140</FONT>         * @param pos On input: an alignment field, if desired. On output: the<a name="line.140"></a>
<FONT color="green">141</FONT>         *            offsets of the alignment field<a name="line.141"></a>
<FONT color="green">142</FONT>         * @return the value passed in as toAppendTo.<a name="line.142"></a>
<FONT color="green">143</FONT>         */<a name="line.143"></a>
<FONT color="green">144</FONT>        public StringBuffer format(Complex complex, StringBuffer toAppendTo,<a name="line.144"></a>
<FONT color="green">145</FONT>                FieldPosition pos) {<a name="line.145"></a>
<FONT color="green">146</FONT>    <a name="line.146"></a>
<FONT color="green">147</FONT>            pos.setBeginIndex(0);<a name="line.147"></a>
<FONT color="green">148</FONT>            pos.setEndIndex(0);<a name="line.148"></a>
<FONT color="green">149</FONT>    <a name="line.149"></a>
<FONT color="green">150</FONT>            // format real<a name="line.150"></a>
<FONT color="green">151</FONT>            double re = complex.getReal();<a name="line.151"></a>
<FONT color="green">152</FONT>            formatDouble(re, getRealFormat(), toAppendTo, pos);<a name="line.152"></a>
<FONT color="green">153</FONT>    <a name="line.153"></a>
<FONT color="green">154</FONT>            // format sign and imaginary<a name="line.154"></a>
<FONT color="green">155</FONT>            double im = complex.getImaginary();<a name="line.155"></a>
<FONT color="green">156</FONT>            if (im &lt; 0.0) {<a name="line.156"></a>
<FONT color="green">157</FONT>                toAppendTo.append(" - ");<a name="line.157"></a>
<FONT color="green">158</FONT>                formatDouble(-im, getImaginaryFormat(), toAppendTo, pos);<a name="line.158"></a>
<FONT color="green">159</FONT>                toAppendTo.append(getImaginaryCharacter());<a name="line.159"></a>
<FONT color="green">160</FONT>            } else if (im &gt; 0.0 || Double.isNaN(im)) {<a name="line.160"></a>
<FONT color="green">161</FONT>                toAppendTo.append(" + ");<a name="line.161"></a>
<FONT color="green">162</FONT>                formatDouble(im, getImaginaryFormat(), toAppendTo, pos);<a name="line.162"></a>
<FONT color="green">163</FONT>                toAppendTo.append(getImaginaryCharacter());<a name="line.163"></a>
<FONT color="green">164</FONT>            }<a name="line.164"></a>
<FONT color="green">165</FONT>    <a name="line.165"></a>
<FONT color="green">166</FONT>            return toAppendTo;<a name="line.166"></a>
<FONT color="green">167</FONT>        }<a name="line.167"></a>
<FONT color="green">168</FONT>    <a name="line.168"></a>
<FONT color="green">169</FONT>        /**<a name="line.169"></a>
<FONT color="green">170</FONT>         * Formats a object to produce a string.  &lt;code&gt;obj&lt;/code&gt; must be either a<a name="line.170"></a>
<FONT color="green">171</FONT>         * {@link Complex} object or a {@link Number} object.  Any other type of<a name="line.171"></a>
<FONT color="green">172</FONT>         * object will result in an {@link IllegalArgumentException} being thrown.<a name="line.172"></a>
<FONT color="green">173</FONT>         *<a name="line.173"></a>
<FONT color="green">174</FONT>         * @param obj the object to format.<a name="line.174"></a>
<FONT color="green">175</FONT>         * @param toAppendTo where the text is to be appended<a name="line.175"></a>
<FONT color="green">176</FONT>         * @param pos On input: an alignment field, if desired. On output: the<a name="line.176"></a>
<FONT color="green">177</FONT>         *            offsets of the alignment field<a name="line.177"></a>
<FONT color="green">178</FONT>         * @return the value passed in as toAppendTo.<a name="line.178"></a>
<FONT color="green">179</FONT>         * @see java.text.Format#format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)<a name="line.179"></a>
<FONT color="green">180</FONT>         * @throws IllegalArgumentException is &lt;code&gt;obj&lt;/code&gt; is not a valid type.<a name="line.180"></a>
<FONT color="green">181</FONT>         */<a name="line.181"></a>
<FONT color="green">182</FONT>        @Override<a name="line.182"></a>
<FONT color="green">183</FONT>        public StringBuffer format(Object obj, StringBuffer toAppendTo,<a name="line.183"></a>
<FONT color="green">184</FONT>                FieldPosition pos) {<a name="line.184"></a>
<FONT color="green">185</FONT>    <a name="line.185"></a>
<FONT color="green">186</FONT>            StringBuffer ret = null;<a name="line.186"></a>
<FONT color="green">187</FONT>    <a name="line.187"></a>
<FONT color="green">188</FONT>            if (obj instanceof Complex) {<a name="line.188"></a>
<FONT color="green">189</FONT>                ret = format( (Complex)obj, toAppendTo, pos);<a name="line.189"></a>
<FONT color="green">190</FONT>            } else if (obj instanceof Number) {<a name="line.190"></a>
<FONT color="green">191</FONT>                ret = format( new Complex(((Number)obj).doubleValue(), 0.0),<a name="line.191"></a>
<FONT color="green">192</FONT>                    toAppendTo, pos);<a name="line.192"></a>
<FONT color="green">193</FONT>            } else {<a name="line.193"></a>
<FONT color="green">194</FONT>                throw MathRuntimeException.createIllegalArgumentException(<a name="line.194"></a>
<FONT color="green">195</FONT>                      "cannot format a {0} instance as a complex number",<a name="line.195"></a>
<FONT color="green">196</FONT>                      obj.getClass().getName());<a name="line.196"></a>
<FONT color="green">197</FONT>            }<a name="line.197"></a>
<FONT color="green">198</FONT>    <a name="line.198"></a>
<FONT color="green">199</FONT>            return ret;<a name="line.199"></a>
<FONT color="green">200</FONT>        }<a name="line.200"></a>
<FONT color="green">201</FONT>    <a name="line.201"></a>
<FONT color="green">202</FONT>        /**<a name="line.202"></a>
<FONT color="green">203</FONT>         * Access the imaginaryCharacter.<a name="line.203"></a>
<FONT color="green">204</FONT>         * @return the imaginaryCharacter.<a name="line.204"></a>
<FONT color="green">205</FONT>         */<a name="line.205"></a>
<FONT color="green">206</FONT>        public String getImaginaryCharacter() {<a name="line.206"></a>
<FONT color="green">207</FONT>            return imaginaryCharacter;<a name="line.207"></a>
<FONT color="green">208</FONT>        }<a name="line.208"></a>
<FONT color="green">209</FONT>    <a name="line.209"></a>
<FONT color="green">210</FONT>        /**<a name="line.210"></a>
<FONT color="green">211</FONT>         * Access the imaginaryFormat.<a name="line.211"></a>
<FONT color="green">212</FONT>         * @return the imaginaryFormat.<a name="line.212"></a>
<FONT color="green">213</FONT>         */<a name="line.213"></a>
<FONT color="green">214</FONT>        public NumberFormat getImaginaryFormat() {<a name="line.214"></a>
<FONT color="green">215</FONT>            return imaginaryFormat;<a name="line.215"></a>
<FONT color="green">216</FONT>        }<a name="line.216"></a>
<FONT color="green">217</FONT>    <a name="line.217"></a>
<FONT color="green">218</FONT>        /**<a name="line.218"></a>
<FONT color="green">219</FONT>         * Returns the default complex format for the current locale.<a name="line.219"></a>
<FONT color="green">220</FONT>         * @return the default complex format.<a name="line.220"></a>
<FONT color="green">221</FONT>         */<a name="line.221"></a>
<FONT color="green">222</FONT>        public static ComplexFormat getInstance() {<a name="line.222"></a>
<FONT color="green">223</FONT>            return getInstance(Locale.getDefault());<a name="line.223"></a>
<FONT color="green">224</FONT>        }<a name="line.224"></a>
<FONT color="green">225</FONT>    <a name="line.225"></a>
<FONT color="green">226</FONT>        /**<a name="line.226"></a>
<FONT color="green">227</FONT>         * Returns the default complex format for the given locale.<a name="line.227"></a>
<FONT color="green">228</FONT>         * @param locale the specific locale used by the format.<a name="line.228"></a>
<FONT color="green">229</FONT>         * @return the complex format specific to the given locale.<a name="line.229"></a>
<FONT color="green">230</FONT>         */<a name="line.230"></a>
<FONT color="green">231</FONT>        public static ComplexFormat getInstance(Locale locale) {<a name="line.231"></a>
<FONT color="green">232</FONT>            NumberFormat f = getDefaultNumberFormat(locale);<a name="line.232"></a>
<FONT color="green">233</FONT>            return new ComplexFormat(f);<a name="line.233"></a>
<FONT color="green">234</FONT>        }<a name="line.234"></a>
<FONT color="green">235</FONT>    <a name="line.235"></a>
<FONT color="green">236</FONT>        /**<a name="line.236"></a>
<FONT color="green">237</FONT>         * Access the realFormat.<a name="line.237"></a>
<FONT color="green">238</FONT>         * @return the realFormat.<a name="line.238"></a>
<FONT color="green">239</FONT>         */<a name="line.239"></a>
<FONT color="green">240</FONT>        public NumberFormat getRealFormat() {<a name="line.240"></a>
<FONT color="green">241</FONT>            return realFormat;<a name="line.241"></a>
<FONT color="green">242</FONT>        }<a name="line.242"></a>
<FONT color="green">243</FONT>    <a name="line.243"></a>
<FONT color="green">244</FONT>        /**<a name="line.244"></a>
<FONT color="green">245</FONT>         * Parses a string to produce a {@link Complex} object.<a name="line.245"></a>
<FONT color="green">246</FONT>         *<a name="line.246"></a>
<FONT color="green">247</FONT>         * @param source the string to parse<a name="line.247"></a>
<FONT color="green">248</FONT>         * @return the parsed {@link Complex} object.<a name="line.248"></a>
<FONT color="green">249</FONT>         * @exception ParseException if the beginning of the specified string<a name="line.249"></a>
<FONT color="green">250</FONT>         *            cannot be parsed.<a name="line.250"></a>
<FONT color="green">251</FONT>         */<a name="line.251"></a>
<FONT color="green">252</FONT>        public Complex parse(String source) throws ParseException {<a name="line.252"></a>
<FONT color="green">253</FONT>            ParsePosition parsePosition = new ParsePosition(0);<a name="line.253"></a>
<FONT color="green">254</FONT>            Complex result = parse(source, parsePosition);<a name="line.254"></a>
<FONT color="green">255</FONT>            if (parsePosition.getIndex() == 0) {<a name="line.255"></a>
<FONT color="green">256</FONT>                throw MathRuntimeException.createParseException(<a name="line.256"></a>
<FONT color="green">257</FONT>                        parsePosition.getErrorIndex(),<a name="line.257"></a>
<FONT color="green">258</FONT>                        "unparseable complex number: \"{0}\"", source);<a name="line.258"></a>
<FONT color="green">259</FONT>            }<a name="line.259"></a>
<FONT color="green">260</FONT>            return result;<a name="line.260"></a>
<FONT color="green">261</FONT>        }<a name="line.261"></a>
<FONT color="green">262</FONT>    <a name="line.262"></a>
<FONT color="green">263</FONT>        /**<a name="line.263"></a>
<FONT color="green">264</FONT>         * Parses a string to produce a {@link Complex} object.<a name="line.264"></a>
<FONT color="green">265</FONT>         *<a name="line.265"></a>
<FONT color="green">266</FONT>         * @param source the string to parse<a name="line.266"></a>
<FONT color="green">267</FONT>         * @param pos input/ouput parsing parameter.<a name="line.267"></a>
<FONT color="green">268</FONT>         * @return the parsed {@link Complex} object.<a name="line.268"></a>
<FONT color="green">269</FONT>         */<a name="line.269"></a>
<FONT color="green">270</FONT>        public Complex parse(String source, ParsePosition pos) {<a name="line.270"></a>
<FONT color="green">271</FONT>            int initialIndex = pos.getIndex();<a name="line.271"></a>
<FONT color="green">272</FONT>    <a name="line.272"></a>
<FONT color="green">273</FONT>            // parse whitespace<a name="line.273"></a>
<FONT color="green">274</FONT>            parseAndIgnoreWhitespace(source, pos);<a name="line.274"></a>
<FONT color="green">275</FONT>    <a name="line.275"></a>
<FONT color="green">276</FONT>            // parse real<a name="line.276"></a>
<FONT color="green">277</FONT>            Number re = parseNumber(source, getRealFormat(), pos);<a name="line.277"></a>
<FONT color="green">278</FONT>            if (re == null) {<a name="line.278"></a>
<FONT color="green">279</FONT>                // invalid real number<a name="line.279"></a>
<FONT color="green">280</FONT>                // set index back to initial, error index should already be set<a name="line.280"></a>
<FONT color="green">281</FONT>                pos.setIndex(initialIndex);<a name="line.281"></a>
<FONT color="green">282</FONT>                return null;<a name="line.282"></a>
<FONT color="green">283</FONT>            }<a name="line.283"></a>
<FONT color="green">284</FONT>    <a name="line.284"></a>
<FONT color="green">285</FONT>            // parse sign<a name="line.285"></a>
<FONT color="green">286</FONT>            int startIndex = pos.getIndex();<a name="line.286"></a>
<FONT color="green">287</FONT>            char c = parseNextCharacter(source, pos);<a name="line.287"></a>
<FONT color="green">288</FONT>            int sign = 0;<a name="line.288"></a>
<FONT color="green">289</FONT>            switch (c) {<a name="line.289"></a>
<FONT color="green">290</FONT>            case 0 :<a name="line.290"></a>
<FONT color="green">291</FONT>                // no sign<a name="line.291"></a>
<FONT color="green">292</FONT>                // return real only complex number<a name="line.292"></a>
<FONT color="green">293</FONT>                return new Complex(re.doubleValue(), 0.0);<a name="line.293"></a>
<FONT color="green">294</FONT>            case '-' :<a name="line.294"></a>
<FONT color="green">295</FONT>                sign = -1;<a name="line.295"></a>
<FONT color="green">296</FONT>                break;<a name="line.296"></a>
<FONT color="green">297</FONT>            case '+' :<a name="line.297"></a>
<FONT color="green">298</FONT>                sign = 1;<a name="line.298"></a>
<FONT color="green">299</FONT>                break;<a name="line.299"></a>
<FONT color="green">300</FONT>            default :<a name="line.300"></a>
<FONT color="green">301</FONT>                // invalid sign<a name="line.301"></a>
<FONT color="green">302</FONT>                // set index back to initial, error index should be the last<a name="line.302"></a>
<FONT color="green">303</FONT>                // character examined.<a name="line.303"></a>
<FONT color="green">304</FONT>                pos.setIndex(initialIndex);<a name="line.304"></a>
<FONT color="green">305</FONT>                pos.setErrorIndex(startIndex);<a name="line.305"></a>
<FONT color="green">306</FONT>                return null;<a name="line.306"></a>
<FONT color="green">307</FONT>            }<a name="line.307"></a>
<FONT color="green">308</FONT>    <a name="line.308"></a>
<FONT color="green">309</FONT>            // parse whitespace<a name="line.309"></a>
<FONT color="green">310</FONT>            parseAndIgnoreWhitespace(source, pos);<a name="line.310"></a>
<FONT color="green">311</FONT>    <a name="line.311"></a>
<FONT color="green">312</FONT>            // parse imaginary<a name="line.312"></a>
<FONT color="green">313</FONT>            Number im = parseNumber(source, getRealFormat(), pos);<a name="line.313"></a>
<FONT color="green">314</FONT>            if (im == null) {<a name="line.314"></a>
<FONT color="green">315</FONT>                // invalid imaginary number<a name="line.315"></a>
<FONT color="green">316</FONT>                // set index back to initial, error index should already be set<a name="line.316"></a>
<FONT color="green">317</FONT>                pos.setIndex(initialIndex);<a name="line.317"></a>
<FONT color="green">318</FONT>                return null;<a name="line.318"></a>
<FONT color="green">319</FONT>            }<a name="line.319"></a>
<FONT color="green">320</FONT>    <a name="line.320"></a>
<FONT color="green">321</FONT>            // parse imaginary character<a name="line.321"></a>
<FONT color="green">322</FONT>            if (!parseFixedstring(source, getImaginaryCharacter(), pos)) {<a name="line.322"></a>
<FONT color="green">323</FONT>                return null;<a name="line.323"></a>
<FONT color="green">324</FONT>            }<a name="line.324"></a>
<FONT color="green">325</FONT>    <a name="line.325"></a>
<FONT color="green">326</FONT>            return new Complex(re.doubleValue(), im.doubleValue() * sign);<a name="line.326"></a>
<FONT color="green">327</FONT>    <a name="line.327"></a>
<FONT color="green">328</FONT>        }<a name="line.328"></a>
<FONT color="green">329</FONT>    <a name="line.329"></a>
<FONT color="green">330</FONT>        /**<a name="line.330"></a>
<FONT color="green">331</FONT>         * Parses a string to produce a object.<a name="line.331"></a>
<FONT color="green">332</FONT>         *<a name="line.332"></a>
<FONT color="green">333</FONT>         * @param source the string to parse<a name="line.333"></a>
<FONT color="green">334</FONT>         * @param pos input/ouput parsing parameter.<a name="line.334"></a>
<FONT color="green">335</FONT>         * @return the parsed object.<a name="line.335"></a>
<FONT color="green">336</FONT>         * @see java.text.Format#parseObject(java.lang.String, java.text.ParsePosition)<a name="line.336"></a>
<FONT color="green">337</FONT>         */<a name="line.337"></a>
<FONT color="green">338</FONT>        @Override<a name="line.338"></a>
<FONT color="green">339</FONT>        public Object parseObject(String source, ParsePosition pos) {<a name="line.339"></a>
<FONT color="green">340</FONT>            return parse(source, pos);<a name="line.340"></a>
<FONT color="green">341</FONT>        }<a name="line.341"></a>
<FONT color="green">342</FONT>    <a name="line.342"></a>
<FONT color="green">343</FONT>        /**<a name="line.343"></a>
<FONT color="green">344</FONT>         * Modify the imaginaryCharacter.<a name="line.344"></a>
<FONT color="green">345</FONT>         * @param imaginaryCharacter The new imaginaryCharacter value.<a name="line.345"></a>
<FONT color="green">346</FONT>         * @throws IllegalArgumentException if &lt;code&gt;imaginaryCharacter&lt;/code&gt; is<a name="line.346"></a>
<FONT color="green">347</FONT>         *         &lt;code&gt;null&lt;/code&gt; or an empty string.<a name="line.347"></a>
<FONT color="green">348</FONT>         */<a name="line.348"></a>
<FONT color="green">349</FONT>        public void setImaginaryCharacter(String imaginaryCharacter) {<a name="line.349"></a>
<FONT color="green">350</FONT>            if (imaginaryCharacter == null || imaginaryCharacter.length() == 0) {<a name="line.350"></a>
<FONT color="green">351</FONT>                throw MathRuntimeException.createIllegalArgumentException(<a name="line.351"></a>
<FONT color="green">352</FONT>                      "empty string for imaginary character");<a name="line.352"></a>
<FONT color="green">353</FONT>            }<a name="line.353"></a>
<FONT color="green">354</FONT>            this.imaginaryCharacter = imaginaryCharacter;<a name="line.354"></a>
<FONT color="green">355</FONT>        }<a name="line.355"></a>
<FONT color="green">356</FONT>    <a name="line.356"></a>
<FONT color="green">357</FONT>        /**<a name="line.357"></a>
<FONT color="green">358</FONT>         * Modify the imaginaryFormat.<a name="line.358"></a>
<FONT color="green">359</FONT>         * @param imaginaryFormat The new imaginaryFormat value.<a name="line.359"></a>
<FONT color="green">360</FONT>         * @throws IllegalArgumentException if &lt;code&gt;imaginaryFormat&lt;/code&gt; is<a name="line.360"></a>
<FONT color="green">361</FONT>         *         &lt;code&gt;null&lt;/code&gt;.<a name="line.361"></a>
<FONT color="green">362</FONT>         */<a name="line.362"></a>
<FONT color="green">363</FONT>        public void setImaginaryFormat(NumberFormat imaginaryFormat) {<a name="line.363"></a>
<FONT color="green">364</FONT>            if (imaginaryFormat == null) {<a name="line.364"></a>
<FONT color="green">365</FONT>                throw MathRuntimeException.createIllegalArgumentException(<a name="line.365"></a>
<FONT color="green">366</FONT>                      "null imaginary format");<a name="line.366"></a>
<FONT color="green">367</FONT>            }<a name="line.367"></a>
<FONT color="green">368</FONT>            this.imaginaryFormat = imaginaryFormat;<a name="line.368"></a>
<FONT color="green">369</FONT>        }<a name="line.369"></a>
<FONT color="green">370</FONT>    <a name="line.370"></a>
<FONT color="green">371</FONT>        /**<a name="line.371"></a>
<FONT color="green">372</FONT>         * Modify the realFormat.<a name="line.372"></a>
<FONT color="green">373</FONT>         * @param realFormat The new realFormat value.<a name="line.373"></a>
<FONT color="green">374</FONT>         * @throws IllegalArgumentException if &lt;code&gt;realFormat&lt;/code&gt; is<a name="line.374"></a>
<FONT color="green">375</FONT>         *         &lt;code&gt;null&lt;/code&gt;.<a name="line.375"></a>
<FONT color="green">376</FONT>         */<a name="line.376"></a>
<FONT color="green">377</FONT>        public void setRealFormat(NumberFormat realFormat) {<a name="line.377"></a>
<FONT color="green">378</FONT>            if (realFormat == null) {<a name="line.378"></a>
<FONT color="green">379</FONT>                throw MathRuntimeException.createIllegalArgumentException(<a name="line.379"></a>
<FONT color="green">380</FONT>                      "null real format");<a name="line.380"></a>
<FONT color="green">381</FONT>            }<a name="line.381"></a>
<FONT color="green">382</FONT>            this.realFormat = realFormat;<a name="line.382"></a>
<FONT color="green">383</FONT>        }<a name="line.383"></a>
<FONT color="green">384</FONT>    <a name="line.384"></a>
<FONT color="green">385</FONT>    }<a name="line.385"></a>




























































</PRE>
</BODY>
</HTML>