Robotics Library项目代码分析（4）从Math库开始

已于 2024-08-12 20:44:36 修改
阅读量679 收藏 11
点赞数 17
文章标签： c++
于 2024-08-02 19:33:10 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/no_to_last/article/details/140878717
版权

RL 的源码阅读

前言

距离上次更新有不少时间了，最近工作比较忙，再加上有点生病了，所有晚上回来都挺累，没有时间更新，现在生病好了，继续开始更新。

从math库开始

我们先从src下的math库开始阅读，为啥呢，通过浏览cmakelists.txt文件，然后找到不同源代码项目子目录的顺序，然后依次查找看看，我们会发现，有些源代码作为基石搭在整体项目的底层，其他的代码都通过各种方式引用他们，而他们又不依赖其他的源文件目录的文件，其实就是这些代码没有引用其他写的代码，所有我们优先看这些源代码，从底向上看。

我们先从math的结构开始浏览
math主文件，下面共有metrics、spatial和一下直接放在math更目录的代码文件，然后还有一个CMakeLists.txt文件，我们和之前一样，从CMakeLists.txt开始看起来。

CMakeLists.txt

里面主要是制定了一些list的空间范围和一些编译的信息。有一些值得我们注意的。

  1. CMake版本检查：

    if(NOT CMAKE_VERSION VERSION_LESS 3.0)
    add_library(math INTERFACE)
    add_custom_target(math_sources SOURCES ${HDRS})
else()
    add_library(math STATIC ${HDRS} dummy.cpp)
endif()
    • 如果CMake版本不低于3.0，添加一个INTERFACE类型的库 math，并创建一个自定义目标 math_sources，其源文件为 ${HDRS}。
    • 如果CMake版本低于3.0，添加一个静态库 math，其源文件为 ${HDRS} 和 dummy.cpp。
    • INTERFACE主要用于定义编译选项、包含目录和链接库等属性，这些属性会传递给依赖它的目标，它不会生成任何二进制文件，说的直接就是它可以专门用来适用头文件，因为头文件不需要变成成二进制文件，直接使用源代码依赖，然后这个特性是CMake 3.0 才有的，所以我们要进行一次判定，当然如果是新项目可以直接指定Cmake最低版本直接拉到3以上（其实看项目要求，但是我个人认为改更新还是得更新）。当然这里既可以使用静态链接库而不是动态链接库，一般项目是可以任意动态链接或者静态链接，看开发团队的选择。

  2. 指针大小检查：

    if(CMAKE_SIZEOF_VOID_P EQUAL 4)
    target_compile_definitions(math INTERFACE -DEIGEN_DONT_ALIGN_STATICALLY)
endif()
    • 如果指针大小为4字节（即32位系统），为 math 库添加编译定义 -DEIGEN_DONT_ALIGN_STATICALLY。在32位系统上，某些数据结构的内存对齐可能会导致性能问题或崩溃。-DEIGEN_DONT_ALIGN_STATICALLY 编译定义告诉Eigen库不要对静态数据进行对齐优化。在64位系统上因为其对齐要求和机制通常更为宽松，所有不用担心这个问题，这个禁用之后会导致性能下降。

  3. CMake版本检查（继续）：

    if(NOT CMAKE_VERSION VERSION_LESS 3.8)
    target_compile_features(math INTERFACE cxx_std_11)
endif()
    • 如果CMake版本不低于3.8，为 math 库设置C++11标准。

  4. 包含目录设置：

    target_include_directories(
    math
    INTERFACE
    $<BUILD_INTERFACE:${rl_SOURCE_DIR}/src>
    $<INSTALL_INTERFACE:$<INSTALL_PREFIX>/${CMAKE_INSTALL_INCLUDEDIR}/rl-${VERSION}>
    ${Boost_INCLUDE_DIR}
    ${EIGEN3_INCLUDE_DIRS}
)
    • 为 math 库设置包含目录：
      • BUILD_INTERFACE：构建时使用 ${rl_SOURCE_DIR}/src。
      • INSTALL_INTERFACE：安装时使用 ${CMAKE_INSTALL_INCLUDEDIR}/rl-${VERSION}。
      • 还包括 Boost 和 Eigen3 的包含目录。

metrics目录

metrics被包裹在namespace rl中的namespace math下面。

c++在20之前没有模块机制，在2024年的今天，模块也没有成为一个通用标准，在模块通用之前，使用头文件分离代码，然后使用不同的命名空间分离代码结构是主流的方案。这里采用了一个rl的命名空间，然后定义了一个math空间然后再定义了一个metrics空间。

