函数

ACLScript 函数是 Analytics 中的一个计算机化的例程,它具有较窄的作用域,执行特定任务或计算并返回一个值。

例如,ALLTRIM( ) 函数从域中的文本值中移除任何前导或后继空格。

函数列表

下面显示了 Analytics 中的可用函数的完整列表,它们是按字母顺序或者按类别组织的。

另外,还提供了在函数语法和函数文档中使用的规范,以及一些一般性用法详情。

按字母顺序排列的函数

函数 描述

ABS( )

返回数值表达式的绝对值。一个数值的绝对值是忽略其数字符号的数值。

AGE( )

返回某一指定日期与指定终止日期或当前操作系统日期相比较的帐龄(以天为单位)。

ALLTRIM( )

返回从输入字符串中删除前导和结尾空格后得到的字符串。

ASCII( )

返回指定字符的 ASCII 码。

AT( )

返回一个数字,该数字指定某个子串在字符值内的哪个位置开始出现。

BETWEEN( )

返回可表明指定值是否在某范围内的逻辑值。

BINTOSTR( )

返回由 ZONED 或 EBCDIC 字符数据转换成的 Unicode 字符数据。英文“Binary to String”的缩写。

BIT( )

以包含八个字符的字符串的形式返回当前记录中指定字节位置的二进制表示。

BLANKS( )

返回包含指定数量空格的字符串。

BYTE( )

返回存储于当前记录中指定字节位置的字符。

CDOW( )

返回指定日期或日期时间是星期几。英文“Character Day of Week”的缩写。

CHR( )

返回与指定的 ASCII 码相关联的字符。

CLEAN( )

将字符串中的首个无效字符及所有后续字符替换为空白。

CMOY( )

返回指定日期或日期时间的月份名称。英文“Character Month of Year”的缩写。

COS( )

返回以弧度表示的角度的余弦值,精确到 15 位小数。

CTOD( )

将字符或数值日期值转换为日期。还可以从字符或数值日期时间值中提取日期并将其作为日期返回。英文“Character to Date”的缩写。

CTODT( )

将字符或数值日期时间值转换为日期时间。英文“Character to Datetime”的缩写。

CTOT( )

将字符或数值时间值转换为时间。还可以从字符或数值日期时间值中提取时间并将其作为时间返回。英文“Character to Time”的缩写。

CUMIPMT( )

返回在一系列期间中为贷款支付的累计利息。

CUMPRINC( )

返回在一系列期间中为贷款支付的累计本金。

DATE( )

从指定的日期或日期时间中提取日期并将其以字符串形式返回。还可以返回当前操作系统日期。

DATETIME( )

将日期时间转换为字符串。还可以返回当前操作系统日期时间。

DAY( )

从指定的日期或日期时间中提取日期并将其以数值形式返回(1 到 31)。

DBYTE( )

返回记录中指定字节位置的 Unicode 字符。

DEC( )

返回具有指定小数位数的值或数值表达式的结果。

DHEX( )

将 Unicode 字符串转换为十六进制字符串。

DICECOEFFICIENT( )

返回两个指定字符串的 Dice 系数,它用来衡量两个字符串的相似度。

DIGIT( )

返回指定压缩数据类型字节的上半部分数字或下半部分数字。

DOW( )

对指定的日期或日期时间,返回一个代表星期几的数值(1 到 7)。英文“Day of Week”的缩写。

DTOU( )

将 Analytics 日期值转换为指定语言和区域设置格式的 Unicode 字符串。英文“Date to Unicode”的缩写。

EBCDIC( )

返回已转换为 EBCDIC 字符编码的字符串。

EFFECTIVE( )

返回贷款的有效年利率。

EOMONTH( )

返回比指定日期早或晚指定月数的月份的最后一天的日期。

EXCLUDE( )

返回一个排除指定字符的字符串。

EXP( )

以指定小数位数返回数值表达式的指数值(以 10 为底)。

FILESIZE( )

以字节为单位返回指定文件的大小,或者如果该文件不存在,则返回 -1。

FIND( )

返回一个逻辑值,表明是否在特定域中或在整个记录的任何位置找到了指定的字符串。

FINDMULTI( )

