mirror of
https://github.com/pybind/pybind11.git
synced 2024-12-03 10:27:12 +00:00
5fd5074a0b
Eigen::Ref is a common way to pass eigen dense types without needing a template, e.g. the single definition `void func(Eigen::Ref<Eigen::MatrixXd> x)` can be called with any double matrix-like object. The current pybind11 eigen support fails with internal errors if attempting to bind a function with an Eigen::Ref<...> argument because Eigen::Ref<...> satisfies the "is_eigen_dense" requirement, but can't compile if actually used: Eigen::Ref<...> itself is not default constructible, and so the argument std::tuple containing an Eigen::Ref<...> isn't constructible, which results in compilation failure. This commit adds support for Eigen::Ref<...> by giving it its own type_caster implementation which consists of an internal type_caster of the referenced type, load/cast methods that dispatch to the internal type_caster, and a unique_ptr to an Eigen::Ref<> instance that gets set during load(). There is, of course, no performance advantage for pybind11-using code of using Eigen::Ref<...>--we are allocating a matrix of the derived type when loading it--but this has the advantage of allowing pybind11 to bind transparently to C++ methods taking Eigen::Refs.
107 lines
3.6 KiB
C++
107 lines
3.6 KiB
C++
/*
|
|
example/eigen.cpp -- automatic conversion of Eigen types
|
|
|
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>
|
|
|
|
All rights reserved. Use of this source code is governed by a
|
|
BSD-style license that can be found in the LICENSE file.
|
|
*/
|
|
|
|
#include "example.h"
|
|
#include <pybind11/eigen.h>
|
|
#include <Eigen/Cholesky>
|
|
|
|
Eigen::VectorXf double_col(const Eigen::VectorXf& x)
|
|
{ return 2.0f * x; }
|
|
|
|
Eigen::RowVectorXf double_row(const Eigen::RowVectorXf& x)
|
|
{ return 2.0f * x; }
|
|
|
|
Eigen::MatrixXf double_mat_cm(const Eigen::MatrixXf& x)
|
|
{ return 2.0f * x; }
|
|
|
|
// Different ways of passing via Eigen::Ref; the first and second are the Eigen-recommended
|
|
Eigen::MatrixXd cholesky1(Eigen::Ref<Eigen::MatrixXd> &x) { return x.llt().matrixL(); }
|
|
Eigen::MatrixXd cholesky2(const Eigen::Ref<const Eigen::MatrixXd> &x) { return x.llt().matrixL(); }
|
|
Eigen::MatrixXd cholesky3(const Eigen::Ref<Eigen::MatrixXd> &x) { return x.llt().matrixL(); }
|
|
Eigen::MatrixXd cholesky4(Eigen::Ref<const Eigen::MatrixXd> &x) { return x.llt().matrixL(); }
|
|
Eigen::MatrixXd cholesky5(Eigen::Ref<Eigen::MatrixXd> x) { return x.llt().matrixL(); }
|
|
Eigen::MatrixXd cholesky6(Eigen::Ref<const Eigen::MatrixXd> x) { return x.llt().matrixL(); }
|
|
|
|
typedef Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor> MatrixXfRowMajor;
|
|
MatrixXfRowMajor double_mat_rm(const MatrixXfRowMajor& x)
|
|
{ return 2.0f * x; }
|
|
|
|
void init_eigen(py::module &m) {
|
|
typedef Eigen::Matrix<float, 5, 6, Eigen::RowMajor> FixedMatrixR;
|
|
typedef Eigen::Matrix<float, 5, 6> FixedMatrixC;
|
|
typedef Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor> DenseMatrixR;
|
|
typedef Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic> DenseMatrixC;
|
|
typedef Eigen::SparseMatrix<float, Eigen::RowMajor> SparseMatrixR;
|
|
typedef Eigen::SparseMatrix<float> SparseMatrixC;
|
|
|
|
// Non-symmetric matrix with zero elements
|
|
Eigen::MatrixXf mat(5, 6);
|
|
mat << 0, 3, 0, 0, 0, 11, 22, 0, 0, 0, 17, 11, 7, 5, 0, 1, 0, 11, 0,
|
|
0, 0, 0, 0, 11, 0, 0, 14, 0, 8, 11;
|
|
|
|
m.def("double_col", &double_col);
|
|
m.def("double_row", &double_row);
|
|
m.def("double_mat_cm", &double_mat_cm);
|
|
m.def("double_mat_rm", &double_mat_rm);
|
|
m.def("cholesky1", &cholesky1);
|
|
m.def("cholesky2", &cholesky2);
|
|
m.def("cholesky3", &cholesky3);
|
|
m.def("cholesky4", &cholesky4);
|
|
m.def("cholesky5", &cholesky5);
|
|
m.def("cholesky6", &cholesky6);
|
|
|
|
m.def("fixed_r", [mat]() -> FixedMatrixR {
|
|
return FixedMatrixR(mat);
|
|
});
|
|
|
|
m.def("fixed_c", [mat]() -> FixedMatrixC {
|
|
return FixedMatrixC(mat);
|
|
});
|
|
|
|
m.def("fixed_passthrough_r", [](const FixedMatrixR &m) -> FixedMatrixR {
|
|
return m;
|
|
});
|
|
|
|
m.def("fixed_passthrough_c", [](const FixedMatrixC &m) -> FixedMatrixC {
|
|
return m;
|
|
});
|
|
|
|
m.def("dense_r", [mat]() -> DenseMatrixR {
|
|
return DenseMatrixR(mat);
|
|
});
|
|
|
|
m.def("dense_c", [mat]() -> DenseMatrixC {
|
|
return DenseMatrixC(mat);
|
|
});
|
|
|
|
m.def("dense_passthrough_r", [](const DenseMatrixR &m) -> DenseMatrixR {
|
|
return m;
|
|
});
|
|
|
|
m.def("dense_passthrough_c", [](const DenseMatrixC &m) -> DenseMatrixC {
|
|
return m;
|
|
});
|
|
|
|
m.def("sparse_r", [mat]() -> SparseMatrixR {
|
|
return Eigen::SparseView<Eigen::MatrixXf>(mat);
|
|
});
|
|
|
|
m.def("sparse_c", [mat]() -> SparseMatrixC {
|
|
return Eigen::SparseView<Eigen::MatrixXf>(mat);
|
|
});
|
|
|
|
m.def("sparse_passthrough_r", [](const SparseMatrixR &m) -> SparseMatrixR {
|
|
return m;
|
|
});
|
|
|
|
m.def("sparse_passthrough_c", [](const SparseMatrixC &m) -> SparseMatrixC {
|
|
return m;
|
|
});
|
|
}
|