我们看到这个结构体：
首先定义一个L2，然后在里面将Distance和Size分别定义成泛型T的value_type和size_type的两个别名。当然这里默认了T里面有这两个成员类型，在这里受限于当时的语法和标准，这里面我们目前是看到没有任何限制的，也就是如果在这一层的泛型T泛化成没有value_type和size_type的对象，程序会错误，而且这种错误一般隐藏的非常非常深。

template<typename T>
   struct L2
   {
    typedef typename T::value_type Distance;
    
    typedef typename T::size_type Size;
    
    typedef T Value;
    
    Distance operator()(const Value& lhs, const Value& rhs) const
    {
     using ::std::begin;
     using ::std::end;
     
     auto first1 = begin(lhs);
     auto last1 = end(lhs);
     auto first2 = begin(rhs);
     
     Distance distance = Distance();
     
     while (first1 != last1)
     {
      Distance tmp = *first1 - *first2;
      distance += tmp * tmp;
      ++first1;
      ++first2;
     }
     
     return ::std::sqrt(distance);
    }
    
    Distance operator()(const Distance& lhs, const Distance& rhs, const Size& index) const
    {
     return ::std::abs(lhs - rhs);
    }
   };

这里可以使用 static_assert 或者 SFINAE（Substitution Failure Is Not An Error）技术来进行编译时检查。

使用 static_assert 进行编译时检查

你可以在结构体内部添加 static_assert 来检查 T 是否具有所需的成员类型：

template<typename T>
struct L2
{
    static_assert(std::is_same<typename T::value_type, typename T::value_type>::value, "T must have a member type named value_type");
    static_assert(std::is_same<typename T::size_type, typename T::size_type>::value, "T must have a member type named size_type");

    typedef typename T::value_type Distance;
    typedef typename T::size_type Size;
    typedef T Value;

    Distance operator()(const Value& lhs, const Value& rhs) const
    {
        using ::std::begin;
        using ::std::end;

        auto first1 = begin(lhs);
        auto last1 = end(lhs);
        auto first2 = begin(rhs);

        Distance distance = Distance();

        while (first1 != last1)
        {
            Distance tmp = *first1 - *first2;
            distance += tmp * tmp;
            ++first1;
            ++first2;
        }

        return ::std::sqrt(distance);
    }

    Distance operator()(const Distance& lhs, const Distance& rhs, const Size& index) const
    {
        return ::std::abs(lhs - rhs);
    }
};

使用 SFINAE 进行编译时检查

也可以使用 SFINAE 来进行更灵活的检查：

template<typename T, typename = void>
struct has_value_type : std::false_type {};

template<typename T>
struct has_value_type<T, std::void_t<typename T::value_type>> : std::true_type {};

template<typename T, typename = void>
struct has_size_type : std::false_type {};

template<typename T>
struct has_size_type<T, std::void_t<typename T::size_type>> : std::true_type {};

template<typename T>
struct L2
{
    static_assert(has_value_type<T>::value, "T must have a member type named value_type");
    static_assert(has_size_type<T>::value, "T must have a member type named size_type");

    typedef typename T::value_type Distance;
    typedef typename T::size_type Size;
    typedef T Value;

    Distance operator()(const Value& lhs, const Value& rhs) const
    {
        using ::std::begin;
        using ::std::end;

        auto first1 = begin(lhs);
        auto last1 = end(lhs);
        auto first2 = begin(rhs);

        Distance distance = Distance();

        while (first1 != last1)
        {
            Distance tmp = *first1 - *first2;
            distance += tmp * tmp;
            ++first1;
            ++first2;
        }

        return ::std::sqrt(distance);
    }

    Distance operator()(const Distance& lhs, const Distance& rhs, const Size& index) const
    {
        return ::std::abs(lhs - rhs);
    }
};

让我们继续往下看：这里就是对矩阵进行了一个偏特化，传入一个行向量的矩阵，其中这里的Distance就修正为其的范数，norm()函数用于计算矩阵或向量的范数，具体就是各个元素平方和的平方根，下面是返回Distance直接距离。这里也是一样，没有对L2传入的模板参数进行强校验，也就是进行约束。我们一样可以采用上面的几种方式对其进行约束。

   template<typename Scalar, int Rows, int Options, int MaxRows, int MaxCols>
   struct L2< ::Eigen::Matrix<Scalar, Rows, 1, Options, MaxRows, MaxCols>>
   {
    typedef Scalar Distance;
    
    typedef int Size;
    
    typedef ::Eigen::Matrix<Scalar, Rows, 1, Options, MaxRows, MaxCols> Value;
    
    Distance operator()(const Value& lhs, const Value& rhs) const
    {
     return (lhs - rhs).norm();
    }
    
    Distance operator()(const Distance& lhs, const Distance& rhs, const Size& index) const
    {
     return ::std::abs(lhs - rhs);
    }
   };