返回一个逻辑值,表明是否在特定域中或在整个记录的任何位置存在一个或多个指定字符串中的任一字符串。

FREQUENCY( )

以 8 位小数的精确度返回顺序前导正数的期望 Benford 频率。

FTYPE( )

返回可识别域或变量,或 Analytics 项目条目类型的数据类型的字符。

FVANNUITY( )

返回一系列付款的终值(使用固定利率计算)。终值等于付款之和加上累计复利。

FVLUMPSUM( )

返回当前总价值的终值(使用固定利率计算)。

FVSCHEDULE( )

返回当前总价值的终值(使用一系列利率计算)。

GETOPTIONS( )

返回指定 Analytics 选项的当前设置(选项对话框设置)。

GOMONTH( )

返回比指定日期早或晚指定月数的日期。

HASH( )

根据输入值返回一个加盐加密哈希值。

HEX( )

将 ASCII 字符串转换为十六进制字符串。

HOUR( )

从指定的时间或日期时间中提取小时并将其以使用 24 小时时钟的数值形式返回。

HTOU( )

将十六进制字符串转换为 Unicode 字符串。英文“Hexadecimal to Unicode”的缩写。

INCLUDE( )

返回一个仅包括指定字符的字符串。

INSERT( )

返回在将指定文本插入到特定字节位置后的原始字符串。

INT( )

返回数值表达式或域值的整数值。

IPMT( )

返回在单个期间内为贷款支付的利息。

ISBLANK( )

返回表明输入值是否是空白的逻辑值。

ISDEFINED( )

如果指定的域或者变量已定义,则返回 T(真),否则返回 F(假)。

ISFUZZYDUP( )

返回逻辑值,该逻辑值表明某字符串是否是与之相比较的字符串的模糊重复。

LAST( )

返回自字符串结尾起指定数量的字符。

LEADING( )

返回包含指定数目前导数字的字符串。

LENGTH( )

返回某个字符串中的字符数。

LEVDIST( )

返回两个指定字符串之间的编辑距离,该编辑距离用来衡量两个字符串的差异程度。

LOG( )

以指定小数位数返回数值表达式或域值的对数(以 10 为底)。

LOWER( )

返回把字母字符转换为小写的字符串。

LTRIM( )

返回已从输入字符串中删除前导空格的字符串。

MAP( )

返回一个逻辑值,指示一个字符串是否与包含通配符、字面量字符或两者的指定格式字符串匹配。

MASK( )

对两个字符串的第一个字节执行按位 AND 操作。

MATCH( )

返回一个逻辑值,表明指定的值是否和与其相比较的任一值相匹配。

MAXIMUM( )

返回一组数值类型值中的最大值,或一组日期时间类型值中的最新值。

MINIMUM( )

返回一组数值类型值中的最小值,或一组日期时间类型值中的最旧值。

MINUTE( )

从指定的时间或日期时间中提取分钟并将其以数值形式返回。

MOD( )

返回两数相除的余数。

MONTH( )

从指定的日期或日期时间中提取月份并将其以数值形式(1 到 12)返回。

NOMINAL( )

返回贷款的名义年利率。

NORMDIST( )

返回正态分布数据集中的一个随机变量小于或等于指定值或恰好等于指定值的概率。

NORMSINV( )

返回与标准正态分布中的指定概率相关联的 z 得分。z 得分是一个值与标准正态分布的平均之间的标准偏差数。

NOW( )

将当前操作系统时间作为日期时间数据类型返回。

NPER( )

返回付清贷款所需的期数。

OCCURS( )

返回指定字符值中子串出现次数的计数。

OFFSET( )

返回其起始位置偏移指定数目的字节的域的值。

OMIT( )

返回一个或多个指定子串被删除的字符串。

PACKED( )

返回转换为压缩数据类型的数值数据。

PI( )

返回 pi 的值并保留 15 位小数。

PMT( )

返回清偿贷款所需的定期付款金额(本金 + 利息)。

PPMT( )

返回在单个期间内为贷款支付的本金。

PROPER( )

返回一个字符串,该字符串的每个单词的第一个字符都被设置为大写,其他字符则设置为小写。

PROPERTIES( )

返回指定 Analytics 项目条目的属性信息。

PVANNUITY( )

