OptionValue

OptionValue[name]
OptionsPatternでマッチしたオプションの name の値を与える.

OptionValue[f,name]
頭部 f と関連するオプションの name の値を与える.

OptionValue[f,opts,name]
規則 opts の明示的なリストからオプション値を抽出する.

OptionValue[,{name1,name2,}]
複数のオプション値を取り出す.

詳細詳細

  • OptionValue[name]OptionValue[f,name]と等価である.ただし,fOptionValue[name]が現れる変換規則の左辺の頭部である.
  • OptionValue[f,name]OptionValue[name]は,f の引数として現れる最初のOptionsPatternオブジェクトからの値を使う.
  • OptionValue[f,opts,name]では,明示的なリスト optsf からのデフォルトのみが考慮される.
  • OptionValue[f,opts,name]f は,シンボル,規則,あるいはデフォルト値を指定するシンボルと規則のリストでよい.f 中の各シンボル sOptions[s]に等しい.同じオプション名が複数回指定された場合は,最初の指定がデフォルトを決定する.
  • OptionValue[f,opts,name,Hold]は,Holdでラップされたオプション値を返す.
  • OptionValue[Automatic,Automatic,name,Hold]は,オプション値がHoldでラップされて返される点を除いてOptionValue[name]と等価である.
  • OptionValueは,オプション名を比較するときはコンテキストを無視し,シンボル s と文字列SymbolName[s]を互換的に扱う.

例題例題すべて開くすべて閉じる

  (1)  (1)

関数fのデフォルトのオプション値を定義する:

In[1]:=
Click for copyable input

オプションを与えてfを定義する:

In[2]:=
Click for copyable input

fを明示的なオプション設定で使用する:

In[3]:=
Click for copyable input
Out[3]=

オプションがデフォルト値であるとしてf を使う:

In[4]:=
Click for copyable input
Out[4]=
2007年に導入
(6.0)