WOLFRAM

Wolfram言語 ＆ システムドキュメントセンター

OptionsPattern[]

規則として与えられた一群のオプションを表すパターンオブジェクトである．オプションの値にはOptionValueでアクセスすることができる．

OptionsPattern[f]

Options[f]からデフォルトのオプション値を取る．

OptionsPattern[{opt1val1,opt2val2,…}]

デフォルトのオプション値の明示的なリストを使う．

詳細
Details and Options Details and Options
例題  
例  
スコープ  
アプリケーション  
特性と関係  
考えられる問題  
関連項目
テクニカルノート
関連するガイド
関連するワークフロー
履歴
引用書式

OptionsPattern

OptionsPattern[]

規則として与えられた一群のオプションを表すパターンオブジェクトである．オプションの値にはOptionValueでアクセスすることができる．

OptionsPattern[f]

Options[f]からデフォルトのオプション値を取る．

OptionsPattern[{opt1val1,opt2val2,…}]

デフォルトのオプション値の明示的なリストを使う．

詳細

  • OptionsPatternは，->あるいは:>で指定される，左辺が記号または文字列の，連続する規則あるいはそのネストしたリストの何にでもマッチする．
  • OptionsPattern[{spec1,spec2,…}]において，speciは頭部 fiあるいは明示的な規則 opti->valiのどちらでもよい．それぞれの頭部はOptions[fi]から得られた規則のリストとして並列的に適用される．
  • OptionsPattern[]は最も近くで取り囲んでいる関数のデフォルトオプションを使う．
  • OptionsPattern[{}]はデフォルトオプションを含まない．

例題

すべて開く すべて閉じる

例  (3)

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

Wolfram Language code: Options[f] = {a -> a0, b -> b0};

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

Wolfram Language code: f[x_, OptionsPattern[]] := {x, OptionValue[a]}

明示的なオプション設定でfを使う：

Wolfram Language code: f[7, a -> uuu]

オプションがデフォルト値を持つものとしてfを使う：

Wolfram Language code: f[7]

明示的にOptions[f]を設定することはせずに，この割当てについてデフォルトのオプション値を定義する：

Wolfram Language code: f[x_, OptionsPattern[{a -> a0, b -> b0}]] := {x, OptionValue[a]}
Wolfram Language code: f[7]

Plotのデフォルトのオプション値を取る：

Wolfram Language code: f[x_, OptionsPattern[Plot]] := {OptionValue[AspectRatio], OptionValue[ImageSize]}

Plotのデフォルトを使う：

Wolfram Language code: f[7]

Plotのデフォルトの1つを無効にする：

Wolfram Language code: f[7, ImageSize -> 20]

スコープ  (4)

ArcLengthのオプションを使い，Methodのデフォルト値を無効にする：

Wolfram Language code: f[OptionsPattern[{Method -> "NIntegrate", ArcLength}]] := {OptionValue[Assumptions], OptionValue["Method"]}

明示的なオプション設定が優先される：

Wolfram Language code: f[Assumptions -> c > 0, Method -> "Integrate"]

f はAssumptionsについてはArcLengthと同じデフォルトを使うが，Methodについてはそうではない：

Wolfram Language code: f[]
Wolfram Language code: OptionValue[ArcLength, {Assumptions, Method}]

PlotとPlot3Dの両方からオプションを取る：

Wolfram Language code: f[OptionsPattern[{Plot, Plot3D}]] := {OptionValue[PlotRange], OptionValue[BoxRatios]}

明示的な設定を与える：

Wolfram Language code: f[PlotRange -> All]

共通オプションについては，Plotからデフォルトが継承される：

Wolfram Language code: f[]
Wolfram Language code: Options[Plot, PlotRange]
Wolfram Language code: Options[Plot3D, PlotRange]

関数 g は，共通オプションについてはPlot3Dからデフォルトを継承する：

Wolfram Language code: g[OptionsPattern[{Plot3D, Plot}]] := {OptionValue[PlotRange], OptionValue[BoxRatios]}
Wolfram Language code: g[]

デフォルトオプションなしでOptionsPatternを使う：

