summaryrefslogtreecommitdiffstats
path: root/src/armadillo/include/armadillo_bits/fn_randn.hpp
blob: 37cb3db98da4c9e8afca7a54b35714179aaf6e90 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
// SPDX-License-Identifier: Apache-2.0
// 
// Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au)
// Copyright 2008-2016 National ICT Australia (NICTA)
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ------------------------------------------------------------------------


//! \addtogroup fn_randn
//! @{



// scalars

arma_warn_unused
inline
double
randn()
  {
  arma_extra_debug_sigprint();
  
  return double(arma_rng::randn<double>());
  }



template<typename eT>
arma_warn_unused
inline
typename arma_real_or_cx_only<eT>::result
randn()
  {
  arma_extra_debug_sigprint();
  
  return eT(arma_rng::randn<eT>());
  }



arma_warn_unused
inline
double
randn(const distr_param& param)
  {
  arma_extra_debug_sigprint();
  
  if(param.state == 0)  { return double(arma_rng::randn<double>()); }
  
  double mu = double(0);
  double sd = double(1);
  
  param.get_double_vals(mu,sd);
  
  arma_debug_check( (sd <= double(0)), "randn(): incorrect distribution parameters; standard deviation must be > 0" );
  
  const double val = double(arma_rng::randn<double>());
  
  return ((val * sd) + mu);
  }



template<typename eT>
arma_warn_unused
inline
typename arma_real_or_cx_only<eT>::result
randn(const distr_param& param)
  {
  arma_extra_debug_sigprint();
  
  if(param.state == 0)  { return eT(arma_rng::randn<eT>()); }
  
  double mu = double(0);
  double sd = double(1);
  
  param.get_double_vals(mu,sd);
  
  arma_debug_check( (sd <= double(0)), "randn(): incorrect distribution parameters; standard deviation must be > 0" );
  
  eT val = eT(0);
  
  arma_rng::randn<eT>::fill(&val, 1, mu, sd);  // using fill() as eT can be complex
  
  return val;
  }



// vectors

arma_warn_unused
inline
vec
randn(const uword n_elem, const distr_param& param = distr_param())
  {
  arma_extra_debug_sigprint();
  
  vec out(n_elem, arma_nozeros_indicator());
  
  if(param.state == 0)
    {
    arma_rng::randn<double>::fill(out.memptr(), n_elem);
    }
  else
    {
    double mu = double(0);
    double sd = double(1);
    
    param.get_double_vals(mu,sd);
    
    arma_debug_check( (sd <= double(0)), "randn(): incorrect distribution parameters; standard deviation must be > 0" );
    
    arma_rng::randn<double>::fill(out.memptr(), n_elem, mu, sd);
    }
  
  return out;
  }



template<typename obj_type>
arma_warn_unused
inline
obj_type
randn(const uword n_elem, const distr_param& param = distr_param(), const typename arma_Mat_Col_Row_only<obj_type>::result* junk = nullptr)
  {
  arma_extra_debug_sigprint();
  arma_ignore(junk);
  
  typedef typename obj_type::elem_type eT;
  
  const uword n_rows = (is_Row<obj_type>::value) ? uword(1) : n_elem;
  const uword n_cols = (is_Row<obj_type>::value) ? n_elem   : uword(1);
  
  obj_type out(n_rows, n_cols, arma_nozeros_indicator());
  
  if(param.state == 0)
    {
    arma_rng::randn<eT>::fill(out.memptr(), out.n_elem);
    }
  else
    {
    double mu = double(0);
    double sd = double(1);
    
    param.get_double_vals(mu,sd);
    
    arma_debug_check( (sd <= double(0)), "randn(): incorrect distribution parameters; standard deviation must be > 0" );
    
    arma_rng::randn<eT>::fill(out.memptr(), out.n_elem, mu, sd);
    }
  
  return out;
  }



// matrices

arma_warn_unused
inline
mat
randn(const uword n_rows, const uword n_cols, const distr_param& param = distr_param())
  {
  arma_extra_debug_sigprint();
  
  mat out(n_rows, n_cols, arma_nozeros_indicator());
  
  if(param.state == 0)
    {
    arma_rng::randn<double>::fill(out.memptr(), out.n_elem);
    }
  else
    {
    double mu = double(0);
    double sd = double(1);
    
    param.get_double_vals(mu,sd);
    
    arma_debug_check( (sd <= double(0)), "randn(): incorrect distribution parameters; standard deviation must be > 0" );
    
    arma_rng::randn<double>::fill(out.memptr(), out.n_elem, mu, sd);
    }
  
  return out;
  }



