eigen.hpp

Go to the documentation of this file.

#pragma once
 
#ifndef COPP_CPP_WITH_EIGEN
#define COPP_CPP_WITH_EIGEN 1
#endif
 
#if !COPP_CPP_WITH_EIGEN
#error "copp/eigen.hpp requires COPP_CPP_WITH_EIGEN=1"
#endif
 
#include <Eigen/Core>
 
#include "copp/core.hpp"
 
namespace copp::eigen
{

    using ColMajorMatrix = Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic, Eigen::ColMajor>;
    using RowMajorMatrix = Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>;
    using Vector = Eigen::Matrix<double, Eigen::Dynamic, 1>;

    inline MatrixView matrix_view(const Eigen::Ref<const ColMajorMatrix> &matrix)
    {
        if (matrix.innerStride() != 1)
        {
            throw Error(Status::invalid_input, "Eigen column-major MatrixView requires innerStride == 1");
        }
        return MatrixView::strided_column_major(
            matrix.data(),
            static_cast<std::size_t>(matrix.rows()),
            static_cast<std::size_t>(matrix.cols()),
            static_cast<std::size_t>(matrix.outerStride()));
    }

    inline MatrixView matrix_view(const Eigen::Ref<const RowMajorMatrix> &matrix)
    {
        if (matrix.innerStride() != 1)
        {
            throw Error(Status::invalid_input, "Eigen row-major MatrixView requires innerStride == 1");
        }
        return MatrixView(
            matrix.data(),
            static_cast<std::size_t>(matrix.rows()),
            static_cast<std::size_t>(matrix.cols()),
            MatrixLayout::RowMajor,
            static_cast<std::size_t>(matrix.outerStride()));
    }

    inline Span<const double> span(const Eigen::Ref<const Vector> &vector)
    {
        if (vector.innerStride() != 1)
        {
            throw Error(Status::invalid_input, "Eigen vector Span requires innerStride == 1");
        }
        return Span<const double>(vector.data(), static_cast<std::size_t>(vector.size()));
    }

    inline Eigen::Map<ColMajorMatrix> map(Matrix &matrix)
    {
        return Eigen::Map<ColMajorMatrix>(
            matrix.data(),
            static_cast<Eigen::Index>(matrix.rows()),
            static_cast<Eigen::Index>(matrix.cols()));
    }

    inline Eigen::Map<const ColMajorMatrix> map(const Matrix &matrix)
    {
        return Eigen::Map<const ColMajorMatrix>(
            matrix.data(),
            static_cast<Eigen::Index>(matrix.rows()),
            static_cast<Eigen::Index>(matrix.cols()));
    }

    inline ColMajorMatrix copy(const Matrix &matrix)
    {
        return map(matrix);
    }
 
} // namespace copp::eigen