types_math.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          http://www.mrpt.org/                          |
   |                                                                        |
   | Copyright (c) 2005-2018, Individual contributors, see AUTHORS file     |
   | See: http://www.mrpt.org/Authors - All rights reserved.                |
   | Released under BSD License. See details in http://www.mrpt.org/License |
   +------------------------------------------------------------------------+ */

#pragma once

#include <vector>  // For <Eigen/StdVector>
#include <deque>  // For <Eigen/StdDeque>

// needed here for a few basic types used in Eigen MRPT's plugin:
#include <mrpt/math/math_frwds.h>
#include <mrpt/serialization/serialization_frwds.h>
// --------------------------------------------------
// Include the Eigen3 library headers, including
//  MRPT's extensions:
// --------------------------------------------------
#include <fstream>  // These headers are assumed by <mrpt/math/eigen_plugins.h>:
#include <ctime>
#include <stdexcept>
#ifdef EIGEN_MATRIXBASE_H
#   error **FATAL ERROR**: MRPT headers must be included before <Eigen/Dense> headers.
#endif
#ifndef EIGEN_USE_NEW_STDVECTOR
#define EIGEN_USE_NEW_STDVECTOR
#endif
#include <Eigen/Dense>
#include <Eigen/StdVector>
#include <Eigen/StdDeque>

#if !EIGEN_VERSION_AT_LEAST(2, 90, 0)
#error MRPT needs version 3.0.0-beta of Eigen or newer
#endif

// Template implementations that need to be after all Eigen includes:
#include EIGEN_MATRIXBASE_PLUGIN_POST_IMPL
// --------------------------------------------------
//  End of Eigen includes
// --------------------------------------------------

// This must be put inside any MRPT class that inherits from an Eigen class:
#define MRPT_EIGEN_DERIVED_CLASS_CTOR_OPERATOR_EQUAL(_CLASS_)    \
    /*! Assignment operator from any other Eigen class */        \
    template <typename OtherDerived>                             \
    inline mrpt_autotype& operator=(                             \
        const Eigen::MatrixBase<OtherDerived>& other)            \
    {                                                            \
        Base::operator=(other);                                  \
        return *this;                                            \
    }                                                            \
    /*! Constructor from any other Eigen class */                \
    template <typename OtherDerived>                             \
    inline _CLASS_(const Eigen::MatrixBase<OtherDerived>& other) \
        : Base(other.template cast<typename Base::Scalar>())     \
    {                                                            \
    }

namespace mrpt::math
{
/** Column vector, like Eigen::MatrixX*, but automatically initialized to zeros
 * since construction */
template <typename T>
class dynamic_vector : public Eigen::Matrix<T, Eigen::Dynamic, 1>
{
   public:
    using Base = Eigen::Matrix<T, Eigen::Dynamic, 1>;
    using mrpt_autotype = dynamic_vector<T>;
    using value_type = T;
    MRPT_EIGEN_DERIVED_CLASS_CTOR_OPERATOR_EQUAL(dynamic_vector)

    /** Default constructor (vector of given size set to zero) */
    inline dynamic_vector(size_t length = 0) { Base::setZero(length); }
    /** Constructor to given size and all entries to some value */
    inline dynamic_vector(size_t length, float value)
    {
        Base::resize(length);
        Base::setConstant(value);
    }
};

/** Column vector, like Eigen::MatrixXf, but automatically initialized to zeros
 * since construction */
using CVectorFloat = dynamic_vector<float>;
/** Column vector, like Eigen::MatrixXd, but automatically initialized to zeros
 * since construction */
using CVectorDouble = dynamic_vector<double>;

mrpt::serialization::CArchive& operator<<(
    mrpt::serialization::CArchive& s, const mrpt::math::CVectorFloat& a);
mrpt::serialization::CArchive& operator<<(
    mrpt::serialization::CArchive& s, const mrpt::math::CVectorDouble& a);
mrpt::serialization::CArchive& operator>>(
    mrpt::serialization::CArchive& in, mrpt::math::CVectorDouble& a);
mrpt::serialization::CArchive& operator>>(
    mrpt::serialization::CArchive& in, mrpt::math::CVectorFloat& a);
}