singular_values.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_PRIM_FUN_SINGULAR_VALUES_HPP
#define STAN_MATH_PRIM_FUN_SINGULAR_VALUES_HPP
 
#include <stan/math/prim/meta.hpp>
#include <stan/math/prim/fun/Eigen.hpp>
#include <stan/math/prim/err/check_nonzero_size.hpp>
 
namespace stan {
namespace math {
 
template <typename EigMat, require_eigen_matrix_dynamic_t<EigMat>* = nullptr,
          require_not_st_var<EigMat>* = nullptr>
inline auto singular_values(EigMat&& m) {
  if (unlikely(m.size() == 0)) {
    return Eigen::Matrix<base_type_t<EigMat>, Eigen::Dynamic, 1>(0, 1);
  }
  return Eigen::JacobiSVD<Eigen::Matrix<value_type_t<EigMat>, Eigen::Dynamic,
                                        Eigen::Dynamic> >(
             to_ref(std::forward<EigMat>(m)))
      .singularValues();
}
 
}  // namespace math
}  // namespace stan
 
#endif