返回 Eigen::Ref 合法吗?

Is returning Eigen::Ref legit?

本文关键字：Ref Eigen 返回      更新时间：2023-10-16

Eigen的文档解释了如何将Eigen::Ref用作函数参数。将其用作函数返回值也是一个好主意吗？

例如

class XyTracker : public XyListener {
public:
XyTracker() = default;
XyTracker(XyTracker&&) = default;
XyTracker& operator=(XyTracker&&) = default;
const Eigen::Ref<const Eigen::ArrayXXd> Xs() const;
const Eigen::Ref<const Eigen::ArrayXd> Ys() const;
// XyListener
void OnXy(const Eigen::VectorXd& x, double y) final;
private:
Eigen::ArrayXXd xs_;
Eigen::ArrayXd ys_;
Eigen::Index n_ = 0;
};
inline const Eigen::Ref<const Eigen::ArrayXXd> XyTracker::Xs() const {
return xs_.topRows(n_);
}
inline const Eigen::Ref<const Eigen::ArrayXd> XyTracker::Ys() const {
return ys_.head(n_);
}

正如注释中已经指出的那样，返回Ref对象没有错，只要您确保引用的对象在使用引用时仍然有效。

简化示例：

struct A {
ArrayXXd xs;
Ref<const ArrayXXd> Xs() const {
return xs.topRows(5);  // works (when used properly)
}
Ref<const ArrayXXd> NotWorking() const {
ArrayXXd foo = 2*xs;
return foo.topRows(5); // compiles, but will give U.B.
};

// usage:
A a;
a.xs.setRandom(10,10);
Ref<const ArrayXXd> r1 = a.Xs();
// fine to use r1 here
a.xs.setRandom(20,20);
// from here on r1 will point to non-existing memory
// i.e., using r1 will be U.B.

U.B.(未定义的行为(示例本质上都是释放后使用，不幸的是，编译器几乎没有检测到，因此在使用Eigen::Ref时需要小心。UB 可能意味着您的单元测试有效，尽管您的代码很糟糕，但是突然在生产中您会遇到段错误......

相关文章：