Stan Math Library  2.20.0
reverse mode automatic differentiation
assign.hpp
Go to the documentation of this file.
1 #ifndef STAN_MATH_PRIM_MAT_FUN_ASSIGN_HPP
2 #define STAN_MATH_PRIM_MAT_FUN_ASSIGN_HPP
3 
9 #include <iostream>
10 #include <sstream>
11 #include <stdexcept>
12 #include <string>
13 #include <vector>
14 
15 namespace stan {
16 namespace math {
17 
24 template <int N>
25 inline void print_mat_size(std::ostream& o) {
26  if (N == Eigen::Dynamic)
27  o << "dynamically sized";
28  else
29  o << N;
30 }
31 
46 template <typename T_lhs, typename T_rhs>
47 inline void assign(T_lhs& x, const T_rhs& y) {
48  x = y;
49 }
50 
71 template <typename T_lhs, typename T_rhs, int R1, int C1, int R2, int C2>
72 inline void assign(Eigen::Matrix<T_lhs, R1, C1>& x,
73  const Eigen::Matrix<T_rhs, R2, C2>& y) {
74  std::stringstream ss;
75  ss << "shapes must match, but found"
76  << " left-hand side rows=";
77  print_mat_size<R1>(ss);
78  ss << "; left-hand side cols=";
79  print_mat_size<C1>(ss);
80  ss << "; right-hand side rows=";
81  print_mat_size<R2>(ss);
82  ss << "; right-hand side cols=";
83  print_mat_size<C2>(ss);
84  std::string ss_str(ss.str());
85  invalid_argument("assign(Eigen::Matrix, Eigen::Matrix)", "", "",
86  ss_str.c_str());
87 }
88 
106 template <typename T_lhs, typename T_rhs, int R, int C>
107 inline void assign(Eigen::Matrix<T_lhs, R, C>& x,
108  const Eigen::Matrix<T_rhs, R, C>& y) {
109  check_matching_dims("assign", "left-hand-side", x, "right-hand-side", y);
110  for (int i = 0; i < x.size(); ++i)
111  assign(x(i), y(i));
112 }
113 
137 template <typename T_lhs, typename T, int R, int C>
138 inline void assign(Eigen::Block<T_lhs> x, const Eigen::Matrix<T, R, C>& y) {
139  check_size_match("assign", "left-hand side rows", x.rows(),
140  "right-hand side rows", y.rows());
141  check_size_match("assign", "left-hand side cols", x.cols(),
142  "right-hand side cols", y.cols());
143  for (int n = 0; n < y.cols(); ++n)
144  for (int m = 0; m < y.rows(); ++m)
145  assign(x(m, n), y(m, n));
146 }
147 
167 template <typename T_lhs, typename T_rhs>
168 inline void assign(std::vector<T_lhs>& x, const std::vector<T_rhs>& y) {
169  check_matching_sizes("assign", "left-hand side", x, "right-hand side", y);
170  for (size_t i = 0; i < x.size(); ++i)
171  assign(x[i], y[i]);
172 }
173 
174 } // namespace math
175 } // namespace stan
176 #endif
void print_mat_size(std::ostream &o)
Helper function to return the matrix size as either "dynamic" or "1".
Definition: assign.hpp:25
void check_size_match(const char *function, const char *name_i, T_size1 i, const char *name_j, T_size2 j)
Check if the provided sizes match.
void check_matching_dims(const char *function, const char *name1, const matrix_cl &y1, const char *name2, const matrix_cl &y2)
Check if two matrix_cls have the same dimensions.
void invalid_argument(const char *function, const char *name, const T &y, const char *msg1, const char *msg2)
Throw an invalid_argument exception with a consistently formatted message.
void check_matching_sizes(const char *function, const char *name1, const T_y1 &y1, const char *name2, const T_y2 &y2)
Check if two structures at the same size.
void assign(T_lhs &x, const T_rhs &y)
Copy the right-hand side&#39;s value to the left-hand side variable.
Definition: assign.hpp:47

     [ Stan Home Page ] © 2011–2018, Stan Development Team.