Wolfram Language code: f[x_, OptionsPattern[{}]] := OptionValue[a]

明示的なオプション使用が優先される：

Wolfram Language code: f[1, a -> x, b -> y]

オプション中に明示的に存在しない場合はオプション名が返される：

Wolfram Language code: f[7, {b -> y}]

OptionsPatternは，ReplaceAllのような正規のパターンマッチング関数で使うことができる：

Wolfram Language code: f[7, {a -> x, b -> y}] /. f[_, OptionsPattern[{}]] :> OptionValue[a]

アプリケーション  (2)

関数 f についてデフォルトオプションを定義する：

Wolfram Language code: Options[f] = {"Square" -> False}

ヘルパー関数 fCore を使って f を実装してもなお，f からデフォルトが継承される：

Wolfram Language code: f[args___] := fCore[f, args] fCore[f, x_, OptionsPattern[f]] := If[OptionValue["Square"], x ^ 2, x, "BadOptionValue"]

f のデフォルトのオプション値が優先される：

Wolfram Language code: f[2]

明示的なオプション設定が優先される：

Wolfram Language code: f[2, "Square" -> True]

オプションのある2つの関数を定義する：

Wolfram Language code: Options[f] = {a -> 1, b -> 2}; Options[g] = {b -> 3, c -> 4};

両方のオプション集合を使う関数 h は g のデフォルトを優先する：

Wolfram Language code: h[OptionsPattern[{g, f}]] := OptionValue[{a, b, c}]
Wolfram Language code: h[]
Wolfram Language code: h[a -> 10, b -> 7]

特性と関係  (3)

OptionsPatternは任意の規則列または規則のリストとマッチする：

Wolfram Language code: MatchQ[f[a -> 1, b :> 3], f[OptionsPattern[]]]
Wolfram Language code: MatchQ[f[{a -> 1, b :> 3}], f[OptionsPattern[]]]
Wolfram Language code: MatchQ[f[{a -> 1, {b :> 3, {c -> 7}}}], f[OptionsPattern[]]]

空列はOptionsPatternとマッチする：

Wolfram Language code: MatchQ[f[], f[OptionsPattern[]]]

空リストはOptionsPatternとマッチする：

Wolfram Language code: MatchQ[f[{}], f[OptionsPattern[]]]

考えられる問題  (2)

OptionsPatternはオプションの任意の集合とマッチする：

Wolfram Language code: Options[f] = {a -> 1}; f[opts : OptionsPattern[f]] := {opts, OptionValue[a]}

無効なオプションが渡された場合はメッセージが生成される：

Wolfram Language code: f[a -> 1, b -> 2]

FilterRulesを使うと f について有効なオプションのみを使うことができる：

Wolfram Language code: f[opts : OptionsPattern[f]] := {opts, OptionValue[f, FilterRules[Options[f], {opts}], a]}
Wolfram Language code: f[a -> 1, b -> 2]

ネストした任意の空リストはOptionsPatternにマッチする：

Wolfram Language code: MatchQ[f[{}], f[OptionsPattern[]]]
Wolfram Language code: MatchQ[f[{{}}], f[OptionsPattern[]]]
Wolfram Research (2007), OptionsPattern, Wolfram言語関数， https://reference.wolfram.com/language/ref/OptionsPattern.html.

テキスト

Wolfram Research (2007), OptionsPattern, Wolfram言語関数， https://reference.wolfram.com/language/ref/OptionsPattern.html.

CMS

Wolfram Language. 2007. "OptionsPattern." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/OptionsPattern.html.

APA

Wolfram Language. (2007). OptionsPattern. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/OptionsPattern.html

BibTeX

@misc{reference.wolfram_2026_optionspattern, author="Wolfram Research", title="{OptionsPattern}", year="2007", howpublished="\url{https://reference.wolfram.com/language/ref/OptionsPattern.html}", note=[Accessed: 05-August-2026]}

BibLaTeX

@online{reference.wolfram_2026_optionspattern, organization={Wolfram Research}, title={OptionsPattern}, year={2007}, url={https://reference.wolfram.com/language/ref/OptionsPattern.html}, note=[Accessed: 05-August-2026]}