Mercurial > octave

comparison liboctave/numeric/oct-rand.h @ 31607:aac27ad79be6 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Re-indent code after switch to using namespace macros. * build-env.h, build-env.in.cc, Cell.h, __betainc__.cc, __eigs__.cc, __ftp__.cc, __ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __magick_read__.cc, __pchip_deriv__.cc, amd.cc, base-text-renderer.cc, base-text-renderer.h, besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.h, call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, dasrt.cc, data.cc, debug.cc, defaults.cc, defaults.h, det.cc, display.cc, display.h, dlmread.cc, dynamic-ld.cc, dynamic-ld.h, ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h, event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc, fcn-info.h, fft.cc, fft2.cc, file-io.cc, filter.cc, find.cc, ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, gl-render.cc, gl-render.h, gl2ps-print.cc, gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc, gsvd.cc, gtk-manager.cc, gtk-manager.h, help.cc, help.h, hook-fcn.cc, hook-fcn.h, input.cc, input.h, interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h, inv.cc, jsondecode.cc, jsonencode.cc, latex-text-renderer.cc, latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h, lookup.cc, ls-hdf5.cc, ls-mat4.cc, ls-mat5.cc, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex.cc, mexproto.h, mxarray.h, mxtypes.in.h, oct-errno.in.cc, oct-hdf5-types.cc, oct-hist.cc, oct-hist.h, oct-map.cc, oct-map.h, oct-opengl.h, oct-prcstrm.h, oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.h, octave-default-image.h, ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-output.cc, psi.cc, qr.cc, quadcc.cc, rand.cc, regexp.cc, settings.cc, settings.h, sighandlers.cc, sighandlers.h, sparse-xpow.cc, sqrtm.cc, stack-frame.cc, stack-frame.h, stream-euler.cc, strfns.cc, svd.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h, symscope.cc, symscope.h, symtab.cc, symtab.h, sysdep.cc, sysdep.h, text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc, toplev.cc, typecast.cc, url-handle-manager.cc, url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc, variables.h, xdiv.cc, __delaunayn__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audioread.cc, convhulln.cc, gzip.cc, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc, cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h, cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h, cdef-utils.cc, cdef-utils.h, ov-base-diag.cc, ov-base-int.cc, ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.cc, ov-base.cc, ov-base.h, ov-bool-mat.cc, ov-bool-mat.h, ov-bool-sparse.cc, ov-bool.cc, ov-builtin.h, ov-cell.cc, ov-ch-mat.cc, ov-class.cc, ov-class.h, ov-classdef.cc, ov-classdef.h, ov-complex.cc, ov-cx-diag.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-dld-fcn.cc, ov-dld-fcn.h, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h, ov-float.cc, ov-flt-complex.cc, ov-flt-cx-diag.cc, ov-flt-cx-mat.cc, ov-flt-re-diag.cc, ov-flt-re-mat.cc, ov-flt-re-mat.h, ov-intx.h, ov-java.cc, ov-lazy-idx.cc, ov-legacy-range.cc, ov-magic-int.cc, ov-mex-fcn.cc, ov-mex-fcn.h, ov-null-mat.cc, ov-perm.cc, ov-range.cc, ov-re-diag.cc, ov-re-mat.cc, ov-re-mat.h, ov-re-sparse.cc, ov-scalar.cc, ov-str-mat.cc, ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, ov.h, ovl.h, octave.cc, octave.h, op-b-sbm.cc, op-bm-sbm.cc, op-cs-scm.cc, op-fm-fcm.cc, op-fs-fcm.cc, op-s-scm.cc, op-scm-cs.cc, op-scm-s.cc, op-sm-cs.cc, ops.h, anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h, comment-list.cc, comment-list.h, filepos.h, lex.h, oct-lvalue.cc, oct-lvalue.h, parse.h, profiler.cc, profiler.h, pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h, pt-args-block.cc, pt-args-block.h, pt-array-list.cc, pt-array-list.h, pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h, pt-cbinop.cc, pt-cbinop.h, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h, pt-classdef.cc, pt-classdef.h, pt-cmd.h, pt-colon.cc, pt-colon.h, pt-const.cc, pt-const.h, pt-decl.cc, pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.cc, pt-except.h, pt-exp.cc, pt-exp.h, pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc, pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc, pt-mat.h, pt-misc.cc, pt-misc.h, pt-pr-code.cc, pt-pr-code.h, pt-select.cc, pt-select.h, pt-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc, pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-walk.cc, pt-walk.h, pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h, range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc, chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h, lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h, oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h, oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc, qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc, randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc, sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc, child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc, file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h, mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h, oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc, oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h, base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h, file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc, lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h, oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h, oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h, oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h, pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h, url-transfer.cc, url-transfer.h: Re-indent code after switch to using namespace macros.
author Rik <rik@octave.org>
date Thu, 01 Dec 2022 18:02:15 -0800
parents e88a07dec498
children 597f3ee61a48
comparison
equal deleted inserted replaced
31605:e88a07dec498 31607:aac27ad79be6
39 39
40 //class dim_vector; 40 //class dim_vector;
41 41
42 OCTAVE_BEGIN_NAMESPACE(octave) 42 OCTAVE_BEGIN_NAMESPACE(octave)
43 43
44 class OCTAVE_API rand 44 class OCTAVE_API rand
45 { 45 {
46 protected: 46 protected:
47 47
48 OCTAVE_API rand (void); 48 OCTAVE_API rand (void);
49 49
50 public: 50 public:
51 51
52 ~rand (void) = default; 52 ~rand (void) = default;
53 53
54 static bool instance_ok (void); 54 static bool instance_ok (void);
55 55
56 // Return the current seed. 56 // Return the current seed.
57 static double seed (void) 57 static double seed (void)
58 { 58 {
59 return (instance_ok () 59 return (instance_ok ()
60 ? m_instance->do_seed () : numeric_limits<double>::NaN ()); 60 ? m_instance->do_seed () : numeric_limits<double>::NaN ());
61 } 61 }
62 62
63 // Set the seed. 63 // Set the seed.
64 static void seed (double s) 64 static void seed (double s)
65 { 65 {
66 if (instance_ok ()) 66 if (instance_ok ())
67 m_instance->do_seed (s); 67 m_instance->do_seed (s);
68 } 68 }
69 69
70 // Reset the seed. 70 // Reset the seed.
71 static void reset (void) 71 static void reset (void)
72 { 72 {
73 if (instance_ok ()) 73 if (instance_ok ())
74 m_instance->do_reset (); 74 m_instance->do_reset ();
75 } 75 }
76 76
77 // Return the current state. 77 // Return the current state.
78 static uint32NDArray state (const std::string& d = "") 78 static uint32NDArray state (const std::string& d = "")
79 { 79 {
80 return instance_ok () ? m_instance->do_state (d) : uint32NDArray (); 80 return instance_ok () ? m_instance->do_state (d) : uint32NDArray ();
81 } 81 }
82 82
83 // Set the current state/ 83 // Set the current state/
84 static void state (const uint32NDArray& s, 84 static void state (const uint32NDArray& s,
85 const std::string& d = "") 85 const std::string& d = "")
86 { 86 {
87 if (instance_ok ()) 87 if (instance_ok ())
88 m_instance->do_state (s, d); 88 m_instance->do_state (s, d);
89 } 89 }
90 90
91 // Reset the current state/ 91 // Reset the current state/
92 static void reset (const std::string& d) 92 static void reset (const std::string& d)
93 { 93 {
94 if (instance_ok ()) 94 if (instance_ok ())
95 m_instance->do_reset (d); 95 m_instance->do_reset (d);
96 } 96 }
97 97
98 // Return the current distribution. 98 // Return the current distribution.
99 static std::string distribution (void) 99 static std::string distribution (void)
100 { 100 {
101 return instance_ok () ? m_instance->do_distribution () : ""; 101 return instance_ok () ? m_instance->do_distribution () : "";
102 } 102 }
103 103
104 // Set the current distribution. May be either "uniform" (the 104 // Set the current distribution. May be either "uniform" (the
105 // default), "normal", "exponential", "poisson", or "gamma". 105 // default), "normal", "exponential", "poisson", or "gamma".
106 static void distribution (const std::string& d) 106 static void distribution (const std::string& d)
107 { 107 {
108 if (instance_ok ()) 108 if (instance_ok ())
109 m_instance->do_distribution (d); 109 m_instance->do_distribution (d);
110 } 110 }
111 111
112 static void uniform_distribution (void) 112 static void uniform_distribution (void)
113 { 113 {
114 if (instance_ok ()) 114 if (instance_ok ())
115 m_instance->do_uniform_distribution (); 115 m_instance->do_uniform_distribution ();
116 } 116 }
117 117
118 static void normal_distribution (void) 118 static void normal_distribution (void)
119 { 119 {
120 if (instance_ok ()) 120 if (instance_ok ())
121 m_instance->do_normal_distribution (); 121 m_instance->do_normal_distribution ();
122 } 122 }
123 123
124 static void exponential_distribution (void) 124 static void exponential_distribution (void)
125 { 125 {
126 if (instance_ok ()) 126 if (instance_ok ())
127 m_instance->do_exponential_distribution (); 127 m_instance->do_exponential_distribution ();
128 } 128 }
129 129
130 static void poisson_distribution (void) 130 static void poisson_distribution (void)
131 { 131 {
132 if (instance_ok ()) 132 if (instance_ok ())
133 m_instance->do_poisson_distribution (); 133 m_instance->do_poisson_distribution ();
134 } 134 }
135 135
136 static void gamma_distribution (void) 136 static void gamma_distribution (void)
137 { 137 {
138 if (instance_ok ()) 138 if (instance_ok ())
139 m_instance->do_gamma_distribution (); 139 m_instance->do_gamma_distribution ();
140 } 140 }
141 141
142 // Return the next number from the sequence. 142 // Return the next number from the sequence.
143 static double scalar (double a = 1.0) 143 static double scalar (double a = 1.0)
144 { 144 {
145 return (instance_ok () 145 return (instance_ok ()
146 ? m_instance->do_scalar (a) : numeric_limits<double>::NaN ()); 146 ? m_instance->do_scalar (a) : numeric_limits<double>::NaN ());
147 } 147 }
148 148
149 // Return the next number from the sequence. 149 // Return the next number from the sequence.
150 static float float_scalar (float a = 1.0) 150 static float float_scalar (float a = 1.0)
151 { 151 {
152 return (instance_ok () 152 return (instance_ok ()
153 ? m_instance->do_scalar (a) : numeric_limits<float>::NaN ()); 153 ? m_instance->do_scalar (a) : numeric_limits<float>::NaN ());
154 } 154 }
155 155
156 // Return an array of numbers from the sequence. 156 // Return an array of numbers from the sequence.
157 static Array<double> vector (octave_idx_type n, double a = 1.0) 157 static Array<double> vector (octave_idx_type n, double a = 1.0)
158 { 158 {
159 return instance_ok () ? m_instance->do_vector (n, a) : Array<double> (); 159 return instance_ok () ? m_instance->do_vector (n, a) : Array<double> ();
160 } 160 }
161 161
162 // Return an array of numbers from the sequence. 162 // Return an array of numbers from the sequence.
163 static Array<float> float_vector (octave_idx_type n, float a = 1.0) 163 static Array<float> float_vector (octave_idx_type n, float a = 1.0)
164 { 164 {
165 return instance_ok () ? m_instance->do_vector (n, a) : Array<float> (); 165 return instance_ok () ? m_instance->do_vector (n, a) : Array<float> ();
166 } 166 }
167 167
168 // Return an N-dimensional array of numbers from the sequence, 168 // Return an N-dimensional array of numbers from the sequence,
169 // filled in column major order. 169 // filled in column major order.
170 static NDArray nd_array (const dim_vector& dims, double a = 1.0) 170 static NDArray nd_array (const dim_vector& dims, double a = 1.0)
171 { 171 {
172 return instance_ok () ? m_instance->do_nd_array (dims, a) : NDArray (); 172 return instance_ok () ? m_instance->do_nd_array (dims, a) : NDArray ();
173 } 173 }
174 174
175 // Return an N-dimensional array of numbers from the sequence, 175 // Return an N-dimensional array of numbers from the sequence,
176 // filled in column major order. 176 // filled in column major order.
177 static FloatNDArray float_nd_array (const dim_vector& dims, float a = 1.0) 177 static FloatNDArray float_nd_array (const dim_vector& dims, float a = 1.0)
178 { 178 {
179 return (instance_ok () 179 return (instance_ok ()
180 ? m_instance->do_float_nd_array (dims, a) : FloatNDArray ()); 180 ? m_instance->do_float_nd_array (dims, a) : FloatNDArray ());
181 } 181 }
182 182
183 private: 183 private:
184 184
185 static rand *m_instance; 185 static rand *m_instance;
186 186
187 static void cleanup_instance (void) 187 static void cleanup_instance (void)
188 { delete m_instance; m_instance = nullptr; } 188 { delete m_instance; m_instance = nullptr; }
189 189
190 enum 190 enum
191 { 191 {
192 unknown_dist, 192 unknown_dist,
193 uniform_dist, 193 uniform_dist,
194 normal_dist, 194 normal_dist,
195 expon_dist, 195 expon_dist,
196 poisson_dist, 196 poisson_dist,
197 gamma_dist 197 gamma_dist
198 };
199
200 // Current distribution of random numbers.
201 int m_current_distribution;
202
203 // If TRUE, use old RANLIB generators. Otherwise, use Mersenne
204 // Twister generator.
205 bool m_use_old_generators;
206
207 // Saved MT states.
208 std::map<int, uint32NDArray> m_rand_states;
209
210 // Return the current seed.
211 OCTAVE_API double do_seed (void);
212
213 // Set the seed.
214 OCTAVE_API void do_seed (double s);
215
216 // Reset the seed.
217 OCTAVE_API void do_reset ();
218
219 // Return the current state.
220 OCTAVE_API uint32NDArray do_state (const std::string& d);
221
222 // Set the current state/
223 OCTAVE_API void do_state (const uint32NDArray& s, const std::string& d);
224
225 // Reset the current state/
226 OCTAVE_API void do_reset (const std::string& d);
227
228 // Return the current distribution.
229 OCTAVE_API std::string do_distribution (void);
230
231 // Set the current distribution. May be either "uniform" (the
232 // default), "normal", "exponential", "poisson", or "gamma".
233 OCTAVE_API void do_distribution (const std::string& d);
234
235 OCTAVE_API void do_uniform_distribution (void);
236
237 OCTAVE_API void do_normal_distribution (void);
238
239 OCTAVE_API void do_exponential_distribution (void);
240
241 OCTAVE_API void do_poisson_distribution (void);
242
243 OCTAVE_API void do_gamma_distribution (void);
244
245 // The following templates only make sense for double and float
246 // types.
247
248 template <typename T> OCTAVE_API T uniform (void);
249
250 template <typename T> OCTAVE_API T normal (void);
251
252 template <typename T> OCTAVE_API T exponential (void);
253
254 template <typename T> OCTAVE_API T poisson (T a);
255
256 template <typename T> OCTAVE_API T gamma (T a);
257
258 // Return the next number from the sequence.
259 template <typename T> OCTAVE_API T do_scalar (T a = 1);
260
261 // Return an array of numbers from the sequence.
262 template <typename T> OCTAVE_API Array<T>
263 do_vector (octave_idx_type n, T a = 1);
264
265 // Return an N-dimensional array of numbers from the sequence,
266 // filled in column major order.
267 OCTAVE_API NDArray do_nd_array (const dim_vector& dims, double a = 1.);
268
269 // Return an N-dimensional array of numbers from the sequence,
270 // filled in column major order.
271 OCTAVE_API FloatNDArray
272 do_float_nd_array (const dim_vector& dims, float a = 1.);
273
274 // Some helper functions.
275
276 OCTAVE_API void initialize_ranlib_generators (void);
277
278 OCTAVE_API void initialize_mersenne_twister (void);
279
280 OCTAVE_API uint32NDArray get_internal_state (void);
281
282 OCTAVE_API void save_state (void);
283
284 OCTAVE_API int get_dist_id (const std::string& d);
285
286 OCTAVE_API void set_internal_state (const uint32NDArray& s);
287
288 OCTAVE_API void switch_to_generator (int dist);
289
290 OCTAVE_API void fill (octave_idx_type len, double *v, double a);
291
292 OCTAVE_API void fill (octave_idx_type len, float *v, float a);
293 }; 198 };
294 199
200 // Current distribution of random numbers.
201 int m_current_distribution;
202
203 // If TRUE, use old RANLIB generators. Otherwise, use Mersenne
204 // Twister generator.
205 bool m_use_old_generators;
206
207 // Saved MT states.
208 std::map<int, uint32NDArray> m_rand_states;
209
210 // Return the current seed.
211 OCTAVE_API double do_seed (void);
212
213 // Set the seed.
214 OCTAVE_API void do_seed (double s);
215
216 // Reset the seed.
217 OCTAVE_API void do_reset ();
218
219 // Return the current state.
220 OCTAVE_API uint32NDArray do_state (const std::string& d);
221
222 // Set the current state/
223 OCTAVE_API void do_state (const uint32NDArray& s, const std::string& d);
224
225 // Reset the current state/
226 OCTAVE_API void do_reset (const std::string& d);
227
228 // Return the current distribution.
229 OCTAVE_API std::string do_distribution (void);
230
231 // Set the current distribution. May be either "uniform" (the
232 // default), "normal", "exponential", "poisson", or "gamma".
233 OCTAVE_API void do_distribution (const std::string& d);
234
235 OCTAVE_API void do_uniform_distribution (void);
236
237 OCTAVE_API void do_normal_distribution (void);
238
239 OCTAVE_API void do_exponential_distribution (void);
240
241 OCTAVE_API void do_poisson_distribution (void);
242
243 OCTAVE_API void do_gamma_distribution (void);
244
245 // The following templates only make sense for double and float
246 // types.
247
248 template <typename T> OCTAVE_API T uniform (void);
249
250 template <typename T> OCTAVE_API T normal (void);
251
252 template <typename T> OCTAVE_API T exponential (void);
253
254 template <typename T> OCTAVE_API T poisson (T a);
255
256 template <typename T> OCTAVE_API T gamma (T a);
257
258 // Return the next number from the sequence.
259 template <typename T> OCTAVE_API T do_scalar (T a = 1);
260
261 // Return an array of numbers from the sequence.
262 template <typename T> OCTAVE_API Array<T>
263 do_vector (octave_idx_type n, T a = 1);
264
265 // Return an N-dimensional array of numbers from the sequence,
266 // filled in column major order.
267 OCTAVE_API NDArray do_nd_array (const dim_vector& dims, double a = 1.);
268
269 // Return an N-dimensional array of numbers from the sequence,
270 // filled in column major order.
271 OCTAVE_API FloatNDArray
272 do_float_nd_array (const dim_vector& dims, float a = 1.);
273
274 // Some helper functions.
275
276 OCTAVE_API void initialize_ranlib_generators (void);
277
278 OCTAVE_API void initialize_mersenne_twister (void);
279
280 OCTAVE_API uint32NDArray get_internal_state (void);
281
282 OCTAVE_API void save_state (void);
283
284 OCTAVE_API int get_dist_id (const std::string& d);
285
286 OCTAVE_API void set_internal_state (const uint32NDArray& s);
287
288 OCTAVE_API void switch_to_generator (int dist);
289
290 OCTAVE_API void fill (octave_idx_type len, double *v, double a);
291
292 OCTAVE_API void fill (octave_idx_type len, float *v, float a);
293 };
294
295 OCTAVE_END_NAMESPACE(octave) 295 OCTAVE_END_NAMESPACE(octave)
296 296
297 #endif 297 #endif