返回一系列将来付款的现值(使用固定利率计算)。现值是当前总价值。

PVLUMPSUM( )

返回生成特定将来一次付清总额所需的现值(使用固定利率计算)。现值是当前总价值。

PYDATE( )

返回由外部 Python 脚本中的函数计算的日期值。Python 中的数据处理存在于 Analytics 的外部。

PYDATETIME( )

返回由外部 Python 脚本中的函数计算的日期时间值。Python 中的数据处理存在于 Analytics 的外部。

PYLOGICAL( )

返回由外部 Python 脚本中的函数计算的逻辑值。Python 中的数据处理存在于 Analytics 的外部。

PYNUMERIC( )

返回由外部 Python 脚本中的函数计算的数值类型值。Python 中的数据处理存在于 Analytics 的外部。

PYSTRING( )

返回由外部 Python 脚本中的函数计算的字符值。Python 中的数据处理存在于 Analytics 的外部。

PYTIME( )

返回由外部 Python 脚本中的函数计算的时间值。Python 中的数据处理存在于 Analytics 的外部。

RAND( )

返回落入指定边界内的随机数。

RATE( )

返回每期的利率。

RDATE( )

返回由 R 函数或脚本计算的日期值。R 中的数据处理存在于 Analytics 的外部。

RDATETIME( )

返回由 R 函数或脚本计算的日期时间值。R 中的数据处理存在于 Analytics 的外部。

RECLEN( )

返回当前记录的长度。

RECNO( )

返回当前记录数。

RECOFFSET( )

返回自当前记录起第指定数目个记录的一个域值。

REGEXFIND( )

返回一个逻辑值,指示正则表达式所指定的模式是否出现在字符串中。

REGEXREPLACE( )

将与正则表达式匹配的字符串的所有实例替换为新的字符串。

REMOVE( )

返回一个仅包括指定字符的字符串。

REPEAT( )

返回以指定次数重复子串的字符串。

REPLACE( )

用新的字符串替换指定字符串的所有实例。

REVERSE( )

返回字符以倒序排列的字符串。

RJUSTIFY( )

返回经过向右调整而与指定字符串长度相等的字符串,其中所有结尾空格都移动到字符串左侧。

RLOGICAL( )

返回由 R 函数或脚本计算的逻辑值。R 中的数据处理存在于 Analytics 的外部。

RNUMERIC( )

返回由 R 函数或脚本计算的数值。R 中的数据处理存在于 Analytics 的外部。

ROOT( )

返回数值表达式的平方根。

ROUND( )

返回某数值经四舍五入后的整数。

RSTRING( )

返回由 R 函数或脚本计算的字符串值。R 中的数据处理存在于 Analytics 的外部。

RTIME( )

返回由 R 函数或脚本计算的时间值。R 中的数据处理存在于 Analytics 的外部。

SECOND( )

从指定的时间或日期时间中提取秒数并将其以数值形式返回。

SHIFT( )

返回单个字符串,其中输入值的第一个字符的位移动到左侧或右侧。

SIN( )

返回以弧度表示的角度的正弦值,精确到 15 位小数。

SOUNDEX( )

返回指定字符串的 soundex 码,该码可用来与其他字符串进行语音比较。

SOUNDSLIKE( )

返回逻辑值,表明某字符串是否与和它相比较的字符串在语言方面相匹配。

SPLIT( )

从字符串中返回一个指定的段。

STOD( )

将序列日期,即以整数形式表示的日期转换为日期值。英文“Serial to Date”的缩写。

STODT( )

将序列日期时间,即以整数形式表示的日期时间和 24 小时的小数部分转换为日期时间值。英文“Serial to Datetime”的缩写。

STOT( )

将序列时间,即以 24 小时的小数部分形式表示的时间(其中,24 小时等于 1)转换为时间值。英文“Serial to Time”的缩写。

STRING( )

将数值转换为字符串。

SUBSTR( )

从字符串中返回一个指定的子串。

TAN( )

返回以弧度表示的角度的正切值,精确到 15 位小数。

TEST( )

返回逻辑值,表明在记录的指定字节位置是否存在指定字符串。

TIME( )

从指定的时间或日期时间中提取时间并将其以字符串形式返回。还可以返回当前操作系统时间。

