Skip to content

Commit

Permalink
Use Eigen::Ref for input
Browse files Browse the repository at this point in the history
  • Loading branch information
@zfergus
zfergus committed Mar 17, 2023
1 parent 632a734 commit 52ee9d6
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
22 changes: 11 additions & 11 deletions src/finitediff.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ double get_denominator(const AccuracyOrder accuracy)

// Compute the gradient of a function at a point using finite differences.
void finite_gradient(
const Eigen::VectorXd& x,
const Eigen::Ref<const Eigen::VectorXd>& x,
const std::function<double(const Eigen::VectorXd&)>& f,
Eigen::VectorXd& grad,
const AccuracyOrder accuracy,
Expand Down Expand Up @@ -93,7 +93,7 @@ void finite_gradient(
}

void finite_jacobian(
const Eigen::VectorXd& x,
const Eigen::Ref<const Eigen::VectorXd>& x,
const std::function<Eigen::VectorXd(const Eigen::VectorXd&)>& f,
Eigen::MatrixXd& jac,
const AccuracyOrder accuracy,
Expand Down Expand Up @@ -121,7 +121,7 @@ void finite_jacobian(
}

void finite_hessian(
const Eigen::VectorXd& x,
const Eigen::Ref<const Eigen::VectorXd>& x,
const std::function<double(const Eigen::VectorXd&)>& f,
Eigen::MatrixXd& hess,
const AccuracyOrder accuracy,
Expand Down Expand Up @@ -159,8 +159,8 @@ void finite_hessian(

// Compare if two gradients are close enough.
bool compare_gradient(
const Eigen::VectorXd& x,
const Eigen::VectorXd& y,
const Eigen::Ref<const Eigen::VectorXd>& x,
const Eigen::Ref<const Eigen::VectorXd>& y,
const double test_eps,
const std::string& msg)
{
Expand All @@ -185,8 +185,8 @@ bool compare_gradient(

// Compare if two jacobians are close enough.
bool compare_jacobian(
const Eigen::MatrixXd& x,
const Eigen::MatrixXd& y,
const Eigen::Ref<const Eigen::MatrixXd>& x,
const Eigen::Ref<const Eigen::MatrixXd>& y,
const double test_eps,
const std::string& msg)
{
Expand Down Expand Up @@ -216,16 +216,16 @@ bool compare_jacobian(

// Compare if two hessians are close enough.
bool compare_hessian(
const Eigen::MatrixXd& x,
const Eigen::MatrixXd& y,
const Eigen::Ref<const Eigen::MatrixXd>& x,
const Eigen::Ref<const Eigen::MatrixXd>& y,
const double test_eps,
const std::string& msg)
{
return compare_jacobian(x, y, test_eps, msg);
}

// Flatten the matrix rowwise
Eigen::VectorXd flatten(const Eigen::MatrixXd& X)
Eigen::VectorXd flatten(const Eigen::Ref<const Eigen::MatrixXd>& X)
{
Eigen::VectorXd x(X.size());
for (int i = 0; i < X.rows(); i++) {
Expand All @@ -237,7 +237,7 @@ Eigen::VectorXd flatten(const Eigen::MatrixXd& X)
}

// Unflatten rowwise
Eigen::MatrixXd unflatten(const Eigen::VectorXd& x, int dim)
Eigen::MatrixXd unflatten(const Eigen::Ref<const Eigen::VectorXd>& x, int dim)
{
assert(x.size() % dim == 0);
Eigen::MatrixXd X(x.size() / dim, dim);
Expand Down
22 changes: 11 additions & 11 deletions src/finitediff.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ enum AccuracyOrder {
* @param[in] eps Value of the finite difference step.
*/
void finite_gradient(
const Eigen::VectorXd& x,
const Eigen::Ref<const Eigen::VectorXd>& x,
const std::function<double(const Eigen::VectorXd&)>& f,
Eigen::VectorXd& grad,
const AccuracyOrder accuracy = SECOND,
Expand All @@ -48,7 +48,7 @@ void finite_gradient(
* @param[in] eps Value of the finite difference step.
*/
void finite_jacobian(
const Eigen::VectorXd& x,
const Eigen::Ref<const Eigen::VectorXd>& x,
const std::function<Eigen::VectorXd(const Eigen::VectorXd&)>& f,
Eigen::MatrixXd& jac,
const AccuracyOrder accuracy = SECOND,
Expand All @@ -64,7 +64,7 @@ void finite_jacobian(
* @param[in] eps Value of the finite difference step.
*/
void finite_hessian(
const Eigen::VectorXd& x,
const Eigen::Ref<const Eigen::VectorXd>& x,
const std::function<double(const Eigen::VectorXd&)>& f,
Eigen::MatrixXd& hess,
const AccuracyOrder accuracy = SECOND,
Expand All @@ -81,8 +81,8 @@ void finite_hessian(
* @return A boolean for if x and y are close to the same value.
*/
bool compare_gradient(
const Eigen::VectorXd& x,
const Eigen::VectorXd& y,
const Eigen::Ref<const Eigen::VectorXd>& x,
const Eigen::Ref<const Eigen::VectorXd>& y,
const double test_eps = 1e-4,
const std::string& msg = "compare_gradient ");

Expand All @@ -97,8 +97,8 @@ bool compare_gradient(
* @return A boolean for if x and y are close to the same value.
*/
bool compare_jacobian(
const Eigen::MatrixXd& x,
const Eigen::MatrixXd& y,
const Eigen::Ref<const Eigen::MatrixXd>& x,
const Eigen::Ref<const Eigen::MatrixXd>& y,
const double test_eps = 1e-4,
const std::string& msg = "compare_jacobian ");

Expand All @@ -113,15 +113,15 @@ bool compare_jacobian(
* @return A boolean for if x and y are close to the same value.
*/
bool compare_hessian(
const Eigen::MatrixXd& x,
const Eigen::MatrixXd& y,
const Eigen::Ref<const Eigen::MatrixXd>& x,
const Eigen::Ref<const Eigen::MatrixXd>& y,
const double test_eps = 1e-4,
const std::string& msg = "compare_hessian ");

/// @brief Flatten the matrix rowwise
Eigen::VectorXd flatten(const Eigen::MatrixXd& X);
Eigen::VectorXd flatten(const Eigen::Ref<const Eigen::MatrixXd>& X);

/// @brief Unflatten rowwise
Eigen::MatrixXd unflatten(const Eigen::VectorXd& x, int dim);
Eigen::MatrixXd unflatten(const Eigen::Ref<const Eigen::VectorXd>& x, int dim);

} // namespace fd

0 comments on commit 52ee9d6

Please sign in to comment.