# 函數庫列表 ### 系統函數 | 函數名稱 | 說明 | | --- | --- | | assert(predicate, [msg]) | 斷言函數，當 predicate 的結果為 false 的時候拋出 AssertFailed 異常， msg 錯誤信息可選。 | | sysdate() | 返回當前日期對象 java.util.Date | | rand() | 返回一個介于 [0, 1) 的隨機數，結果為 double 類型 | | rand(n) | 返回一個介于 [0, n) 的隨機數，結果為 long 類型 | | cmp(x, y) | 比較 x 和 y 大小，返回整數，0 表示相等， 1 表達式 x > y，負數則 x < y。 | | print([out],obj) | 打印對象,如果指定 out 輸出流，向 out 打印， 默認輸出到標準輸出 | | println([out],obj) | 與 print 類似,但是在輸出后換行 | | 或者 | | | p([out], obj) | | | pst([out], e); | 等價于 e.printStackTrace()，打印異常堆棧，out 是可選的輸出流，默認是標準錯誤輸出 | | now() | 返回 System.currentTimeMillis() 調用值 | | long(v) | 將值轉為 long 類型 | | double(v) | 將值轉為 double 類型 | | boolean(v) | 將值的類型轉為 boolean，除了 nil 和 false，其他都值都將轉為布爾值 true。 | | str(v) | 將值轉為 string 類型，如果是 nil（或者 java null），會轉成字符串 'null' | | bigint(x) | 將值轉為 bigint 類型 | | decimal(x) | 將值轉為 decimal 類型 | | identity(v) | 返回參數 v 自身，用于跟 seq 庫的高階函數配合使用。 | | type(x) | 返回參數 x 的類型，結果為字符串，如 string, long, double, bigint, decimal, function 等。Java? 類則返回完整類名。 | | is_a(x, class) | 當 x 是類 class 的一個實例的時候，返回 true，例如 is_a("a", String) ，class 是類名。 | | is_def(x) | 返回變量 x 是否已定義（包括定義為 nil），結果為布爾值 | | undef(x) | “遺忘”變量? x，如果變量 x 已經定義，將取消定義。 | | range(start, end, [step]) | 創建一個范圍，start 到 end 之間的整數范圍，不包括 end， step 指定遞增或者遞減步幅。 | | tuple(x1, x2, ...) | 創建一個 Object 數組，元素即為傳入的參數列表。 | | eval(script, [bindings], [cached]) | 對一段腳本文本 script 進行求值，等價于 AviatorEvaluator.execute(script, env, cached) | | comparator(pred) | 將一個謂詞（返回布爾值）轉化為 java.util.Comparator 對象，通常用于 sort 函數。 | | max(x1, x2, x3, ...) | 取所有參數中的最大值，比較規則遵循邏輯運算符規則。 | | min(x1, x2, x3, ...) | 取所有參數中的最小值，比較規則遵循邏輯運算符規則。 | | constantly(x) | 用于生成一個函數，它對任意（個數）參數的調用結果 x。 | ### 數學函數 | 函數名稱 | 說明 | | --- | --- | | math.abs(d) | 求 d 的絕對值 | | math.round(d) | 四舍五入 | | math.floor(d) | 向下取整 | | math.ceil(d) | 向上取整 | | math.sqrt(d) | 求 d 的平方根 | | math.pow(d1,d2) | 求 d1 的 d2 次方 | | math.log(d) | 求 d 的自然對數 | | math.log10(d) | 求 d 以 10 為底的對數 | | math.sin(d) | 正弦函數 | | math.cos(d) | 余弦函數 | | math.tan(d) | 正切函數 | | math.atan(d) | 反正切函數 | | math.acos(d) | 反余弦函數 | | math.asin(d) | 反正弦函數 | ### 字符串表達式 | 函數名稱 | 說明 | | --- | --- | | date_to_string(date,format) | 將 Date 對象轉化化特定格式的字符串 | | string_to_date(source,format) | 將特定格式的字符串轉化為 Date 對 象 | | string.contains(s1,s2) | 判斷 s1 是否包含 s2,返回 Boolean | | string.length(s) | 求字符串長度,返回 Long | | string.startsWith(s1,s2) | s1 是否以 s2 開始,返回 Boolean | | string.endsWith(s1,s2) | s1 是否以 s2 結尾,返回 Boolean | | string.substring(s,begin[,end]) | 截取字符串 s,從 begin 到 end,如果忽略 end 的話,將從 begin 到結尾,與 java.util.String.substring 一樣。 | | string.indexOf(s1,s2) | java 中的 s1.indexOf(s2),求 s2 在 s1 中 的起始索引位置,如果不存在為-1 | | string.split(target,regex,[limit]) | Java 里的 String.split 方法一致 | | string.join(seq,seperator) | 將集合 seq 里的元素以 seperator 為間隔 連接起來形成字符串 | | string.replace_first(s,regex,replacement) | Java 里的 String.replaceFirst 方法 | | string.replace_all(s,regex,replacement) | Java 里的 String.replaceAll 方法 | ### Sequence 函數（集合處理） | 函數名稱 | 說明 | | --- | --- | | repeat(n, x) | 返回一個 List，將元素 x 重復 n 次組合而成。 | | repeatedly(n, f) | 返回一個 List，將函數 f 重復調用 n 次的結果組合而成。 | | seq.array(clazz, e1, e2,e3, ...) | 創建一個指定 clazz 類型的數組，并添加參數 e1,e2,e3 ...到這個數組并返回。 clazz 可以是類似 java.lang.String 的類型，也可以是原生類型，如 int/long/float 等 | | seq.array_of(clazz, size1, size2, ...sizes) | 創建 clazz 類型的一維或多維數組，維度大小為 sizes 指定。clazz 同 seq.array 定義。 | | seq.list(p1, p2, p3, ...) | 創建一個 java.util.ArrayList 實例，添加參數到這個集合并返回。 | | seq.set(p1, p2, p3, ...) | 創建一個 java.util.HashSet 實例，添加參數到這個集合并返回。 | | seq.map(k1, v1, k2, v2, ...) | 創建一個 java.util.HashMap 實例，參數要求偶數個，類似 k1,v1 這樣成對作為 key-value 存入 map，返回集合。 | | seq.entry(key, value) | 創建 Map.Entry 對象，用于 map, filter 等函數 | | seq.keys(m) | 返回 map 的 key 集合 | | seq.vals(m) | 返回 map 的 value 集合 | | into(to_seq, from_seq) | 用于 sequence 轉換，將 from sequence 的元素使用 seq.add 函數逐一添加到了 to sequence 并返回最終的 to_seq | | seq.contains_key(map, key) | 當 map 中存在 key 的時候（可能為 null），返回 true。對于數組和鏈表，key 可以是 index，當 index 在有效范圍[0..len-1]，返回 true，否則返回 false | | seq.add(coll, element) | 往集合 coll 添加元素，集合可以是 java.util.Collection，也可以是 java.util.Map（三參數版本） | | seq.add(m, key, value) | | | seq.put(coll, key, value) | 類似 List.set(i, v)。用于設置 seq 在 key 位置的值為 value，seq 可以是 map ，數組或者 List。 map 就是鍵值對， 數組或者 List 的時候， key 為索引位置整數，value 即為想要放入該索引位置的值。 | | seq.remove(coll, element) | 從集合或者 hash map 中刪除元素或者 key | | seq.get(coll, element) | 從 list、數組或者 hash-map 獲取對應的元素值，對于 list 和數組， element 為元素的索引位置（從 0 開始），對于 hash map 來說， element 為 key。 | | map(seq,fun) | 將函數 fun 作用到集合 seq 每個元素上, 返回新元素組成的集合 | | filter(seq,predicate) | 將謂詞 predicate 作用在集合的每個元素 上,返回謂詞為 true 的元素組成的集合 | | count(seq) | 返回集合大小，seq 可以是數組，字符串，range ，List 等等 | | is_empty(seq) | 等價于 count(seq) == 0，當集合為空或者 nil，返回 true | | distinct(seq) | 返回 seq 去重后的結果集合。 | | is_distinct(seq) | 當 seq 沒有重復元素的時候，返回 true，否則返回 false | | concat(seq1, seq2) | 將 seq1 和 seq2 “連接”，返回連接后的結果，復雜度 O(m+n)， m 和 n 分別是兩個集合的長度。 | | include(seq,element) | 判斷 element 是否在集合 seq 中,返回 boolean 值，對于 java.uitl.Set 是 O(1) 時間復雜度，其他為 O(n) | | sort(seq, [comparator]) | 排序集合,僅對數組和 List 有效,返回排序后的新集合，comparator 是一個 java.util.Comparator 實例，可選排序方式。 | | reverse(seq) | 將集合元素逆序，返回新的集合。 | | reduce(seq,fun,init) | fun 接收兩個參數,第一個是集合元素, 第二個是累積的函數,本函數用于將 fun 作用在結果值（初始值為 init 指定)和集合的每個元素上面，返回新的結果值；函數返回最終的結果值 | | take_while(seq, pred) | 遍歷集合 seq，對每個元素調用 pred(x)，返回 true則加入結果集合，最終返回收集的結果集合。也就是說從集合 seq 收集 pred 調用為 true 的元素。 | | drop_while(seq, pred) | 與 take_while 相反，丟棄任何 pred(x) 為 true 的元素并返回最終的結果集合。 | | group_by(seq, keyfn) | 對集合 seq 的元素按照 keyfn(x) 的調用結果做分類，返回最終映射 map。具體使用見文檔。 | | zipmap(keys, values) | 返回一個 HashMap，其中按照 keys 和 values 兩個集合的順序映射鍵值對。具體使用見文檔。 | | seq.every(seq, fun) | fun 接收集合的每個元素作為唯一參數，返回 true 或 false。當集合里的每個元素調用 fun 后都返回 true 的時候，整個調用結果為 true，否則為 false。 | | seq.not_any(seq, fun) | fun 接收集合的每個元素作為唯一參數，返回 true 或 false。當集合里的每個元素調用 fun 后都返回 false 的時候，整個調用結果為 true，否則為 false。 | | seq.some(seq, fun) | fun 接收集合的每個元素作為唯一參數，返回 true 或 false。當集合里的只要有一個元素調用 fun 后返回 true 的時候，整個調用結果立即為該元素，否則為 nil。 | | seq.eq(value) | 返回一個謂詞,用來判斷傳入的參數是否跟 value 相等,用于 filter 函數,如filter(seq,seq.eq(3)) 過濾返回等于3 的元素組成的集合 | | seq.neq(value) | 與 seq.eq 類似,返回判斷不等于的謂詞 | | seq.gt(value) | 返回判斷大于 value 的謂詞 | | seq.ge(value) | 返回判斷大于等于 value 的謂詞 | | seq.lt(value) | 返回判斷小于 value 的謂詞 | | seq.le(value) | 返回判斷小于等于 value 的謂詞 | | seq.nil() | 返回判斷是否為 nil 的謂詞 | | seq.exists() | 返回判斷不為 nil 的謂詞 | | seq.and(p1, p2, p3, ...) | 組合多個謂詞函數，返回一個新的謂詞函數，當今僅當 p1、p2、p3 ...等所有函數都返回 true 的時候，新函數返回 true | | seq.or(p1, p2, p3, ...) | 組合多個謂詞函數，返回一個新的謂詞函數，當 p1, p2, p3... 其中一個返回 true 的時候，新函數立即返回 true，否則返回 false。 | | seq.min(coll) | 返回集合中的最小元素，要求集合元素可比較（實現 Comprable 接口），比較規則遵循 aviator 規則。 | | seq.max(coll) | 返回集合中的最大元素，要求集合元素可比較（實現 Comprable 接口），比較規則遵循 aviator 規則。 |