TODAY( )

将当前操作系统日期作为日期时间数据类型返回。

TRANSFORM( )

倒转指定字符串内双向文本的显示顺序。

TRIM( )

返回在从输入字符串中删除结尾空格后得到的字符串。

UNSIGNED( )

返回转换为无符号数据类型的数值数据。

UPPER( )

返回把字母字符转换为大写的字符串。

UTOD( )

将包含一个格式化日期的 Unicode 字符串转换为一个 Analytics 日期值。英文“Unicode to Date”的缩写。

VALUE( )

将字符串转换为数值。

VERIFY( )

返回逻辑值,表明物理数据域中的数据是否有效。

WORKDAY( )

返回两个日期之间的工作日数量。

YEAR( )

从指定的日期或日期时间中提取年份并使用 YYYY 格式将其以数值形式返回。

ZONED( )

将数值数据转换为字符数据并将前导零添加至输出。

ZSTAT( )

返回标准 Z 统计。

搜索、替换

函数 描述

AT( )

返回一个数字,该数字指定某个子串在字符值内的哪个位置开始出现。

BETWEEN( )

返回可表明指定值是否在某范围内的逻辑值。

CLEAN( )

将字符串中的首个无效字符及所有后续字符替换为空白。

FIND( )

返回一个逻辑值,表明是否在特定域中或在整个记录的任何位置找到了指定的字符串。

FINDMULTI( )

返回一个逻辑值,表明是否在特定域中或在整个记录的任何位置存在一个或多个指定字符串中的任一字符串。

ISBLANK( )

返回表明输入值是否是空白的逻辑值。

MAP( )

返回一个逻辑值,指示一个字符串是否与包含通配符、字面量字符或两者的指定格式字符串匹配。

MATCH( )

返回一个逻辑值,表明指定的值是否和与其相比较的任一值相匹配。

OCCURS( )

返回指定字符值中子串出现次数的计数。

REGEXFIND( )

返回一个逻辑值,指示正则表达式所指定的模式是否出现在字符串中。

REGEXREPLACE( )

将与正则表达式匹配的字符串的所有实例替换为新的字符串。

REPLACE( )

用新的字符串替换指定字符串的所有实例。

TEST( )

返回逻辑值,表明在记录的指定字节位置是否存在指定字符串。

比较

函数 描述

DICECOEFFICIENT( )

返回两个指定字符串的 Dice 系数,它用来衡量两个字符串的相似度。

ISFUZZYDUP( )

返回逻辑值,该逻辑值表明某字符串是否是与之相比较的字符串的模糊重复。

LEVDIST( )

返回两个指定字符串之间的编辑距离,该编辑距离用来衡量两个字符串的差异程度。

SOUNDEX( )

返回指定字符串的 soundex 码,该码可用来与其他字符串进行语音比较。

SOUNDSLIKE( )

返回逻辑值,表明某字符串是否与和它相比较的字符串在语言方面相匹配。

转换

函数 描述

BINTOSTR( )

返回由 ZONED 或 EBCDIC 字符数据转换成的 Unicode 字符数据。英文“Binary to String”的缩写。

CTOD( )

将字符或数值日期值转换为日期。还可以从字符或数值日期时间值中提取日期并将其作为日期返回。英文“Character to Date”的缩写。

CTODT( )

将字符或数值日期时间值转换为日期时间。英文“Character to Datetime”的缩写。

CTOT( )

将字符或数值时间值转换为时间。还可以从字符或数值日期时间值中提取时间并将其作为时间返回。英文“Character to Time”的缩写。

DATE( )

从指定的日期或日期时间中提取日期并将其以字符串形式返回。还可以返回当前操作系统日期。

DATETIME( )

将日期时间转换为字符串。还可以返回当前操作系统日期时间。

DTOU( )

将 Analytics 日期值转换为指定语言和区域设置格式的 Unicode 字符串。英文“Date to Unicode”的缩写。

EBCDIC( )

返回已转换为 EBCDIC 字符编码的字符串。

HASH( )

根据输入值返回一个加盐加密哈希值。

PACKED( )

返回转换为压缩数据类型的数值数据。

STOD( )

将序列日期,即以整数形式表示的日期转换为日期值。英文“Serial to Date”的缩写。

