跳到主要内容

外部C/C++函数支持

上述章节主要介绍了如何通过符号表达式显式地定义问题, 当优化问题不能通过符号定义时 (例如约束为神经网络或者复杂的机器人动力学模型时) , 可通过外部C/C++函数直接定义.

自定义函数​

OPTIMake通过external接口支持以下函数的C/C++定义:

  • objective
  • inequality
  • equality
  • start_equality
  • end_equality

在定义外部函数时, 需要提供该函数以及其Jacobian实现. 在某些场景中 (根据option中hessian_approximation的配置), 需要提供Hessian实现:

hessian_approximation配置外部objective是否提供Hessian外部约束是否提供Hessian
'gauss-newton'是否
'exact'是是
'bfgs'否否

在使用external接口定义objective或约束为外部函数后, 代码生成功能会自动生成该external函数的C/C++模板.

以下为objective的外部C/C++函数的模板:

void vehicle_l(
    const Vehicle_SolverInfo *_solverinfo,
    const Vehicle_Problem *_prob,
    const double _var[...],
    const double _scaling_factor[...],
    double _l[...],
    double _jac_l[...],
    double _hess[...])
{
    if (_l != NULL) {
    /* define objective here */
    }
    
    if (_jac_l != NULL) {
    /* define Jacobian here */
    }
    
    if (_hess != NULL) {
    /* define Hessian increment here */
    }
}

其中, C/C++函数入参的定义如下:

  • _solverinfo: solver info的结构体, 记录了该函数被调用的thread_id, stage以及迭代
  • _prob: 存储了该问题的参数
  • _var: 该stage的优化变量
  • _scaling_factor: objective的scaling factor, 需要在_l, _jac_l, _hess_l上乘以该factor
  • _l: objective的函数值
  • _jac_l: objective的Jacobian函数值
  • _hess: 将objective的Hessian通过增量方式加入 (_hess += _hess_l)
信息
  1. 在计算C/C++函数中的_hess时, objective或约束函数的Hessian通过增量而不是赋值计算, 即: _hess += _hess_l
  2. 优化问题中函数在求解过程中的调用顺序为: l,le,fs,fe,f,gl, l_e, f_s, f_e, f, g
  3. 矩阵通过列优先存储
  4. Hessian矩阵只存储下三角 (包含对角线)

传入自定义数据​

当一个函数是外部C/C++函数时, 该函数可以通过_prob->external_data接口传递自定义数据. 该接口的定义如下:

typedef struct Vehicle_Problem {
    ...
    void *external_data; /* user defined data */
} Vehicle_Problem;

一个通过该接口传递自定义数据的例子如下:

vehicle_demo.c
Vehicle_Problem prob;
MyData data;
data.a = 1.0;
data.b = 2.0;
prob.external_data = &data;
...

然后在外部C/C++函数中通过_prob->external_data可获取自定义数据, 例如

vehicle_userdef_prob_ext.c
void vehicle_l(
    const Vehicle_SolverInfo *_solverinfo,
    const Vehicle_Problem *_prob,
    const double _var[...],
    const double _scaling_factor[...],
    double _out[...],
    double _jac_out[...],
    double _hess[...])
{
    MyData* data = (MyData*)(_prob->external_data);
    double a = data->a;
    double b = data->b;
    ...
}