函数命名规则
- KVSIP自函数:
函数命名需遵循通用格式:[KVSIP]_<name>_<datatype>(<parameters>)
- VSIP开源信号函数:
函数命名需遵循通用格式:[vsip]_<name>_<datatype>(<parameters>)
例如:void (vsip_cvdiv_f)(const vsip_cvview_f *a, const vsip_cvview_f *b, const vsip_cvview_f *r);
在上述例子中:
- 前缀为vsip(信号库)。
- cvdiv是函数名,表明该函数实现的功能是复数向量除法运算。
- f表示该函数所有入参的数据类型为float。
- 圆括号里面为该接口传入的参数。
函数名<name>
函数名表明该函数的主要功能,格式为:<name>=[modifier]<operation>。其中:
- modifier通常由处理的数据结构类型的缩写组成。
- operation通常由一个或多个单词、首字母缩略词、缩写组成,描述该函数的基本功能。
函数数据结构类型的说明与命名规则如表1所示。
数据类型<datatype>
数据类型表明该函数处理的数据类型,通常为函数参数的数据类型。VSIP中所使用的数据类型请参见基本数据类型。
例如,vsip_cvdiv_f计算两个数据类型32位浮点型复数的源向量的除法运算,并将计算结果存储在32位浮点型复数的目标向量中。
函数参数<parameters>
<parameters>元素指定该函数的所有参数。
参数的排列顺序按如下规则:
- 源操作数,通常是标量、向量或者矩阵结构体的对象指针。
- 目标操作数。
父主题: 命名规则