STODT( )

将序列日期时间,即以整数形式表示的日期时间和 24 小时的小数部分转换为日期时间值。英文“Serial to Datetime”的缩写。

STOT( )

将序列时间,即以 24 小时的小数部分形式表示的时间(其中,24 小时等于 1)转换为时间值。英文“Serial to Time”的缩写。

STRING( )

将数值转换为字符串。

TIME( )

从指定的时间或日期时间中提取时间并将其以字符串形式返回。还可以返回当前操作系统时间。

UNSIGNED( )

返回转换为无符号数据类型的数值数据。

UTOD( )

将包含一个格式化日期的 Unicode 字符串转换为一个 Analytics 日期值。英文“Unicode to Date”的缩写。

VALUE( )

将字符串转换为数值。

ZONED( )

将数值数据转换为字符数据并将前导零添加至输出。

文本

函数 描述

ALLTRIM( )

返回从输入字符串中删除前导和结尾空格后得到的字符串。

BINTOSTR( )

返回由 ZONED 或 EBCDIC 字符数据转换成的 Unicode 字符数据。英文“Binary to String”的缩写。

BLANKS( )

返回包含指定数量空格的字符串。

DATETIME( )

将日期时间转换为字符串。还可以返回当前操作系统日期时间。

DTOU( )

将 Analytics 日期值转换为指定语言和区域设置格式的 Unicode 字符串。英文“Date to Unicode”的缩写。

EBCDIC( )

返回已转换为 EBCDIC 字符编码的字符串。

EXCLUDE( )

返回一个排除指定字符的字符串。

INCLUDE( )

返回一个仅包括指定字符的字符串。

INSERT( )

返回在将指定文本插入到特定字节位置后的原始字符串。

LAST( )

返回自字符串结尾起指定数量的字符。

LENGTH( )

返回某个字符串中的字符数。

LOWER( )

返回把字母字符转换为小写的字符串。

LTRIM( )

返回已从输入字符串中删除前导空格的字符串。

OMIT( )

返回一个或多个指定子串被删除的字符串。

PROPER( )

返回一个字符串,该字符串的每个单词的第一个字符都被设置为大写,其他字符则设置为小写。

REMOVE( )

返回一个仅包括指定字符的字符串。

REPEAT( )

返回以指定次数重复子串的字符串。

REVERSE( )

返回字符以倒序排列的字符串。

RJUSTIFY( )

返回经过向右调整而与指定字符串长度相等的字符串,其中所有结尾空格都移动到字符串左侧。

SPLIT( )

从字符串中返回一个指定的段。

STRING( )

将数值转换为字符串。

SUBSTR( )

从字符串中返回一个指定的子串。

TRANSFORM( )

倒转指定字符串内双向文本的显示顺序。

TRIM( )

返回在从输入字符串中删除结尾空格后得到的字符串。

UPPER( )

返回把字母字符转换为大写的字符串。

ZONED( )

将数值数据转换为字符数据并将前导零添加至输出。

数学

函数 描述

ABS( )

返回数值表达式的绝对值。一个数值的绝对值是忽略其数字符号的数值。

COS( )

返回以弧度表示的角度的余弦值,精确到 15 位小数。

DEC( )

返回具有指定小数位数的值或数值表达式的结果。

EXP( )

以指定小数位数返回数值表达式的指数值(以 10 为底)。

FREQUENCY( )

以 8 位小数的精确度返回顺序前导正数的期望 Benford 频率。

INT( )

返回数值表达式或域值的整数值。

LEADING( )

返回包含指定数目前导数字的字符串。

LOG( )

以指定小数位数返回数值表达式或域值的对数(以 10 为底)。

MAXIMUM( )

返回一组数值类型值中的最大值,或一组日期时间类型值中的最新值。

MINIMUM( )

返回一组数值类型值中的最小值,或一组日期时间类型值中的最旧值。

MOD( )

返回两数相除的余数。

NORMDIST( )

返回正态分布数据集中的一个随机变量小于或等于指定值或恰好等于指定值的概率。

NORMSINV( )

返回与标准正态分布中的指定概率相关联的 z 得分。z 得分是一个值与标准正态分布的平均之间的标准偏差数。