这一段和上面没有什么区别，重点在与多了一个*：

   template<typename Scalar, int Rows, int Options, int MaxRows, int MaxCols>
   struct L2< ::Eigen::Matrix<Scalar, Rows, 1, Options, MaxRows, MaxCols>*>
   {
    typedef Scalar Distance;
    
    typedef int Size;
    
    typedef ::Eigen::Matrix<Scalar, Rows, 1, Options, MaxRows, MaxCols>* Value;
    
    Distance operator()(const Value& lhs, const Value& rhs) const
    {
     return (*lhs - *rhs).norm();
    }
    
    Distance operator()(const Distance& lhs, const Distance& rhs, const Size& index) const
    {
     return ::std::abs(lhs - rhs);
    }
   };

在L2Squared中也是一样的，区别在于将L2中的返回值都返回其值平方，我个人是感觉这两个头文件可以合并起来。

no_to_last
关注
  • 17
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
机器人C++库（10）Robotics Library 之碰撞检测算法
yohnyang的博客
10-10 1757
机器人C++库（10）Robotics Library 之碰撞检测算法
RRT算法
热门推荐
reason的博客
07-17 1万+
简介 RRT 算法（快速扩展随机树，rapidly exploring random tree）是一种随机性算法，它可以直接应用于非完整约束系统的规划，不需进行路径转换，所以它的算法复杂度较小，尤为适用于高维多自由度的系统。 缺点是得到的路径质量不是很好。 其思想是快速扩张一群像树一样的路径以探索（填充）空间的大部分区域，伺机找到可行的路径。 RRT 的基本步骤是： 　　1. 起点作为一颗种子，从它开始生长枝丫； 　　2. 在机器人的“构型”空间中，生成一个随机点X； 　　3. 在树上找到距离X最近的那
探索未来机器人技术的利器：Robotics Library
gitblog_00071的博客
05-17 343
探索未来机器人技术的利器：Robotics Library rlThe Robotics Library (RL) is a self-contained C++ library for rigid body kinematics and dynamics, motion planning, and control.项目地址:https://gitcode.com/gh_mirrors/rl1/...
探索机器人世界的宝藏 —— Robotics Library 开源项目推荐
gitblog_00978的博客
08-23 378
探索机器人世界的宝藏 —— Robotics Library 开源项目推荐 rlThe Robotics Library (RL) is a self-contained C++ library for rigid body kinematics and dynamics, motion planning, and control.项目地址:https://gitcode.com/gh_mirr...
使用RLmdl库进行机器人运动学求解
qq_41519446的博客
04-19 1149
引言 机器人库Robotics Library 是一个独立的C++库，用于机器人运动学，运动规划和控制。它涵盖了数学，运动学和动力学，硬件抽象，运动规划，碰撞检测和可视化。 RLmdl是机器人库中的一个功能组件。 RLmdl提供基于空间矢量代数并支持分支的运动学和动力学计算。支持各种关节类型（例如，旋转，棱柱形，圆柱，螺旋形）和算法（例如，正向运动学，通过递归牛顿-欧拉的逆动力学以及通过铰接体的正向动力学）。 例子 下面是使用RLmdl的一个例子，简要说明了rlmdl库中用于机器人运动学的关键函数。
Robotics Library 学习使用记录
ermzdy2的博客
01-15 3465
最近用Robotics Library 做机械臂的模拟和路径规划，刚开始弄，一边研究一遍记录。 官网下载已编译好的库文件进行安装https://www.roboticslibrary.org/download 安装很简单没什么问题。 准备开始使用，这里有向导 https://www.roboticslibrary.org/tutorials/ 单独的按向导的代码，cmake构建工程 https:/...
Robotics Library项目代码分析（6）从Math库开始
no_to_last的博客
08-26 733
之前我们看了math库下的metrics文件夹，现在让我们开始逐步看math下的其他文件，我们先从Real.h头文件开始看，因为这个文件被很多文件引用，所以我们先从这个开始看。
Robotics Library项目代码分析（5）math库下的spatial
no_to_last的博客
08-20 861
我们看了一下math库下的子文件夹metrics，里面主要包含了l2，l2 squared函数，现在我们继续分析spatial文件夹下的内容。spatial有空间的意思，现在让我们开始分析。
Robotics Library项目代码分析（2）根目录的CMakefile
no_to_last的博客
07-21 920
rl分析初步的cmakefile
机器人C++库（2）Robotics Library 配置VS2019 及 API概述
yohnyang的博客
08-24 1112
Robotics Library接口概述
机器人C++库（5）Robotics Library 例程二之求解雅可比矩阵
yohnyang的博客
08-25 701
roboticslibrary例程雅可比矩阵求解
【Robotics Library】rlPlanDemo
Zoey的博客
07-03 168
include “” : 默认从项目当前目录查找头文件，所谓项目当前目录，就是项目工程文件(*.vcxproj) 所在的目录委托是Qt中的一种机制，委托提供了一种方便的方法来定制特定类型的数据的显示和编辑。委托可以用来定制Qt中各种视图组件中特定类型的数据的显示和编辑，使得开发人员能够更好地控制数据的外观和行为。使用委托可以使代码更具可重用性和灵活性。Qt中的委托资料参考创建委托控件。可编辑输入设置控件数据QDoubleSpinBox：浮点计数器控件，接收输入的浮点数值。
【ChatGPT核心原理实战】手动求解 Transformer：分步数学示例 | Solving Transformer by Hand: A Step-by-Step Math Example
禅与计算机程序设计艺术
12-22 2934
手动求解 Transformer：分步数学示例Understanding Transformers: A Step-by-Step Math Example — Part 1了解 Transformer：分步数学示例 — 第 1 部分I understand that the transformer architecture may seem scary, and you might have encountered various explanations on…我知道变压器架构可能看起来很可怕，并且
【C++】深入理解C++模板：从基础到进阶
2403_86785171的博客
09-01 370
模板是C++中用于泛型编程的工具。它允许你编写可以处理任意类型的函数和类，而不必重复编写相似的代码。函数模板和类模板。
【C++ Primer Plus习题】8.6
最新发布
qq_74047911的博客
09-01 105
【C++ Primer Plus习题】8.6
C语言破墙镐对称飞迷宫
qq_69383179的博客
08-22 4381
这里有我用C语言编译的破墙镐对称飞迷宫和与之相关的一些东西
【C++】智能指针——auto_ptr，unique_ptr，shared_ptr
2301_79796701的博客
09-01 872
1.智能指针对象中引用计数是多个智能指针对象共享的，两个线程中智能指针的引用计数同时 ++或--，这个操作不是原子的，引用计数原来是1，++了两次，可能还是2.这样引用计数就错 乱了。旧的智能指针的会转移给新的智能指针，而旧的智能指针的会被置空。解决方案：在引用计数的场景下，把节点中的_prev和_next改成weak_ptr就可以了，weak_ptr不会增加引用计数，代码示意。该问题是有类似于链表节点的结构引起的，当外部的智能指针都释放了，就拿不内部的智能指针，那么节点就不会释放。使用方法参考官方文档。
c++11新特性-智能指针
SuperYang_的博客
09-01 882
智能指针RAII(Resource Acquisition Is Initialization)，是一种利用对象的生命周期来管理资源的技术。如果我们采用传统的new/delete来申请和释放资源，如果忘记调用delete，或者在调用delete之前程序抛出异常，都会导致内存泄漏问题，如代码1.1，Func函数中的new p2和Div都可能抛异常，导致后面的delete没有执行从而引发内存泄漏，采用智能指针对资源进行管理，能够杜绝这类问题。代码1.1：因异常引发的内存泄漏throw "除0错误";
robotics library
02-22
Robotics Library（简称RL）是一个开源的机器软件库，旨在提供一套通用的工具和算法，用于机器人的建模、控制和仿真。它是用C++编写的，并提供了Python接口，可以在各种操作系统上运行。 Robotics Library提供了丰富的功能和模块，包括运动学、动力学、传感器模拟、路径规划、运动控制、碰撞检测等。它支持多种类型的机器人，包括移动机器人、机械臂、无人机等，并提供了各种算法和工具，帮助用户快速开发机器人应用。 RL的主要特点包括： 1. 灵活性：RL提供了模块化的设计，用户可以根据自己的需求选择使用其中的功能模块，也可以根据需要扩展和定制功能。 2. 高性能：RL使用了高效的算法和数据结构，以提供快速的计算和仿真能力。 3. 易用性：RL提供了简洁的API和文档，使用户能够快速上手并进行开发。 4. 开放源代码：RL是一个开源项目，用户可以自由地使用、修改和分发它。 总之，Robotics Library是一个功能强大、灵活易用的机器人软件库，可以帮助开发者快速构建机器人应用。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值