File: col.hpp

package info (click to toggle)
r-cran-stanheaders 2.18.1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 12,612 kB
  • sloc: cpp: 84,006; ansic: 39,321; lisp: 66; makefile: 5
file content (31 lines) | stat: -rw-r--r-- 859 bytes parent folder | download | duplicates (3)
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
#ifndef STAN_MATH_PRIM_MAT_FUN_COL_HPP
#define STAN_MATH_PRIM_MAT_FUN_COL_HPP

#include <stan/math/prim/mat/fun/Eigen.hpp>
#include <stan/math/prim/mat/err/check_column_index.hpp>

namespace stan {
namespace math {

/**
 * Return the specified column of the specified matrix
 * using start-at-1 indexing.
 *
 * This is equivalent to calling <code>m.col(i - 1)</code> and
 * assigning the resulting template expression to a column vector.
 *
 * @param m Matrix.
 * @param j Column index (count from 1).
 * @return Specified column of the matrix.
 * @throw std::out_of_range if j is out of range.
 */
template <typename T>
inline Eigen::Matrix<T, Eigen::Dynamic, 1> col(
    const Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic>& m, size_t j) {
  check_column_index("col", "j", m, j);
  return m.col(j - 1);
}

}  // namespace math
}  // namespace stan
#endif