PI( )

返回 pi 的值并保留 15 位小数。

RAND( )

返回落入指定边界内的随机数。

ROOT( )

返回数值表达式的平方根。

ROUND( )

返回某数值经四舍五入后的整数。

SIN( )

返回以弧度表示的角度的正弦值,精确到 15 位小数。

TAN( )

返回以弧度表示的角度的正切值,精确到 15 位小数。

VALUE( )

将字符串转换为数值。

ZONED( )

将数值数据转换为字符数据并将前导零添加至输出。

ZSTAT( )

返回标准 Z 统计。

日期和时间

函数 描述

AGE( )

返回某一指定日期与指定终止日期或当前操作系统日期相比较的帐龄(以天为单位)。

CDOW( )

返回指定日期或日期时间是星期几。英文“Character Day of Week”的缩写。

CMOY( )

返回指定日期或日期时间的月份名称。英文“Character Month of Year”的缩写。

CTOD( )

将字符或数值日期值转换为日期。还可以从字符或数值日期时间值中提取日期并将其作为日期返回。英文“Character to Date”的缩写。

CTODT( )

将字符或数值日期时间值转换为日期时间。英文“Character to Datetime”的缩写。

CTOT( )

将字符或数值时间值转换为时间。还可以从字符或数值日期时间值中提取时间并将其作为时间返回。英文“Character to Time”的缩写。

DATE( )

从指定的日期或日期时间中提取日期并将其以字符串形式返回。还可以返回当前操作系统日期。

DATETIME( )

将日期时间转换为字符串。还可以返回当前操作系统日期时间。

DAY( )

从指定的日期或日期时间中提取日期并将其以数值形式返回(1 到 31)。

DOW( )

对指定的日期或日期时间,返回一个代表星期几的数值(1 到 7)。英文“Day of Week”的缩写。

EOMONTH( )

返回比指定日期早或晚指定月数的月份的最后一天的日期。

GOMONTH( )

返回比指定日期早或晚指定月数的日期。

HOUR( )

从指定的时间或日期时间中提取小时并将其以使用 24 小时时钟的数值形式返回。

MAXIMUM( )

返回一组数值类型值中的最大值,或一组日期时间类型值中的最新值。

MINIMUM( )

返回一组数值类型值中的最小值,或一组日期时间类型值中的最旧值。

MINUTE( )

从指定的时间或日期时间中提取分钟并将其以数值形式返回。

MONTH( )

从指定的日期或日期时间中提取月份并将其以数值形式(1 到 12)返回。

NOW( )

将当前操作系统时间作为日期时间数据类型返回。

SECOND( )

从指定的时间或日期时间中提取秒数并将其以数值形式返回。

STOD( )

将序列日期,即以整数形式表示的日期转换为日期值。英文“Serial to Date”的缩写。

STODT( )

将序列日期时间,即以整数形式表示的日期时间和 24 小时的小数部分转换为日期时间值。英文“Serial to Datetime”的缩写。

STOT( )

将序列时间,即以 24 小时的小数部分形式表示的时间(其中,24 小时等于 1)转换为时间值。英文“Serial to Time”的缩写。

TIME( )

从指定的时间或日期时间中提取时间并将其以字符串形式返回。还可以返回当前操作系统时间。

TODAY( )

将当前操作系统日期作为日期时间数据类型返回。

UTOD( )

将包含一个格式化日期的 Unicode 字符串转换为一个 Analytics 日期值。英文“Unicode to Date”的缩写。

WORKDAY( )

返回两个日期之间的工作日数量。

YEAR( )

从指定的日期或日期时间中提取年份并使用 YYYY 格式将其以数值形式返回。

财务

函数 描述

CUMIPMT( )

返回在一系列期间中为贷款支付的累计利息。

CUMPRINC( )

返回在一系列期间中为贷款支付的累计本金。

EFFECTIVE( )

返回贷款的有效年利率。

FVANNUITY( )

返回一系列付款的终值(使用固定利率计算)。终值等于付款之和加上累计复利。

FVLUMPSUM( )

返回当前总价值的终值(使用固定利率计算)。

FVSCHEDULE( )

返回当前总价值的终值(使用一系列利率计算)。

IPMT( )

