-
-
Notifications
You must be signed in to change notification settings - Fork 369
/
serializer.hpp
573 lines (524 loc) · 17.8 KB
/
serializer.hpp
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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
#ifndef STAN_IO_SERIALIZER_HPP
#define STAN_IO_SERIALIZER_HPP
#include <stan/math/rev.hpp>
namespace stan {
namespace io {
/**
* A stream-based writer for scalar, vector, matrix, and array data types.
*
*`T` is the storage scalar type. Variables written by the serializer must
* have a scalar type convertible to type `T`.
*
* @tparam T Basic scalar type.
*/
template <typename T>
class serializer {
private:
Eigen::Map<Eigen::Matrix<T, -1, 1>> map_r_; // map of reals.
size_t r_size_{0}; // size of reals available.
size_t pos_r_{0}; // current position in map of reals.
/**
* Check there is room for at least m more reals to store
*
* @param m Number of reals to Write
* @throws std::runtime_error if there isn't room for m reals
*/
void check_r_capacity(size_t m) const {
if (pos_r_ + m > r_size_) {
[](auto r_size_, auto pos_r_, auto m)
STAN_COLD_PATH {
throw std::runtime_error(
std::string("In serializer: Storage capacity [") +
std::to_string(r_size_) +
"] exceeded while writing value of size [" +
std::to_string(m) + "] from position [" +
std::to_string(pos_r_) +
"]. This is an internal error, if you see it please report it as" +
" an issue on the Stan github repository.");
}(r_size_, pos_r_, m);
}
}
template <typename S>
using is_arithmetic_or_ad
= bool_constant<std::is_arithmetic<S>::value || is_autodiff<S>::value>;
public:
using matrix_t = Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic>;
using vector_t = Eigen::Matrix<T, Eigen::Dynamic, 1>;
using row_vector_t = Eigen::Matrix<T, 1, Eigen::Dynamic>;
using map_matrix_t = Eigen::Map<matrix_t>;
using map_vector_t = Eigen::Map<vector_t>;
using map_row_vector_t = Eigen::Map<row_vector_t>;
using var_matrix_t = stan::math::var_value<
Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic>>;
using var_vector_t
= stan::math::var_value<Eigen::Matrix<double, Eigen::Dynamic, 1>>;
using var_row_vector_t
= stan::math::var_value<Eigen::Matrix<double, 1, Eigen::Dynamic>>;
/**
* Construct a variable serializer using data_r for storage.
*
* Attempting to write beyond the end of data_r will raise a runtime
* exception.
*
* @tparam RVec Vector like class.
* @param data_r Storage vector
*/
template <typename RVec, require_vector_like_t<RVec>* = nullptr>
explicit serializer(RVec& data_r)
: map_r_(data_r.data(), data_r.size()), r_size_(data_r.size()) {}
/**
* Return the number of scalars available to be written to.
*/
inline size_t available() const noexcept { return r_size_ - pos_r_; }
/**
* Write a scalar to storage
* @tparam Scalar A Stan scalar class
* @param x A scalar
*/
template <typename Scalar, require_t<is_arithmetic_or_ad<Scalar>>* = nullptr,
require_not_var_matrix_t<Scalar>* = nullptr>
inline void write(Scalar x) {
check_r_capacity(1);
map_r_.coeffRef(pos_r_) = x;
pos_r_++;
}
/**
* Write a complex variable to storage
* @tparam Complex An `std::complex` type.
* @param x The complex scalar
*/
template <typename Complex, require_complex_t<Complex>* = nullptr>
inline void write(Complex&& x) {
check_r_capacity(2);
map_r_.coeffRef(pos_r_) = x.real();
map_r_.coeffRef(pos_r_ + 1) = x.imag();
pos_r_ += 2;
}
/**
* Write an Eigen column vector to storage
* @tparam Vec An Eigen type with compile time columns equal to 1.
* @param vec The Eigen column vector
*/
template <typename Vec, require_eigen_col_vector_t<Vec>* = nullptr,
require_not_vt_complex<Vec>* = nullptr>
inline void write(Vec&& vec) {
check_r_capacity(vec.size());
map_vector_t(&map_r_.coeffRef(pos_r_), vec.size()) = vec;
pos_r_ += vec.size();
}
/**
* Write a Eigen column vector with inner complex type to storage
* @tparam Vec An Eigen type with compile time columns equal to 1.
* @param vec The Eigen column vector
*/
template <typename Vec, require_eigen_col_vector_t<Vec>* = nullptr,
require_vt_complex<Vec>* = nullptr>
inline void write(Vec&& vec) {
check_r_capacity(2 * vec.size());
using stan::math::to_ref;
auto&& vec_ref = to_ref(std::forward<Vec>(vec));
for (Eigen::Index i = 0; i < vec_ref.size(); ++i) {
map_r_.coeffRef(pos_r_) = vec_ref.coeff(i).real();
map_r_.coeffRef(pos_r_ + 1) = vec_ref.coeff(i).imag();
pos_r_ += 2;
}
}
/**
* Write an Eigen row vector to storage
* @tparam Vec An Eigen type with compile time rows equal to 1.
* @param vec The Eigen row vector
*/
template <typename Vec, require_eigen_row_vector_t<Vec>* = nullptr,
require_not_vt_complex<Vec>* = nullptr>
inline void write(Vec&& vec) {
check_r_capacity(vec.size());
map_row_vector_t(&map_r_.coeffRef(pos_r_), vec.size()) = vec;
pos_r_ += vec.size();
}
/**
* Write an Eigen row vector with inner complex type to storage
* @tparam Vec An Eigen type with compile time rows equal to 1.
* @param vec The Eigen row vector
*/
template <typename Vec, require_eigen_row_vector_t<Vec>* = nullptr,
require_vt_complex<Vec>* = nullptr>
inline void write(Vec&& vec) {
using stan::math::to_ref;
check_r_capacity(2 * vec.size());
auto&& vec_ref = to_ref(std::forward<Vec>(vec));
for (Eigen::Index i = 0; i < vec_ref.size(); ++i) {
map_r_.coeffRef(pos_r_) = vec_ref.coeff(i).real();
map_r_.coeffRef(pos_r_ + 1) = vec_ref.coeff(i).imag();
pos_r_ += 2;
}
}
/**
* Write a Eigen matrix of size `(rows, cols)` to storage
* @tparam Mat An Eigen class with dynamic rows and columns
* @param mat An Eigen object
*/
template <typename Mat, require_eigen_matrix_dynamic_t<Mat>* = nullptr,
require_not_vt_complex<Mat>* = nullptr>
inline void write(Mat&& mat) {
check_r_capacity(mat.size());
map_matrix_t(&map_r_.coeffRef(pos_r_), mat.rows(), mat.cols()) = mat;
pos_r_ += mat.size();
}
/**
* Write a Eigen matrix of size `(rows, cols)` with complex inner type to
* storage
* @tparam Mat The type to write
*/
template <typename Mat, require_eigen_matrix_dynamic_t<Mat>* = nullptr,
require_vt_complex<Mat>* = nullptr>
inline void write(Mat&& x) {
check_r_capacity(2 * x.size());
using stan::math::to_ref;
auto&& x_ref = to_ref(x);
for (Eigen::Index i = 0; i < x.size(); ++i) {
map_r_.coeffRef(pos_r_) = x_ref.coeff(i).real();
map_r_.coeffRef(pos_r_ + 1) = x_ref.coeff(i).imag();
pos_r_ += 2;
}
}
/**
* Write a `var_value` with inner Eigen type to storage
* @tparam Ret The type to write
* @tparam T_ Should never be set by user, set to default value of `T` for
* performing deduction on the class's inner type.
* dimensions of the `var_value` matrix or vector.
*/
template <typename VarMat, typename T_ = T, require_var_t<T_>* = nullptr,
require_var_matrix_t<VarMat>* = nullptr>
inline void write(VarMat&& x) {
check_r_capacity(x.size());
map_matrix_t(&map_r_.coeffRef(pos_r_), x.rows(), x.cols())
= stan::math::from_var_value(x);
pos_r_ += x.size();
}
/**
* Write an Eigen type when the serializers inner class is not var.
* @tparam VarMat The type to write
* @tparam T_ Should never be set by user, set to default value of `T` for
* performing deduction on the class's inner type.
* dimensions of the `var_value` matrix or vector.
*/
template <typename VarMat, typename T_ = T, require_not_var_t<T_>* = nullptr,
require_var_matrix_t<VarMat>* = nullptr>
inline void write(VarMat&& x) {
this->write(stan::math::value_of(x));
}
/**
* Write a `std::vector` to storage
* @tparam StdVec The type to write
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write(StdVec&& x) {
for (const auto& x_i : x) {
this->write(x_i);
}
}
/**
* Write a serialized lower bounded variable and unconstrain it
*
* @tparam S A scalar, Eigen type, or `std::vector`
* @tparam L Type of lower bound
* @param lb Lower bound
* @param x An object of the types listed above.
*/
template <typename S, typename L>
inline void write_free_lb(const L& lb, const S& x) {
this->write(stan::math::lb_free(x, lb));
}
/**
* Write a serialized lower bounded variable and unconstrain it
*
* @tparam S A scalar, Eigen type, or `std::vector`
* @tparam U Type of upper bound
* @param ub Upper bound
* @param x An object of the types listed above.
*/
template <typename S, typename U>
inline void write_free_ub(const U& ub, const S& x) {
this->write(stan::math::ub_free(x, ub));
}
/**
* Write a serialized bounded variable and unconstrain it
*
* @tparam S A scalar, Eigen type, or `std::vector`
* @tparam L Type of lower bound
* @tparam U Type of upper bound
* @param lb Lower bound
* @param ub Upper bound
* @param x An object of the types listed above.
*/
template <typename S, typename L, typename U>
inline void write_free_lub(const L& lb, const U& ub, const S& x) {
this->write(stan::math::lub_free(x, lb, ub));
}
/**
* Write a serialized offset-multiplied variable and unconstrain it
*
* @tparam S A scalar, Eigen type, or `std::vector`
* @tparam O Type of offset
* @tparam M Type of multiplier
* @param offset Offset
* @param multiplier Multiplier
* @param x An object of the types listed above.
*/
template <typename S, typename O, typename M>
inline void write_free_offset_multiplier(const O& offset, const M& multiplier,
const S& x) {
this->write(stan::math::offset_multiplier_free(x, offset, multiplier));
}
/**
* Write a serialized unit vector and unconstrain it
*
* @tparam Vec An Eigen type with either fixed rows or columns at compile
* time.
* @param x The vector to read from.
*/
template <typename Vec, require_not_std_vector_t<Vec>* = nullptr>
inline void write_free_unit_vector(const Vec& x) {
this->write(stan::math::unit_vector_free(x));
}
/**
* Write serialized unit vectors and unconstrain them
*
* @tparam StdVec A `std:vector`
* @param x An std vector.
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_unit_vector(const StdVec& x) {
for (const auto& ret_i : x) {
this->write_free_unit_vector(ret_i);
}
}
/**
* Write a serialized simplex and unconstrain it
*
* @tparam Vec An Eigen type with either fixed rows or columns at compile
* time.
* @param x The vector to read from.
*/
template <typename Vec, require_not_std_vector_t<Vec>* = nullptr>
inline void write_free_simplex(const Vec& x) {
this->write(stan::math::simplex_free(x));
}
/**
* Write serialized simplices and unconstrain them
*
* @tparam StdVec A `std:vector`
* @param x An std vector.
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_simplex(const StdVec& x) {
for (const auto& ret_i : x) {
this->write_free_simplex(ret_i);
}
}
/**
* Write a serialized sum-to-zero vector and unconstrain it
*
* @tparam Vec An Eigen type with either fixed rows or columns at compile
* time.
* @param x The vector to read from.
*/
template <typename Vec, require_not_std_vector_t<Vec>* = nullptr>
inline void write_free_sum_to_zero(const Vec& x) {
this->write(stan::math::sum_to_zero_free(x));
}
/**
* Write serialized zero sum vectors and unconstrain them
*
* @tparam StdVec A `std:vector`
* @param x An std vector.
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_sum_to_zero(const StdVec& x) {
for (const auto& ret_i : x) {
this->write_free_sum_to_zero(ret_i);
}
}
/**
* Write a serialized ordered and unconstrain it
*
* @tparam Vec An Eigen type with either fixed rows or columns at compile
* time.
* @param x The vector to read from.
*/
template <typename Vec, require_not_std_vector_t<Vec>* = nullptr>
inline void write_free_ordered(const Vec& x) {
this->write(stan::math::ordered_free(x));
}
/**
* Write serialized ordered vectors and unconstrain them
*
* @tparam StdVec A `std:vector`
* @param x An std vector.
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_ordered(const StdVec& x) {
for (const auto& ret_i : x) {
this->write_free_ordered(ret_i);
}
}
/**
* Write a serialized positive ordered vector and unconstrain it
*
* @tparam Vec An Eigen type with either fixed rows or columns at compile
* time.
* @param x The vector to read from.
*/
template <typename Vec, require_not_std_vector_t<Vec>* = nullptr>
inline void write_free_positive_ordered(const Vec& x) {
this->write(stan::math::positive_ordered_free(x));
}
/**
* Write serialized positive ordered vectors and unconstrain them
*
* @tparam StdVec A `std:vector`
* @param x An std vector.
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_positive_ordered(const StdVec& x) {
for (const auto& ret_i : x) {
this->write_free_positive_ordered(ret_i);
}
}
/**
* Write a serialized covariance matrix cholesky factor and unconstrain it
*
* @tparam Mat An Eigen type with dynamic rows and columns at compile time.
* @param x An Eigen matrix to write to the serialized vector.
*/
template <typename Mat, require_not_std_vector_t<Mat>* = nullptr>
inline void write_free_cholesky_factor_cov(const Mat& x) {
this->write(stan::math::cholesky_factor_free(x));
}
/**
* Write serialized covariance matrix cholesky factors and unconstrain them
*
* @tparam StdVec A `std:vector`
* @param x An std vector.
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_cholesky_factor_cov(const StdVec& x) {
for (const auto& ret_i : x) {
this->write_free_cholesky_factor_cov(ret_i);
}
}
/**
* Write a serialized covariance matrix cholesky factor and unconstrain it
*
* @tparam Mat Type of input
* @param x An Eigen matrix to write to the serialized vector.
*/
template <typename Mat, require_not_std_vector_t<Mat>* = nullptr>
inline void write_free_cholesky_factor_corr(const Mat& x) {
this->write(stan::math::cholesky_corr_free(x));
}
/**
* Write serialized correlation matrix cholesky factors and unconstrain them
*
* @tparam StdVec A `std:vector`
* @param x An std vector.
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_cholesky_factor_corr(const StdVec& x) {
for (const auto& ret_i : x) {
this->write_free_cholesky_factor_corr(ret_i);
}
}
/**
* Write a serialized covariance matrix cholesky factor and unconstrain it
*
* @tparam Mat An Eigen type with dynamic rows and columns at compile time
* @param x An Eigen matrix to write to the serialized vector.
*/
template <typename Mat, require_not_std_vector_t<Mat>* = nullptr>
inline void write_free_cov_matrix(const Mat& x) {
this->write(stan::math::cov_matrix_free(x));
}
/**
* Write serialized covariance matrices and unconstrain them
*
* @tparam StdVec A `std:vector`
* @param x a standard vector.
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_cov_matrix(const StdVec& x) {
for (const auto& ret_i : x) {
this->write_free_cov_matrix(ret_i);
}
}
/**
* Write a serialized covariance matrix cholesky factor and unconstrain it
*
* @tparam Mat An Eigen type with dynamic rows and columns at compile time.
* @param x An Eigen matrix to write to the serialized vector.
*/
template <typename Mat, require_not_std_vector_t<Mat>* = nullptr>
inline void write_free_corr_matrix(const Mat& x) {
this->write(stan::math::corr_matrix_free(x));
}
/**
* Write serialized correlation matrices and unconstrain them
*
* @tparam StdVec A `std:vector`
* @param x An std vector.
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_corr_matrix(const StdVec& x) {
for (const auto& ret_i : x) {
this->write_free_corr_matrix(ret_i);
}
}
/**
* Read a serialized column simplex matrix and unconstrain it
*
* @tparam Mat An Eigen matrix
* @param x A column stochastic eigen matrix
*/
template <typename Mat, require_not_std_vector_t<Mat>* = nullptr>
inline void write_free_stochastic_column(Mat&& x) {
this->write(stan::math::stochastic_column_free(x));
}
/**
* Read serialized column simplex matrices and unconstrain them
*
* @tparam StdVec A standard vector of Eigen matrices
* @param x A vector of column stochastic Eigen matrices
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_stochastic_column(StdVec&& x) {
for (auto&& x_i : x) {
this->write_free_stochastic_column(x_i);
}
}
/**
* Read a serialized row simplex matrix and unconstrain it
*
* @tparam Mat An Eigen matrix
* @param x A row stochastic eigen matrix
*/
template <typename Mat, require_not_std_vector_t<Mat>* = nullptr>
inline void write_free_stochastic_row(Mat&& x) {
this->write(stan::math::stochastic_row_free(x));
}
/**
* Read serialized row simplex matrices and unconstrain them
*
* @tparam StdVec A standard vector of Eigen matrices
* @param x A vector of row stochastic Eigen matrices
*/
template <typename StdVec, require_std_vector_t<StdVec>* = nullptr>
inline void write_free_stochastic_row(StdVec&& x) {
for (auto&& x_i : x) {
this->write_free_stochastic_row(x_i);
}
}
};
} // namespace io
} // namespace stan
#endif