セルは=NetOf(B2, C2)と読め、B2は1250、C2は0.19、Excelは1012.5を表示します。ワークブックにVBAモジュールもアドインもありません。NetOfの住みかは名前の管理です。テキストがLAMBDA(amount, rate, amount*(1-rate))である定義名です。すべての定義名を範囲か定数として扱うサーバー側の計算エンジンには、ここで呼べるものが何もなく、セルは#NAME?に戻ります
このセルを正しく扱うには、LAMBDAという語を受け付けるパーサーだけでは足りません。クラシックなスプレッドシート評価器が知っている値は5種類、数値、テキスト、ブール値、エラー、そしてそれらを保持するセルへの参照です。LAMBDAは6つ目を追加します。パラメータ名、本体、そして書かれた場所で見えていた名前を運ぶ関数値です。LETは物語のもう半分です。ユーザーはLETでそれらの関数を短いローカル名に束縛し、数トークン先で、しばしば3レベルの深さで呼び出すからです
関数名が解決される3つの場所
HotXLSの数式エンジンが組み込み関数でない名前への呼び出しに出会うと、3つのソースを固定順で試します。1つ目は現在のLETまたはLAMBDAスコープです。fがクロージャを保持するローカル束縛なら、f(21)がそれを適用します。2つ目はテキストがLAMBDAで始まるワークブック定義名で、NetOf(1250, 0.19)は名前の本体をコンパイルして2つの引数に適用します。3つ目は、カスタムDelphi関数のためにすでに使っているかもしれないユーザー関数ハンドラで、HotXLS数式エンジンのカスタム関数で述べています。3つすべてが通って初めて、セルは#NAME?になります
この順序が効いてくる状況が1つあります。同じ綴りのワークブック名に対して、ローカル名は常に勝ちます。ローカル束縛が普通の数値を保持している場合でもです。その場合、定義名の検索は完全に飛ばされ、呼び出しはユーザー関数ハンドラへ直行します。同じ名前のワークブックLAMBDAがその呼び出しで参照されることはありません
Delphi側は短く済みます。名前付き関数はTXLSXDefinedNames.Addで追加する定義名そのものであり、1つの数式の中のクロージャには登録がまったく要りません:
var
Book: TXLSXWorkbook;
Sheet: TXLSXWorksheet;
begin
Book := TXLSXWorkbook.Create;
try
Sheet := Book.Sheets.Add('Model');
// 2引数のAdd=ワークブックスコープ。名前による呼び出しが探すのはここ
Book.DefinedNames.Add('NetOf', 'LAMBDA(amount, rate, amount*(1-rate))');
// 1250 * (1 - 0.19) = 1012.5
Sheet.Cells[2, 2].Formula := 'NetOf(1250, 0.19)';
// 1つの数式の中で束縛して適用するクロージャ:42
Sheet.Cells[3, 2].Formula := 'LET(double, LAMBDA(x, x*2), double(21))';
// bumpはbase = 100を捕捉。bump(5) = 105、step*2 = 210
Sheet.Cells[4, 2].Formula :=
'LET(base, 100, bump, LAMBDA(v, v+base), LET(step, bump(5), step*2))';
// 後置適用、名前なし:42
Sheet.Cells[5, 2].Formula := 'LAMBDA(x, x*2)(21)';
Book.Recalculate;
Book.SaveAs('lambda-model.xlsx');
finally
Book.Free;
end;
end;
最後のセルは人が忘れがちな形式です。ExcelはLAMBDA式の直後に引数リストを書くことで直接適用でき、HotXLSもLAMBDA(x, x*2)(21)を同じ形にパースします。パーサーがこの後置引数リストを受け取るのは、名前、LET式やIF式、別の適用といった、関数を生み出し得るものの後だけです。(1+2)(3)と書くと、評価時ではなくコンパイル時に失敗します
クロージャが覚えているもの、そしてパラメータが勝つ理由
HotXLSでLAMBDA式を評価すると、クロージャ値が生まれます。パラメータ名、本体のコピー、書かれたシート、そしてその瞬間に見えていたすべてのLETまたはLAMBDA束縛のスナップショットです。上の4つ目のセルでは、baseがすでに100に束縛された状態でbumpが生成されるため、クロージャはbase = 100を持ち歩きます。内側のLETの中でbump(5)が走るとき、本体にはその100が見えています。内側のLETはbaseという名前については何も知らないにもかかわらず、です
呼び出しは3段階で進みます。まず引数式が呼び出し側のスコープで評価されます。次に捕捉された環境がプッシュされ、その上にパラメータが積まれ、本体が評価されます。検索は上から下へ行われるため、rateという名前のパラメータはrateという名前の捕捉束縛を隠し、捕捉束縛は呼び出し側がたまたま同じ名前で束縛したものを隠します。本体が返っても失敗しても、スコープは呼び出し開始位置まで切り戻されます
束縛が何も置かれる前に引数を評価するというのは、細部のように聞こえます。LET(x, 10, f, LAMBDA(x, x+1), f(x*2))と書くまでは。引数x*2は外側のxを指さねばならず、20になり、結果は21です。パラメータを先に置くと、引数はこれから定義しようとしているパラメータ自身を読むことになります。ここから出る規則は、Excelユーザーが期待するものです。名前付き関数が計算するものは、その引数と、書かれた時点で捕捉したものだけで決まり、呼び出し側の他のローカル名が漏れ込むことは決してない、と
fが数値を保持しているとき、なぜf(21)は失敗するのか
クロージャ以外を保持するローカル束縛は、関数として適用されることはありません。LET(f, 3, f(21))は3×21を行わず、fという名前のワークブック名にフォールバックすることもありません。呼び出しはユーザー関数ハンドラへ進み、どのハンドラも名前を引き取らなければ、セルは#NAME?で終わります。スプレッドシートにとってこれが正しい結果です。関数呼び出しを黙って掛け算に変えるタイプミスは、誰も疑わないそれらしい数値を生むからです
後置適用はさらに厳密です。引数リストの前に置かれたものは何でも評価され、結果がクロージャでなければセルは#VALUE!を受け取ります。LET(g, 3, (g)(21))とLET(g, 3, g(21))が異なるエラーで失敗するのはそのためです。スクラッチのワークブックで再現できる他の失敗:
- 引数の個数違い:
LET(add, LAMBDA(a, b, a+b), add(1))は引数式が評価される前に#VALUE!を返します - 引数内のエラーは値として旅します:
LET(safe, LAMBDA(x, IFERROR(x, 0)), safe(1/0))では#DIV/0!がxに束縛され、本体の内側にあるIFERRORがそれを0へ変えます - 参照は参照のまま:
A1のような引数はセル参照として本体に届くため、参照の同一性を気にする関数、ISREFなどは、セルの値ではなく参照を見ます - LAMBDA定義は最大253個のパラメータを受け付けます。ExcelがLAMBDAについて文書化している上限と同じです
- 暴走再帰は止まります:自分自身を呼ぶ名前付きラムダは、通常の数式ネストと共通の既定上限256ネストレベルを共有し、超えるとDelphiスタックを枯渇させる代わりにリソース制限エラーで呼び出しが終わります
// Logは独自のログ出力ルーチンで、HotXLSの一部ではない
procedure ProbeLambdaErrors(Sheet: TXLSXWorksheet; Book: TXLSXWorkbook);
begin
Sheet.Cells[2, 4].Formula := 'LET(f, 3, f(21))'; // ハンドラなしでは#NAME?
Sheet.Cells[3, 4].Formula := 'LET(g, 3, (g)(21))'; // #VALUE!、後置
Sheet.Cells[4, 4].Formula := 'LET(add, LAMBDA(a, b, a+b), add(1))'; // #VALUE!、引数個数
Sheet.Cells[5, 4].Formula := 'LET(safe, LAMBDA(x, IFERROR(x, 0)), safe(1/0))'; // 0
Book.Recalculate;
Log(Sheet.Cells[2, 4].FormattedText);
Log(Sheet.Cells[3, 4].FormattedText);
Log(Sheet.Cells[4, 4].FormattedText);
Log(Sheet.Cells[5, 4].FormattedText);
end;
HotXLSのLET束縛:ネストと形状規則
HotXLSはLETを左から右へ評価します。各束縛はそれより前の束縛すべてがスコープに入った状態で評価され、プッシュされ、最後の引数が完全なセットの下で評価されます。だからLET(a, 1, b, a+1, LET(c, b*2, c))は4を返し、内側のLETからaもbも見えます。外側のLETが終わると束縛は消えるため、隣のセルの兄弟数式は空のスコープから始めます
何かが走る前に、2つの形状規則が強制されます。LETは奇数個の引数、少なくとも3つを必要とするため、LET(a, 1)は#VALUE!です。そして名前スロットはすべて素の名前でなければなりません。LET(A1, 5, A1*2)はA1がセル参照なので拒否されます。一方、xやabのような列名としても綴れる短い名前は、LETとLAMBDAの内側ではローカル名として読まれます。範囲への束縛は範囲を保持するため、LET(r, A1:A10, ROWS(r))は10を返し、SUM(r)はセルを合計します
同じクロージャ値が、そのために作られたヘルパー関数、MAP、REDUCE、SCAN、MAKEARRAY、BYROW、BYCOLにも供給されます。MAP(A2:A6, LAMBDA(v, v*2))は2倍された5つの値をスピルし、REDUCE(0, A2:A6, LAMBDA(acc, v, acc+v))はそれらを1つの合計へ折りたたみます。捕捉された環境は直接呼び出しとまったく同じようにそれらの呼び出しにも伝わるため、LETで束縛されたレートはMAPの本体の中からも見えます
カンマ、セミコロン、SaveAsが書くもの
HotXLSの数式パーサーは、カンマとセミコロンを引数区切りとして等価に受け付けます。数式テキストは自分で制御できない場所から届きます。ドイツ語ロケールのマシンで書かれたサポートチケット、Excelの正規のカンマを使うドキュメント、数式文字列を生成するスクリプト、全体をセミコロンで書いていた古いHotXLSコード。SUM(A1,A2)とSUM(A1;A2)は同じものにコンパイルされ、どちらの書き方のLAMBDAも同じです
例外はインライン配列定数です。波括弧の内側では、セミコロンはExcelでの行区切りという意味を保つため、{1,2;3,4}は2×2の配列であって、4引数のリストではありません。引数区切りにセミコロンを使う数式を生成する場合も、配列定数はExcelの構文のままにしておけば、両者が衝突することはありません
Cell.Formulaは代入したテキストをそのまま返します。SaveAsがXLSXファイルを書くとき、波括弧の外で引数区切りに使われたセミコロンはカンマとして書かれます。OOXMLファイル形式が数式をExcelのカンマ構文で保存するためで、Excelが_xlfn.プレフィックス付きで保存する関数には、書き出しの際にそのプレフィックスが付きます。ファイルから読み込んで手を付けていない数式は、元のXMLテキストから書き戻されます
顧客ワークブックから名前付きラムダを読む
Excelで作られたワークブックは、LAMBDA名をExcelが書く形のまま保存します。関数名に_xlfn.プレフィックス、パラメータにはしばしば_xlpm.が付きます。HotXLSは名前を評価するときにこれらのプレフィックスを剥がしますが、TXLSXDefinedName.Formulaは定義テキストをファイルが渡した形のまま返します。Copy(Name.Formula, 1, 6) = 'LAMBDA'という確認は、コードで作った名前には通り、Excelから来た名前はすべて取りこぼします。この食い違いは見逃しやすい。計算値はどちらでも正しく、食い違うのは自分の監査コードだけだからです
// IsLambdaDefinitionは自分で追加するヘルパーで、HotXLSのAPIではない
function IsLambdaDefinition(const Text: WideString): Boolean;
var
S: WideString;
begin
S := UpperCase(Trim(Text));
if (S <> '') and (S[1] = '=') then
Delete(S, 1, 1);
if Copy(S, 1, 6) = '_XLFN.' then
Delete(S, 1, 6);
Result := Copy(S, 1, 7) = 'LAMBDA(';
end;
procedure AuditLambdas(const FileName: string);
var
Book: TXLSXWorkbook;
Name: TXLSXDefinedName;
I: Integer;
begin
// Logは独自のログ出力ルーチン
Book := TXLSXWorkbook.Create;
try
if Book.Open(FileName) = 1 then
begin
for I := 0 to Book.DefinedNames.Count - 1 do
begin
Name := Book.DefinedNames[I];
if IsLambdaDefinition(Name.Formula) and (Name.SheetIndex >= 0) then
Log('Sheet-scoped lambda, not callable by name: ' + Name.Name);
end;
Book.Recalculate;
Log(VarToStr(Book.Sheets[1].Cells[2, 2].Value));
end;
finally
Book.Free;
end;
end;
このループのスコープ確認は、HotXLSの名前による呼び出しが呼び出し先をワークブックレベルの名前の中から探すためのものです。名前付き関数はワークブックスコープに置いてください。シートスコープのLAMBDA名もFindByName(AName, ASheetIndex)で読めますが、複数のシートから呼ばれる関数の所属はワークブックです。背後にあるスコープ規則は定義名とクロスシート数式に整理されています
ラムダの後からの編集は安上がりです。TXLSXDefinedName.Formulaに新しいテキストを代入すると依存グラフが無効化され、次のRecalculateで再構築され、関数を呼び出しているセルが再評価されます。仕組みはインクリメンタル再計算と依存グラフにあります。呼び出しのない=LAMBDA(x, x*2)のように、数式が素のクロージャに評価されるセルは、保存する数値もテキストもないため、キャッシュ値をまったく持ちません。同じセルでExcelは#CALC!を表示します。LAMBDA非対応のツールで開く必要があるレポートには、最後のRecalculateの後にSheet.Cells.ConvertFormulasToValuesで結果を凍結してください。キャッシュ値を残し、数式テキストを落とします
LAMBDA、LET、ヘルパー関数、定義名APIはすべて、ExcelをインストールせずにXLS、XLSX、ODSを読み書きする、同じネイティブのDelphiおよびC++Builderライブラリに同梱されています。数式関数の完全な一覧はHotXLSスプレッドシートコンポーネントのページにあります