arma_warn_unused
inline
mat
randn(const SizeMat& s, const distr_param& param = distr_param())
  {
  arma_extra_debug_sigprint();
  
  return randn(s.n_rows, s.n_cols, param);
  }



template<typename obj_type>
arma_warn_unused
inline
obj_type
randn(const uword n_rows, const uword n_cols, const distr_param& param = distr_param(), const typename arma_Mat_Col_Row_only<obj_type>::result* junk = nullptr)
  {
  arma_extra_debug_sigprint();
  arma_ignore(junk);
  
  typedef typename obj_type::elem_type eT;
  
  if(is_Col<obj_type>::value)  { arma_debug_check( (n_cols != 1), "randn(): incompatible size" ); }
  if(is_Row<obj_type>::value)  { arma_debug_check( (n_rows != 1), "randn(): incompatible size" ); }
  
  obj_type out(n_rows, n_cols, arma_nozeros_indicator());
  
  if(param.state == 0)
    {
    arma_rng::randn<eT>::fill(out.memptr(), out.n_elem);
    }
  else
    {
    double mu = double(0);
    double sd = double(1);
    
    param.get_double_vals(mu,sd);
    
    arma_debug_check( (sd <= double(0)), "randn(): incorrect distribution parameters; standard deviation must be > 0" );
    
    arma_rng::randn<eT>::fill(out.memptr(), out.n_elem, mu, sd);
    }
  
  return out;
  }



template<typename obj_type>
arma_warn_unused
inline
obj_type
randn(const SizeMat& s, const distr_param& param = distr_param(), const typename arma_Mat_Col_Row_only<obj_type>::result* junk = nullptr)
  {
  arma_extra_debug_sigprint();
  arma_ignore(junk);
  
  return randn<obj_type>(s.n_rows, s.n_cols, param);
  }



// cubes


arma_warn_unused
inline
cube
randn(const uword n_rows, const uword n_cols, const uword n_slices, const distr_param& param = distr_param())
  {
  arma_extra_debug_sigprint();
  
  cube out(n_rows, n_cols, n_slices, arma_nozeros_indicator());
  
  if(param.state == 0)
    {
    arma_rng::randn<double>::fill(out.memptr(), out.n_elem);
    }
  else
    {
    double mu = double(0);
    double sd = double(1);
    
    param.get_double_vals(mu,sd);
    
    arma_debug_check( (sd <= double(0)), "randn(): incorrect distribution parameters; standard deviation must be > 0" );
    
    arma_rng::randn<double>::fill(out.memptr(), out.n_elem, mu, sd);
    }
  
  return out;
  }



arma_warn_unused
inline
cube
randn(const SizeCube& s, const distr_param& param = distr_param())
  {
  arma_extra_debug_sigprint();
  
  return randn(s.n_rows, s.n_cols, s.n_slices, param);
  }



template<typename cube_type>
arma_warn_unused
inline
cube_type
randn(const uword n_rows, const uword n_cols, const uword n_slices, const distr_param& param = distr_param(), const typename arma_Cube_only<cube_type>::result* junk = nullptr)
  {
  arma_extra_debug_sigprint();
  arma_ignore(junk);
  
  typedef typename cube_type::elem_type eT;
  
  cube_type out(n_rows, n_cols, n_slices, arma_nozeros_indicator());
  
  if(param.state == 0)
    {
    arma_rng::randn<eT>::fill(out.memptr(), out.n_elem);
    }
  else
    {
    double mu = double(0);
    double sd = double(1);
    
    param.get_double_vals(mu,sd);
    
    arma_debug_check( (sd <= double(0)), "randn(): incorrect distribution parameters; standard deviation must be > 0" );
    
    arma_rng::randn<eT>::fill(out.memptr(), out.n_elem, mu, sd);
    }
  
  return out;
  }



template<typename cube_type>
arma_warn_unused
inline
cube_type
randn(const SizeCube& s, const distr_param& param = distr_param(), const typename arma_Cube_only<cube_type>::result* junk = nullptr)
  {
  arma_extra_debug_sigprint();
  arma_ignore(junk);
  
  return randn<cube_type>(s.n_rows, s.n_cols, s.n_slices, param);
  }



//! @}