名前付き関数: defun
名前付き関数は defun キーワードで作成します。基本形は次のとおりです。
(defun function-name (zero or some arguments)
"docstring"
(code of function body))
戻り値は本体の最後の式が返す値です (詳しくは下を参照)。”return xx” のような文はありません。
たとえば:
(defun hello-world ()
;; ^^ 引数なし
(print "hello world!"))
呼び出してみます。
(hello-world)
;; "hello world!" <-- 出力
;; "hello world!" <-- 文字列が返る
print 関数は 1 つの引数を標準出力に出力し、さらにそれを返します。そのため “hello world!” がこの関数の戻り値になります。
引数
基本形: 必須引数
引数は次のように追加します。
(defun hello (name)
"Say hello to `name'."
(format t "hello ~a !~&" name))
;; HELLO
(~a は変数を 見やすく 出力するために最もよく使われる format ディレクティブで、~& は改行を出力します)
関数を呼び出します。
(hello "me")
;; hello me ! <-- これは `format` により出力される
;; NIL <-- 戻り値: `format t` は文字列を
;; 標準出力に出力し nil を返す
正しい数の引数を指定しないと、明示的なエラーメッセージとともに対話的デバッガに入ります。
(hello)
invalid number of arguments: 0
省略可能な引数: &optional
省略可能な引数は lambda list の &optional キーワードの後に宣言します。これらは順序を持ち、続けて現れなければなりません。
この関数は:
(defun hello (name &optional age gender) …)
次のように呼び出す必要があります。
(hello "me") ;; 必須引数への値、
;; 省略可能な引数は 0 個
(hello "me" "7") ;; age への値
(hello "me" 7 :h) ;; age と gender への値
名前付きパラメータ: &key
引数の順序を覚えるのがいつも便利とは限りません。そのため、引数を名前で渡せます。&key argname で宣言し、関数の呼び出しでは :argname "value" で設定し、関数の本体では通常の変数として argname を使います。
キー引数のデフォルト値は nil です。
(defun hello (name &key happy)
"If `happy' is `t', print a smiley"
(format t "hello ~a " name)
(when happy
(format t ":)~&")))
次の呼び出しが可能です。
(hello "me")
(hello "me" :happy t)
(hello "me" :happy nil) ;; 不要、(hello "me") と同等
一方、これは正しくありません: (hello "me" :happy):
odd number of &KEY arguments
複数のキーパラメータを持つ関数宣言の例です。
(defun hello (name &key happy lisper cookbook-contributor-p) …)
これは 0 個以上のキーパラメータを任意の順序で指定して呼び出せます。
(hello "me" :lisper t)
(hello "me" :lisper t :happy t)
(hello "me" :cookbook-contributor-p t :happy t)
最後に、キーはプログラムから選択できます(変数にできます)。
(let ((key :happy)
(val t))
(hello "me" key val))
;; hello me :)
;; NIL
オプショナルパラメータとキーパラメータの混在
一般にはスタイル警告になりますが、可能です。
(defun hello (&optional name &key happy)
(format t "hello ~a " name)
(when happy
(format t ":)~&")))
SBCL では次のようになります。
; in: DEFUN HELLO
; (SB-INT:NAMED-LAMBDA HELLO
; (&OPTIONAL NAME &KEY HAPPY)
; (BLOCK HELLO (FORMAT T "hello ~a " NAME) (WHEN HAPPY (FORMAT T ":)~&"))))
;
; caught STYLE-WARNING:
; &OPTIONAL and &KEY found in the same lambda list: (&OPTIONAL (NAME "John") &KEY
; HAPPY)
;
; compilation unit finished
; caught 1 STYLE-WARNING condition
呼び出すことはできます。
(hello "me" :happy t)
;; hello me :)
;; NIL
キーパラメータのデフォルト値
ラムダリストでは、次の (happy t) のような組を使ってオプショナル引数やキー引数にデフォルト値を与えます。
(defun hello (name &key (happy t))
これで happy はデフォルトで真です。
キーパラメータは指定されたか?
このヒントは必要なら今は飛ばしてかまいませんが、便利になることがあるので後で戻ってきてください。
キーパラメータのデフォルト値は nil だと見ました((defun hello (name &key happy) …))。しかし、「値がデフォルトで NIL である」ことと「利用者が NIL を指定した」ことはどう区別できるでしょうか。
デフォルト値を設定するには 2 要素のリストを使うことを見ました。
&key (happy t)
この疑問に答えるには、次のような 3 つ組を使います。
&key (happy t happy-p)
ここで happy-p はキーが渡されたかどうかを知るための 述語 変数として働きます (-p を使うのは慣習にすぎないので、好きな名前を付けられます)。渡されていれば T になります。
これで、:happy が明示的に NIL に設定された場合は悲しい顔を出力します。デフォルトでは出力しません。
(defun hello (name &key (happy nil happy-p))
(format t "Key supplied? ~a~&" happy-p)
(format t "hello ~a " name)
(when happy-p
(if happy
(format t ":)")
(format t ":("))))
可変個数の引数: &rest
関数に可変個数の引数を受け取らせたいことがあります。&rest <variable> を使います。この <variable> はリストになります。
(defun mean (x &rest numbers)
(/ (apply #'+ x numbers)
(1+ (length numbers))))
(mean 1)
(mean 1 2) ;; => 3/2 (そう、ratio として print される)
(mean 1 2 3 4 5) ;; => 3
key 引数を定義し、さらに他も許す: &allow-other-keys
見てみましょう。
(defun hello (name &key happy)
(format t "hello ~a~&" name))
(hello "me" :lisper t)
;; => Error: unknown keyword argument
一方で:
(defun hello (name &key happy &allow-other-keys)
(format t "hello ~a~&" name))
(hello "me" :lisper t)
;; hello me
引数を受け渡ししたり、関数をより高い水準で操作したりするとき、&allow-other-keys が必要になることがあります。
実例です。常に :if-exists :supersede を使ってファイルを開く関数を定義しますが、他のキーはそのまま open 関数に渡します。
(defun open-supersede (f &rest other-keys &key &allow-other-keys)
(apply #'open f :if-exists :supersede other-keys))
:if-exists 引数が重複した場合、最初に渡したものが優先されます。
戻り値
関数の戻り値は、本体で最後に実行されたフォームが返す値です。
大域脱出の方法 (return-from <function name> <value>) もありますが、通常は必要ありません。
Common Lisp には多値という概念もあります。
多値
多値を返すことは、結果のリストを返すこととは違います。
簡単な例
1 つの値を返す関数を定義します。
(defun foo ()
:a)
次に、この関数呼び出しの結果を変数に設定します。
(defparameter *var* (foo))
*var* は今 :a です。これはごく普通の振る舞いです。
今度は values を使って、この関数が 多値 を返すようにします。
(foo ()
(values :a :b :c))
そして再びその結果を *var* に設定します。
(setf *var* (foo))
*var* の値は何でしょうか。:a のままです。残りの値を受け取るようには要求していないので、:b と :c は捨てられました。
これは実際とても便利です。関数が以前より多くの値を返すように変更しても、呼び出し箇所を変更したりリファクタリングしたりする必要がありません。
多値を返す: values
関数 values は多値を返すために使います。
(values 'a 'b)
;; => A
;; => B
引数なしで values を呼び出すと、値をまったく返しません。
これは nil を返すこととは違います。
下で説明する関数を使って多値を受け取らない限り、他の関数から見えて使われるのは最初の値だけです。
(+ (values 1 2 3) (values 10 20 30))
;; => 11
values はリストを作りません。
多値がある理由。CL の組み込み関数を見る
ほとんどの Common Lisp のフォームは 1 つの値を返しますが、関数が複数の値 (または 0 個) を返せると便利なことがあります。
たとえば round は、丸めた結果と、丸めのために取り除かれた量という 2 つの値を返します。
(round 10.33333333)
;; => 10
;; => 0.33333302
ほとんどの場合は丸めた値だけが必要ですが、何らかの理由で剰余を知りたいなら受け取れます。関数が計算したすべての値がほとんどの場合に使われると予想するなら、結果をリスト、CLOS のインスタンス、など にまとめて返す方がよいでしょう。多値は、最初の値が最も頻繁に必要で、後の値はあまり使われない場合にだけ使います。
同様に、hash-table の内容を取得すると 2 つの値が返ります。結果と、そのキーが見つかったかどうかを示す真偽値です。下を参照してください。
多値の受け取り: multiple-value-bind、nth-value、multiple-value-list など
多値を受け取る最も一般的な方法は multiple-value-bind です。
(multiple-value-bind (c d) (values 1 2)
(list c d))
;; => (1 2)
;; 次のように indent されることも多い:
(multiple-value-bind (c d)
(values 1 2)
(list c d))
これは let による束縛のように動作します。値 c と d は multiple-value-bind のスコープ内に存在します。
返される値の数と、束縛する変数の数は一致していなくてもかまいません。値が多すぎる場合、余分なものは捨てられます。束縛する変数が多すぎる場合、余分な変数は nil に設定されます。
(multiple-value-bind (a b) (values 1 2 3 4)
(list a b))
;; =>(1 2)
(multiple-value-bind (a b) (values 1)
(list a b))
;; => (1 NIL)
関数 values は setf 可能で、これを値の受け取りに使うこともできます。
(let (c d)
(setf (values c d) (values 1 2))
(list c d))
;; => (1 2)
同等の multiple-value-setq も使えます。
(let (c d)
(multiple-value-setq (c d) (values 3 4))
(list c d))
;; => (3 4)
また、multiple-value-call で多値を直接関数呼び出しに送り込めます。
(multiple-value-call #'list (values 1 2 3))
;; => (1 2 3)
関数 multiple-value-list は上のコードと同等です。
(multiple-value-list (values 1 2 3))
;; => (1 2 3)
逆に、values-list でリストを多値に変換できます。
(values-list '(1 2 3))
;; => 1
;; => 2
;; => 3
nth-value で特定の値を選択できます。
(nth-value 0 (values :a :b :c)) ;; => :A
(nth-value 2 (values :a :b :c)) ;; => :C
(nth-value 9 (values :a :b :c)) ;; => NIL
ここでも、values はリストとは違うことを改めて強調しておきます。
(nth-value 0 (list :a :b :c)) ;; => (:A :B :C)
;; => リストはそれ自体で 1 つのデータ構造
(nth-value 1 (list :a :b :c)) ;; => NIL
;; => 受け取れる 2 番目の値はない
成功または失敗を報告するために多値を使う
多値の典型的な用途は、nil が見つかった場合と検索の失敗を区別することです。たとえば gethash は 2 つの値を返します。1 つ目は検索の結果です。何も見つからなければ nil かもしれませんが、hashtable に実際に保存されている nil かもしれません。2 つ目の戻り値は検索が成功したかどうかを示すフラグです。
(defvar *hash* (make-hash-table))
(setf (gethash 'a *hash*) 12)
(setf (gethash 'b *hash*) nil)
(gethash 'a *hash*)
;; => 12 <--- 1 番目の戻り値: 結果
;; => T <--- 2 番目の戻り値: key が見つかった
(gethash 'b *hash*)
;; => NIL
;; => T
(gethash 'c *hash*)
;; => NIL
;; => NIL <---- この key は見つからなかった
無名関数: lambda
無名関数は lambda で作成します。
(lambda (x) (print x))
lambda は funcall または apply で呼び出せます (下を参照)。
クォートされていないリストの最初の要素が lambda 式なら、その lambda が呼び出されます。
((lambda (x) (print x)) "hello")
;; hello
関数をプログラムから呼び出す: funcall と apply
funcall は引数の数がわかっているときに使います。一方 apply は、たとえば &rest から得たリストに対して使えます。
(funcall #'+ 1 2)
(apply #'+ '(1 2))
apply について覚えておくべきことが 1 つあります。非常に大きなリストには使えません。関数の引数リストには長さの制限があります。
この制限は変数 call-arguments-limit で確認できます。これは処理系に依存します。SBCL ではかなり大きい (4611686018427387903) ですが、任意の長さの引数に関数を適用する別の選択肢があります。それが reduce です。
reduce
reduce は任意の長さのリストやベクトルに関数を適用するために使います。関数を 2 つの引数で繰り返し呼び出し、引数リストを走査します。
たとえば、上のように apply を使う代わりに:
(apply #'min '(22 1 2 3)) ;; 非常に大きなリストを想像してください
reduce を使えます。
(reduce #'min '(22 1 2 3))
引数が 1000 要素の長さなら、apply は min 関数を 1000 個の引数で呼び出します。一方 reduce は min を毎回 2 個の引数で (ほぼ) 1000 回呼び出します。
reduce はリストを走査します。つまり次のようになります。
- まず
minが引数 22 と 1 で呼ばれ、中間結果 1 を生成します。 minはこの中間結果を最初の引数とし、引数リストの次の引数である 2 とともに再び呼ばれます。中間結果はまた 1 です。minは引数 1 と 3 で再び呼ばれ、最終結果 1 を返します。
トレースできます。
CL-USER> (trace min)
CL-USER> (reduce #'min '(22 1 2 3))
0: (MIN 22 1)
0: MIN returned 1
0: (MIN 1 2)
0: MIN returned 1
0: (MIN 1 3)
0: MIN returned 1
1
完全なシグネチャは次のとおりです。
(reduce function sequence &key key from-end start end initial-value)
ここで key、from-end、start、end は他の組み込み関数にも見られるキー引数です(データ構造の章を参照)。:initial-value が与えられた場合、最初のサブシーケンスの前に置かれます。
reduce の詳細は Community Spec を読んでください。
名前で関数を参照する: シングルクォート ' か シャープクォート #' か?
上の例では #' を使いましたが、シングルクォートも動作し、実際のコードでも見かけます。どちらを使うべきでしょうか。
一般には #' を使う方が安全です。レキシカルスコープを尊重するからです。見てみましょう。
(defun foo (x)
(* x 100))
(flet ((foo (x) (1+ x)))
(funcall #'foo 1))
;; => 2、期待どおり
;; しかし:
(flet ((foo (x) (1+ x)))
(funcall 'foo 1))
;; => 100
#' は実際には (function …) の省略形です。
(function +)
;; #<FUNCTION +>
(flet ((foo (x) (1+ x)))
(print (function foo))
(funcall (function foo) 1))
;; #<FUNCTION (FLET FOO) {1001C0ACFB}>
;; 2
function または #' の省略形を使うとローカル関数を参照できます。代わりにシンボルを funcall に渡すと、呼び出されるのは常に グローバル環境 でそのシンボルによって名付けられた関数です。
さらに、#' は関数を値として保持します。関数が再定義されても、#' でこの関数を参照している束縛は元の動作を実行し続けます。
関数をパラメータに代入してみます。
(defparameter *foo-caller* #'foo)
(funcall *foo-caller* 1)
;; => 100
ここで foo を再定義しても、*foo-caller* の振る舞いは変わりません。
(defun foo (x) (1+ x))
;; WARNING: redefining CL-USER::FOO in DEFUN
;; FOO
(funcall *foo-caller* 1)
;; 100 ;; 2 ではない
呼び出し元をシングルクォートの 'foo で束縛すると、関数は実行時に解決されます。
(defun foo (x) (* x 100)) ;; 元の動作に戻す
(defparameter *foo-caller-2* 'foo)
;; *FOO-CALLER-2*
(funcall *foo-caller-2* 1)
;; 100
;; 定義を変更する:
(defun foo (x) (1+ x))
;; WARNING: redefining CL-USER::FOO in DEFUN
;; FOO
;; もう一度試す:
(funcall *foo-caller-2* 1)
;; 2
どの振る舞いが望ましいかは用途によります。一般にはシャープクォートを使う方が驚きが少ないです。しかし密なループを実行していてライブ更新の仕組み (ゲームやライブな可視化を考えてください) が欲しい場合は、ループが利用者の新しい関数定義を拾うようにシングルクォートを使いたいかもしれません。
高階関数: 関数を返す関数
関数を返す関数を書くのは十分に簡単です。
(defun adder (n)
(lambda (x) (+ x n)))
;; ADDER
ここでは、function 型 の オブジェクト を返す関数 adder を定義しました。
結果として得られる関数を呼び出すには、funcall または apply を使う必要があります。
(adder 5)
;; #<CLOSURE (LAMBDA (X) :IN ADDER) {100994ACDB}>
(funcall (adder 5) 3)
;; 8
すぐに呼び出そうとすると不正な関数呼び出しになります。
((adder 3) 5)
In: (ADDER 3) 5
((ADDER 3) 5)
Error: Illegal function call.
実際、CL では関数と変数に異なる 名前空間 があります。つまり、評価されるフォームの中での位置によって、同じ 名前 が別のものを指すことがあります。
;; シンボル foo は何にも束縛されていない:
CL-USER> (boundp 'foo)
NIL
CL-USER> (fboundp 'foo)
NIL
;; 変数を作る:
CL-USER> (defparameter foo 42)
FOO
CL-USER> foo
42
;; これで foo は値に束縛されている:
CL-USER> (boundp 'foo)
T
;; しかし関数としてはまだ違う:
CL-USER> (fboundp 'foo)
NIL
;; では関数を定義する:
CL-USER> (defun foo (x) (* x x))
FOO
;; これでシンボル foo は関数としても束縛された:
CL-USER> (fboundp 'foo)
T
;; 関数を取得する:
CL-USER> (function foo)
#<FUNCTION FOO>
;; 短縮表記:
CL-USER> #'foo
#<FUNCTION FOO>
;; 呼び出す:
(funcall (function adder) 5)
#<CLOSURE (LAMBDA (X) :IN ADDER) {100991761B}>
;; そして lambda を呼び出す:
(funcall (funcall (function adder) 5) 3)
8
少し単純化すると、Common Lisp の各シンボルには情報を保存する「セル」が(少なくとも)2 つあると考えられます。1 つは「値セル」と呼ばれ、シンボルに束縛された値を保持できます。boundp を使うと、シンボルが大域環境で値に束縛されているかを検査できます。シンボルの値セルには symbol-value でアクセスできます。
もう 1 つは「関数セル」と呼ばれ、シンボルに大域的に束縛された関数の定義を保持できます。この場合、シンボルはその定義に fbound されていると言います。fboundp を使うと、シンボルが関数に束縛されているかを検査できます。シンボルの関数セルには、大域環境では symbol-function でアクセスできます。
さて、シンボル が評価されると、変数 として扱われ、その値セルが返されます (単に foo)。複合フォーム、つまり cons が評価され、その car がシンボルなら、このシンボルの関数セルが使われます ((foo 3) のように)。
Common Lisp では Scheme と異なり、評価される複合フォームの car を任意のフォームにすることはできません。シンボルでない場合、それは (lambda lambda-list form*) の形をした lambda 式 でなければなりません。
これが上で得たエラーメッセージの理由です。(adder 3) はシンボルでも lambda 式でもありません。
複合フォームの car でシンボル *my-fun* を使えるようにしたいなら、その 関数セル に明示的に何かを保存する必要があります (通常これはマクロ defun が行ってくれます)。
;;; 上からの続き
CL-USER> (fboundp '*my-fun*)
NIL
CL-USER> (setf (symbol-function '*my-fun*) (adder 3))
#<CLOSURE (LAMBDA (X) :IN ADDER) {10099A5EFB}>
CL-USER> (fboundp '*my-fun*)
T
CL-USER> (*my-fun* 5)
8
詳しくは form evaluation についての CLHS の節を読んでください。
クロージャ
クロージャを使うとレキシカルな束縛を保持できます。これは、毎回関数に渡したくない状態を保存するときに便利です。利便性のためだけでなく、状態変数を外部からアクセス可能な名前空間に置かずに済みます。
(let ((limit 3)
(counter -1))
(defun my-counter ()
(if (< counter limit)
(incf counter)
(setf counter 0))))
(my-counter)
0
(my-counter)
1
(my-counter)
2
(my-counter)
3
(my-counter)
0
または同様に:
(defun repeater (n)
(let ((counter -1))
(lambda ()
(if (< counter n)
(incf counter)
(setf counter 0)))))
(defparameter *my-repeater* (repeater 3))
;; *MY-REPEATER*
(funcall *my-repeater*)
0
(funcall *my-repeater*)
1
(funcall *my-repeater*)
2
(funcall *my-repeater*)
3
(funcall *my-repeater*)
0
カウンタの生成に加えて、レキシカルクロージャのもう 1 つの一般的な用途はメモ化、つまり計算にコストがかかる関数の以前の結果をキャッシュすることです。下のメモ化されていない Fibonacci 関数は、すぐに計算時間がかなりかかるようになります。
(defun fibonacci (n)
(if (<= n 1)
n
(+ (fibonacci (- n 1)) (fibonacci (- n 2)))))
(time (fibonacci 40))
;; Evaluation took:
;; 2.843 seconds of real time
;; 2.841360 seconds of total run time (2.796188 user, 0.045172 system)
;; 99.93% CPU
;; 0 bytes consed
;; 102334155
以前に計算した結果を hash table に保存すると高速化できます。defvar を使うこともできますが、これはクロージャに適した用途です。1 つの関数だけが使う変数を名前空間に追加せずに済むからです。
(let ((memo (make-hash-table)))
(defun fibonacci (n)
(let ((value (gethash n memo)))
(cond ((<= n 1) n)
(value value)
(t (setf (gethash n memo)
(+ (fibonacci (- n 1)) (fibonacci (- n 2)))))))))
(time (fibonacci 40))
;; Evaluation took:
;; 0.000 seconds of real time
;; 0.000016 seconds of total run time (0.000015 user, 0.000001 system)
;; 100.00% CPU
;; 0 bytes consed
;; 102334155
メモ化ライブラリはいくつかあり、その一部はこのレキシカルクロージャとキャッシュの仕組みをマクロで包んでいます。
詳しくは Practical Common Lisp を参照してください。
setf function
関数 name は、最初のシンボルが setf である 2 つのシンボルの list にすることもできます。このとき最初の引数は新しい値です。
(defun (setf function-name) (new-value other optional arguments)
body)
この仕組みは CLOS メソッドでよく使われます。
例に向けて進めましょう。square を表す hash-table を操作するとします。この hash-table に square の width を保存します。
(defparameter *square* (make-hash-table))
(setf (gethash :width *square*) 21)
プログラムの life cycle 中、上で行ったように setf で square の width を変更できます。
square area を計算する関数を定義します。dimension と重複するため、これは hash-table には保存しません。
(defun area (square)
(expt (gethash :width square) 2))
ここで programming 上の必要から、square の *area* を変更し、それを square の dimension に反映できると非常に便利な状況になったとします。プログラムのアプリケーションインターフェイスにとって、次のような setf-function を定義すると扱いやすくなります。
(defun (setf area) (new-area square)
(let ((width (sqrt new-area)))
(setf (gethash :width square) width)))
これで次のようにできます。
(setf (area *square*) 100)
;; => 10.0
square を確認すると (describe、inspect など)、新しい width が設定されています。
setf-function: optional argument
setf-function が持つ mandatory 引数は、新しい値 1 つだけである点に注意してください。2 番目以降の引数は optional です。たとえば Lem editor codebase から:
(defun (setf current-buffer) (buffer)
"Change the current buffer."
(check-type buffer buffer)
(setf *current-buffer* buffer))
この setf-function は global パラメータ (*current-buffer*) を新しい値に設定します。
2 つより多い引数を持つ setf-function も定義できます。
(defun (setf area) (new-area square x y &key log)
(list new-area square x y log))
使ってみます。
(setf (area 'square 1 2 :log t) 9)
Currying
概念
関連する概念に カリー化(currying) があります。関数型言語から来たなら馴染みがあるかもしれません。前の節を読んだ後なら、これはかなり簡単に実装できます。
CL-USER> (defun curry (function &rest args)
(lambda (&rest more-args)
(apply function (append args more-args))))
CURRY
CL-USER> (funcall (curry #'+ 3) 5)
8
CL-USER> (funcall (curry #'+ 3) 6)
9
CL-USER> (setf (symbol-function 'power-of-ten) (curry #'expt 10))
#<Interpreted Function "LAMBDA (FUNCTION &REST ARGS)" {482DB969}>
CL-USER> (power-of-ten 3)
1000
Alexandria ライブラリを使う
やり方がわかったので、Quicklisp にある Alexandria ライブラリの実装を使うありがたみもわかるでしょう。
(ql:quickload "alexandria")
(defun adder (foo bar)
"Add the two arguments."
(+ foo bar))
(defvar add-one (alexandria:curry #'adder 1) "Add 1 to the argument.")
(funcall add-one 10) ;; => 11
(setf (symbol-function 'add-one) add-one)
(add-one 10) ;; => 11
ドキュメント
- function: http://www.lispworks.com/documentation/HyperSpec/Body/t_fn.htm#function
- ordinary lambda list: http://www.lispworks.com/documentation/HyperSpec/Body/03_da.htm
- multiple-value-bind: http://clhs.lisp.se/Body/m_multip.htm
Page source: ja/functions.md