OptionValue

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

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

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

詳細詳細

  • OptionValue[{opt1->val1,},]はデフォルトのオプション値の明示的な形式を与える.
  • OptionValue[{spec1,spec2,},]は, のどちらかをデフォルトのオプション値の指定として使うことを許す.各頭部はOptions[fi]から得られる規則のリストとして扱われる.
  • OptionValue[f,name]は,f の引数として現れる最初のOptionsPatternオブジェクトをマッチに使う.
  • OptionValue[name]OptionValue[f,name]と等価である.ただし,fOptionValue[name]が現れる変換規則の左辺の頭部である.
  • OptionValue[f,name]OptionValue[name]は常に,まずOptionsPatternについての明示的なマッチによって得られたオプション値を使い,次にOptions[f]で指定されたデフォルト値を使う.
  • OptionValue[f,opts,name,Hold]は,Holdでラップされたオプション値を返す.
  • OptionValue[Automatic,Automatic,name,Hold]は,オプション値がHoldでラップされて返される点を除いてOptionValue[name]と等価である.

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

  (1)  (1)

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

In[1]:=
Click for copyable input

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

In[2]:=
Click for copyable input

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

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

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

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