返回在单个期间内为贷款支付的利息。

NOMINAL( )

返回贷款的名义年利率。

NPER( )

返回付清贷款所需的期数。

PMT( )

返回清偿贷款所需的定期付款金额(本金 + 利息)。

PPMT( )

返回在单个期间内为贷款支付的本金。

PVANNUITY( )

返回一系列将来付款的现值(使用固定利率计算)。现值是当前总价值。

PVLUMPSUM( )

返回生成特定将来一次付清总额所需的现值(使用固定利率计算)。现值是当前总价值。

RATE( )

返回每期的利率。

域和记录

函数 描述

FTYPE( )

返回可识别域或变量,或 Analytics 项目条目类型的数据类型的字符。

HASH( )

根据输入值返回一个加盐加密哈希值。

ISDEFINED( )

如果指定的域或者变量已定义,则返回 T(真),否则返回 F(假)。

OFFSET( )

返回其起始位置偏移指定数目的字节的域的值。

RECLEN( )

返回当前记录的长度。

RECNO( )

返回当前记录数。

RECOFFSET( )

返回自当前记录起第指定数目个记录的一个域值。

VERIFY( )

返回逻辑值,表明物理数据域中的数据是否有效。

表、文件和项目

函数 描述

FILESIZE( )

以字节为单位返回指定文件的大小,或者如果该文件不存在,则返回 -1。

FTYPE( )

返回可识别域或变量,或 Analytics 项目条目类型的数据类型的字符。

GETOPTIONS( )

返回指定 Analytics 选项的当前设置(选项对话框设置)。

PROPERTIES( )

返回指定 Analytics 项目条目的属性信息。

变量测试

函数 描述

FTYPE( )

返回可识别域或变量,或 Analytics 项目条目类型的数据类型的字符。

ISDEFINED( )

如果指定的域或者变量已定义,则返回 T(真),否则返回 F(假)。

Python

函数 描述
PYDATE( )

返回由外部 Python 脚本中的函数计算的日期值。Python 中的数据处理存在于 Analytics 的外部。

PYDATETIME( )

返回由外部 Python 脚本中的函数计算的日期时间值。Python 中的数据处理存在于 Analytics 的外部。

PYLOGICAL( )

返回由外部 Python 脚本中的函数计算的逻辑值。Python 中的数据处理存在于 Analytics 的外部。

PYNUMERIC( )

返回由外部 Python 脚本中的函数计算的数值类型值。Python 中的数据处理存在于 Analytics 的外部。

PYSTRING( )

返回由外部 Python 脚本中的函数计算的字符值。Python 中的数据处理存在于 Analytics 的外部。

PYTIME( )

返回由外部 Python 脚本中的函数计算的时间值。Python 中的数据处理存在于 Analytics 的外部。

R

函数 描述
RDATE( )

返回由 R 函数或脚本计算的日期值。R 中的数据处理存在于 Analytics 的外部。

RDATETIME( )

返回由 R 函数或脚本计算的日期时间值。R 中的数据处理存在于 Analytics 的外部。

RLOGICAL( )

返回由 R 函数或脚本计算的逻辑值。R 中的数据处理存在于 Analytics 的外部。

RNUMERIC( )

返回由 R 函数或脚本计算的数值。R 中的数据处理存在于 Analytics 的外部。

RSTRING( )

返回由 R 函数或脚本计算的字符串值。R 中的数据处理存在于 Analytics 的外部。

RTIME( )

返回由 R 函数或脚本计算的时间值。R 中的数据处理存在于 Analytics 的外部。

位和字符编码

函数 描述

ASCII( )

返回指定字符的 ASCII 码。

BIT( )

以包含八个字符的字符串的形式返回当前记录中指定字节位置的二进制表示。

BYTE( )

返回存储于当前记录中指定字节位置的字符。

CHR( )

返回与指定的 ASCII 码相关联的字符。

DBYTE( )

返回记录中指定字节位置的 Unicode 字符。

DHEX( )

将 Unicode 字符串转换为十六进制字符串。

DIGIT( )

返回指定压缩数据类型字节的上半部分数字或下半部分数字。

HEX( )

将 ASCII 字符串转换为十六进制字符串。

HTOU( )

