comparison libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/random/UnitSphereRandomVectorGenerator.html @ 13:cbf34dd4d7e6

commons-math-2.1 added
author dwinter
date Tue, 04 Jan 2011 10:02:07 +0100
parents
children
comparison
equal deleted inserted replaced
12:970d26a94fb7 13:cbf34dd4d7e6
1 <HTML>
2 <BODY BGCOLOR="white">
3 <PRE>
4 <FONT color="green">001</FONT> /*<a name="line.1"></a>
5 <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
6 <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
7 <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
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>
9 <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
10 <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
11 <FONT color="green">008</FONT> *<a name="line.8"></a>
12 <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
13 <FONT color="green">010</FONT> *<a name="line.10"></a>
14 <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
15 <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
16 <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
17 <FONT color="green">014</FONT> * See the License for the specific language governing permissions and<a name="line.14"></a>
18 <FONT color="green">015</FONT> * limitations under the License.<a name="line.15"></a>
19 <FONT color="green">016</FONT> */<a name="line.16"></a>
20 <FONT color="green">017</FONT> <a name="line.17"></a>
21 <FONT color="green">018</FONT> package org.apache.commons.math.random;<a name="line.18"></a>
22 <FONT color="green">019</FONT> <a name="line.19"></a>
23 <FONT color="green">020</FONT> <a name="line.20"></a>
24 <FONT color="green">021</FONT> /**<a name="line.21"></a>
25 <FONT color="green">022</FONT> * Generate random vectors isotropically located on the surface of a sphere.<a name="line.22"></a>
26 <FONT color="green">023</FONT> *<a name="line.23"></a>
27 <FONT color="green">024</FONT> * @since 2.1<a name="line.24"></a>
28 <FONT color="green">025</FONT> * @version $Revision: 925812 $ $Date: 2010-03-21 11:49:31 -0400 (Sun, 21 Mar 2010) $<a name="line.25"></a>
29 <FONT color="green">026</FONT> */<a name="line.26"></a>
30 <FONT color="green">027</FONT> <a name="line.27"></a>
31 <FONT color="green">028</FONT> public class UnitSphereRandomVectorGenerator<a name="line.28"></a>
32 <FONT color="green">029</FONT> implements RandomVectorGenerator {<a name="line.29"></a>
33 <FONT color="green">030</FONT> /**<a name="line.30"></a>
34 <FONT color="green">031</FONT> * RNG used for generating the individual components of the vectors.<a name="line.31"></a>
35 <FONT color="green">032</FONT> */<a name="line.32"></a>
36 <FONT color="green">033</FONT> private final RandomGenerator rand;<a name="line.33"></a>
37 <FONT color="green">034</FONT> /**<a name="line.34"></a>
38 <FONT color="green">035</FONT> * Space dimension.<a name="line.35"></a>
39 <FONT color="green">036</FONT> */<a name="line.36"></a>
40 <FONT color="green">037</FONT> private final int dimension;<a name="line.37"></a>
41 <FONT color="green">038</FONT> <a name="line.38"></a>
42 <FONT color="green">039</FONT> /**<a name="line.39"></a>
43 <FONT color="green">040</FONT> * @param dimension Space dimension.<a name="line.40"></a>
44 <FONT color="green">041</FONT> * @param rand RNG for the individual components of the vectors.<a name="line.41"></a>
45 <FONT color="green">042</FONT> */<a name="line.42"></a>
46 <FONT color="green">043</FONT> public UnitSphereRandomVectorGenerator(final int dimension,<a name="line.43"></a>
47 <FONT color="green">044</FONT> final RandomGenerator rand) {<a name="line.44"></a>
48 <FONT color="green">045</FONT> this.dimension = dimension;<a name="line.45"></a>
49 <FONT color="green">046</FONT> this.rand = rand;<a name="line.46"></a>
50 <FONT color="green">047</FONT> }<a name="line.47"></a>
51 <FONT color="green">048</FONT> /**<a name="line.48"></a>
52 <FONT color="green">049</FONT> * Create an object that will use a default RNG ({@link MersenneTwister}),<a name="line.49"></a>
53 <FONT color="green">050</FONT> * in order to generate the individual components.<a name="line.50"></a>
54 <FONT color="green">051</FONT> *<a name="line.51"></a>
55 <FONT color="green">052</FONT> * @param dimension Space dimension.<a name="line.52"></a>
56 <FONT color="green">053</FONT> */<a name="line.53"></a>
57 <FONT color="green">054</FONT> public UnitSphereRandomVectorGenerator(final int dimension) {<a name="line.54"></a>
58 <FONT color="green">055</FONT> this(dimension, new MersenneTwister());<a name="line.55"></a>
59 <FONT color="green">056</FONT> }<a name="line.56"></a>
60 <FONT color="green">057</FONT> <a name="line.57"></a>
61 <FONT color="green">058</FONT> /** {@inheritDoc} */<a name="line.58"></a>
62 <FONT color="green">059</FONT> public double[] nextVector() {<a name="line.59"></a>
63 <FONT color="green">060</FONT> <a name="line.60"></a>
64 <FONT color="green">061</FONT> final double[] v = new double[dimension];<a name="line.61"></a>
65 <FONT color="green">062</FONT> <a name="line.62"></a>
66 <FONT color="green">063</FONT> double normSq;<a name="line.63"></a>
67 <FONT color="green">064</FONT> do {<a name="line.64"></a>
68 <FONT color="green">065</FONT> normSq = 0;<a name="line.65"></a>
69 <FONT color="green">066</FONT> for (int i = 0; i &lt; dimension; i++) {<a name="line.66"></a>
70 <FONT color="green">067</FONT> final double comp = 2 * rand.nextDouble() - 1;<a name="line.67"></a>
71 <FONT color="green">068</FONT> v[i] = comp;<a name="line.68"></a>
72 <FONT color="green">069</FONT> normSq += comp * comp;<a name="line.69"></a>
73 <FONT color="green">070</FONT> }<a name="line.70"></a>
74 <FONT color="green">071</FONT> } while (normSq &gt; 1);<a name="line.71"></a>
75 <FONT color="green">072</FONT> <a name="line.72"></a>
76 <FONT color="green">073</FONT> final double f = 1 / Math.sqrt(normSq);<a name="line.73"></a>
77 <FONT color="green">074</FONT> for (int i = 0; i &lt; dimension; i++) {<a name="line.74"></a>
78 <FONT color="green">075</FONT> v[i] *= f;<a name="line.75"></a>
79 <FONT color="green">076</FONT> }<a name="line.76"></a>
80 <FONT color="green">077</FONT> <a name="line.77"></a>
81 <FONT color="green">078</FONT> return v;<a name="line.78"></a>
82 <FONT color="green">079</FONT> <a name="line.79"></a>
83 <FONT color="green">080</FONT> }<a name="line.80"></a>
84 <FONT color="green">081</FONT> <a name="line.81"></a>
85 <FONT color="green">082</FONT> }<a name="line.82"></a>
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146 </PRE>
147 </BODY>
148 </HTML>