将十六进制字符串转换为 Unicode 字符串。英文“Hexadecimal to Unicode”的缩写。

MASK( )

对两个字符串的第一个字节执行按位 AND 操作。

SHIFT( )

返回单个字符串,其中输入值的第一个字符的位移动到左侧或右侧。

函数语法规范

规范

描述

括号 ( )
  • 函数输入值必须放在括号内:

    ALLTRIM(Vendor_Name)
  • 左括号必须紧跟在函数名称后面,彼此之间没有空格:

    ALLTRIM(Vendor_Name)

    不是:

    ALLTRIM (Vendor_Name)
  • 必须使用括号,即使未指定输入值:

    RECNO( )
分隔符
  • 必须用分隔符分隔函数输入值:

    SUBSTRING(Product_ID,5,12)
  • 有效的分隔符为空格、逗号或分号。

    逗号或分号分隔符必须在选项对话框中的数值选项卡上的列表分隔符选项中指定。

提示

为了提高可读性,您可以同时使用空格和其他分隔符之一:

SUBSTRING(Product_ID, 5, 12)
限定符
  • 字面量字符值周围需要单引号或双引号:

    EXCLUDE(Product_ID, "#-")
  • 字面量日期时间值周围需要反引号:

    AGE(到期日期, `20141231`)
  • 数值类型值不需要限定符:

    ABS(-7.2)
  • 逻辑值 ( T / F ) 不需要限定符:

    LEVDIST(Vendor_Name, Vendor_Name_2, F)
  • 域名不需要限定符:

    ALLTRIM(Vendor_Name)
字面量日期时间格式
  • 字面量日期值必须按 YYYYMMDDYYMMDD 格式输入:
    • `20141231`
    • `141231`
  • 字面量时间值必须按 hhmmsshhmm 格式输入,并且前面有一个空格、Tt
    • `t235959`
    • `20141231 2359`

缩略函数名称

注意

ACL 建议您不要缩略计算域、表达式或脚本中的函数名称,并且使用每个名称的完整版本。

缩略操作会使计算域、表达式或脚本难以阅读和理解。没有完整的函数名称,在在线帮助中搜索函数会变得更加困难。

如果您的 Analytics 项目或脚本将被其他可能不熟悉缩写的人修改或继承,则缩略操作尤其会带来问题。

在计算域、表达式或脚本中指定函数时,您可以缩略它们的名称。您必须包括函数名称中足够多的前导字符,以在所有 Analytics 函数中唯一地标识该函数。

例如:

  • MAX 唯一地标识 MAXIMUM 函数,因此是有效的缩写。
  • MA 未唯一地标识 MAXIMUM 函数并生成错误消息。

您可以使缩写变得任意短,前提是它仍然唯一地标识该函数。

例如,对于 ALLTRIM 函数而言,下列所有缩写都是有效的:

  • ALLTR
  • ALLT
  • ALL
  • AL

说明

缩写越短,它们就越难以被其他用户识别。

函数文档规范

规范

用于

大写

ACL 脚本函数的名称。

说明

在所有 Analytics 文档中,函数名称被以大写表示,这只是一种格式化规范。Analytics 不要求以大写形式输入函数。

斜体

用户提供的函数参数。

|

(纵向条形图)

区分用括号或大括号括起来的语法条目。您只能使用其中一个条目。

< >

(尖角括号)

可选语法条目。不要输入括号。

{ }

(大括号)

所需语法条目。不要输入大括号。

<,...n>

表示前面的条目可以重复 n 次。重复出现的条目用逗号分隔。

函数文档中使用的数据类型术语

以下术语被用于标识函数形参、实参和返回值的数据类型:

术语

意味着您可以使用:

字符 任何属于 Analytics 字符 (C) 类别的域名称、表达式或变量,或者字符串字面量
数值 任何属于 Analytics 数值 (N) 数据类别的域名称、表达式或变量,或者数值类型的值
日期时间 任何属于 Analytics 日期时间 (D) 类别的域名称、表达式或变量,或者日期时间字面量
逻辑 任何属于 Analytics 逻辑 (L) 类别的域名称、表达式或变量,或者逻辑值
字段 任何属于 Analytics 数据类别的域的名称
ACL 脚本指南 14.1