Named parameter
- 7 min read
- 5 chapters
Related on Lably
Through Computer programming, Parameter (computer programming) and Java (programming language)
Overview
A function call using named parameters differs from a regular function call in that the arguments are passed by associating each one with a parameter name, instead of providing an ordered list of arguments.
For example, consider this Java or C# method call that doesn't use named parameters:
<span id="mwFg"></span><span class="n" id="mwFw">window</span><span class="p" id="mwGA">.</span><span class="na" id="mwGQ">addNewControl</span><span class="p" id="mwGg">(</span><span class="s" id="mwGw">"Title"</span><span class="p" id="mwHA">,</span><span class="w" id="mwHQ"> </span><span class="mi" id="mwHg">20</span><span class="p" id="mwHw">,</span><span class="w" id="mwIA"> </span><span class="mi" id="mwIQ">50</span><span class="p" id="mwIg">,</span><span class="w" id="mwIw"> </span><span class="mi" id="mwJA">100</span><span class="p" id="mwJQ">,</span><span class="w" id="mwJg"> </span><span class="mi" id="mwJw">50</span><span class="p" id="mwKA">,</span><span class="w" id="mwKQ"> </span><span class="kc" id="mwKg">true</span><span class="p" id="mwKw">);</span>
Using named parameters in Python, the call can be written as:
<span id="mwMA"></span><span class="n" id="mwMQ">window</span><span class="o" id="mwMg">.</span><span class="n" id="mwMw">addNewControl</span><span class="p" id="mwNA">(</span><span class="n" id="mwNQ">title</span><span class="o" id="mwNg">=</span><span class="s2" id="mwNw">"Title"</span><span class="p" id="mwOA">,</span> <span class="n" id="mwOQ">xPosition</span><span class="o" id="mwOg">=</span><span class="mi" id="mwOw">20</span><span class="p" id="mwPA">,</span> <span class="n" id="mwPQ">yPosition</span><span class="o" id="mwPg">=</span><span class="mi" id="mwPw">50</span><span class="p" id="mwQA">,</span> <span class="n" id="mwQQ">width</span><span class="o" id="mwQg">=</span><span class="mi" id="mwQw">100</span><span class="p" id="mwRA">,</span> <span class="n" id="mwRQ">height</span><span class="o" id="mwRg">=</span><span class="mi" id="mwRw">50</span><span class="p" id="mwSA">,</span> <span class="n" id="mwSQ">drawingNow</span><span class="o" id="mwSg">=</span><span class="kc" id="mwSw">True</span><span class="p" id="mwTA">)</span>
Using named parameters in PHP, the call can be written as:
<span id="mwUQ"></span><span class="nv" id="mwUg">$window</span><span class="o" id="mwUw">-></span><span class="na" id="mwVA">addNewControl</span><span class="p" id="mwVQ">(</span><span class="nx" id="mwVg">title</span><span class="o" id="mwVw">:</span> <span class="s2" id="mwWA">"Title"</span><span class="p" id="mwWQ">,</span> <span class="nx" id="mwWg">xPosition</span><span class="o" id="mwWw">:</span> <span class="mi" id="mwXA">20</span><span class="p" id="mwXQ">,</span> <span class="nx" id="mwXg">yPosition</span><span class="o" id="mwXw">:</span> <span class="mi" id="mwYA">50</span><span class="p" id="mwYQ">,</span> <span class="nx" id="mwYg">width</span><span class="o" id="mwYw">:</span> <span class="mi" id="mwZA">100</span><span class="p" id="mwZQ">,</span> <span class="nx" id="mwZg">height</span><span class="o" id="mwZw">:</span> <span class="mi" id="mwaA">50</span><span class="p" id="mwaQ">,</span> <span class="nx" id="mwag">drawingNow</span><span class="o" id="mwaw">:</span> <span class="k" id="mwbA">True</span><span class="p" id="mwbQ">);</span>
The version with positional arguments is more implicit. The versions that name parameters are more explicit. Depending on circumstance, a programmer may find one or the other to be easier to read.
Sign in to keep reading
4 more chapters are free with a Lably account.
Use in programming languages
Named parameters are supported explicitly in many languages. A non-exhaustive selection of examples includes Ada, C# 4.0+, Ceylon, ColdFusion Markup Language (CFML), Common Lisp, Fortran, IDL, Kotlin, Mathematica, PL/SQL, PowerShell, Python, R, PHP, Ruby, Scala, Smalltalk, Swift and Visual Basic. Objective-C does not have named parameters (even though parts of the method name may look like named parameters).
In C++, you can achieve named parameters by using designated initializers since C++20, like so:
<span id="mwtA"></span><span class="k" id="mwtQ">struct</span><span class="w" id="mwtg"> </span><span class="nc" id="mwtw">A</span><span class="w" id="mwuA"> </span><span class="p" id="mwuQ">{</span><span class="kt" id="mwug">int</span><span class="w" id="mwuw"> </span><span class="n" id="mwvA">a</span><span class="p" id="mwvQ">{},</span><span class="w" id="mwvg"> </span><span class="kt" id="mwvw">int</span><span class="w" id="mwwA"> </span><span class="n" id="mwwQ">b</span><span class="p" id="mwwg">{}</span><span class="w" id="mwww"> </span><span class="p" id="mwxA">};</span><span class="w" id="mwxQ"> </span> <span class="kt" id="mwxg">void</span> <span class="nf" id="mwxw">foo</span><span class="p" id="mwyA">(</span><span class="n" id="mwyQ">A</span><span class="w" id="mwyg"> </span><span class="n" id="mwyw">bar</span><span class="p" id="mwzA">)</span> <span class="p" id="mwzQ">{</span> <span class="w" id="mwzg"> </span><span class="n" id="mwzw">std</span><span class="o" id="mw0A">::</span><span class="n" id="mw0Q">cout</span><span class="w" id="mw0g"> </span><span class="o" id="mw0w"><<</span><span class="w" id="mw1A"> </span><span class="n" id="mw1Q">bar</span><span class="p" id="mw1g">.</span><span class="n" id="mw1w">a</span><span class="w" id="mw2A"> </span><span class="o" id="mw2Q"><<</span><span class="w" id="mw2g"> </span><span class="n" id="mw2w">bar</span><span class="p" id="mw3A">.</span><span class="n" id="mw3Q">b</span><span class="p" id="mw3g">;</span> <span class="p" id="mw3w">}</span> <span class="n" id="mw4A">foo</span><span class="p" id="mw4Q">({</span><span class="w" id="mw4g"> </span><span class="p" id="mw4w">.</span><span class="n" id="mw5A">a</span><span class="w" id="mw5Q"> </span><span class="o" id="mw5g">=</span><span class="w" id="mw5w"> </span><span class="mi" id="mw6A">1</span><span class="p" id="mw6Q">,</span><span class="w" id="mw6g"> </span><span class="p" id="mw6w">.</span><span class="n" id="mw7A">b</span><span class="w" id="mw7Q"> </span><span class="o" id="mw7g">=</span><span class="w" id="mw7w"> </span><span class="mi" id="mw8A">3</span><span class="w" id="mw8Q"> </span><span class="p" id="mw8g">});</span>Order of parameters
In languages that do not support named parameters, the order of arguments in a function call is necessarily fixed, since it is the only way that the language can identify which argument is intended to be used for which parameter.
With named parameters, it is usually possible to provide the arguments in any order, since the parameter name attached to each argument identifies its purpose. This reduces the connascence between parts of the program. A few languages support named parameters but still require the arguments to be provided in a specific order.
Optional parameters and positional parameters
Named parameters are often used in conjunction with optional parameters. Without named parameters, optional parameters can only appear at the end of the parameter list, since there is no other way to determine which values have been omitted. In languages that support named optional parameters, however, programs may supply any subset of the available parameters, and the names are used to determine which values have been provided.
An added complication arises in languages such as OCaml that support both optional named parameters and partial application. It is impossible in general to distinguish between a function partly applied, and a function to which a subset of parameters have been provided. OCaml resolves this ambiguity by requiring a positional argument after all optional named-parameter arguments: its presence or absence is used to decide if the function has been fully or partly applied. If all parameters are optional, the implementor may solve the issue by adding a dummy positional parameter of type unit.
Emulating
In languages that do not support named parameters, some of the same benefits can be achieved in other ways.
With documentation
Their value as documentation can be replicated by tooltips in integrated development environments (IDEs) for languages such as Java, or with comments (in C):
<span id="mwAQk"></span><span class="n" id="mwAQo">MyFunctionCall</span><span class="p" id="mwAQs">(</span> <span class="w" id="mwAQw"> </span><span class="mi" id="mwAQ0">20</span><span class="p" id="mwAQ4">,</span><span class="w" id="mwAQ8"> </span><span class="cm" id="mwARA">/* x coordinate */</span> <span class="w" id="mwARE"> </span><span class="mi" id="mwARI">50</span><span class="p" id="mwARM">,</span><span class="w" id="mwARQ"> </span><span class="cm" id="mwARU">/* y coordinate */</span> <span class="w" id="mwARY"> </span><span class="mi" id="mwARc">100</span><span class="p" id="mwARg">,</span><span class="w" id="mwARk"> </span><span class="cm" id="mwARo">/* width */</span> <span class="w" id="mwARs"> </span><span class="mi" id="mwARw">5</span><span class="p" id="mwAR0">,</span><span class="w" id="mwAR4"> </span><span class="cm" id="mwAR8">/* height */</span> <span class="w" id="mwASA"> </span><span class="n" id="mwASE">TRUE</span><span class="w" id="mwASI"> </span><span class="cm" id="mwASM">/* drawing now? */</span> <span class="p" id="mwASQ">);</span>
Such comments are not checked for correctness and the order of arguments remains important.
With data structures
Removing the argument order restriction, and the ability to leave some values unspecified, can be achieved by passing a record or associative array.
For example, in JavaScript, these two calls are equivalent:
<span id="mwAS4"></span><span class="nx" id="mwAS8">MyFunctionCall</span><span class="p" id="mwATA">({</span><span class="w" id="mwATE"> </span><span class="nx" id="mwATI">xPosition</span><span class="o" id="mwATM">:</span><span class="w" id="mwATQ"> </span><span class="mf" id="mwATU">20</span><span class="p" id="mwATY">,</span><span class="w" id="mwATc"> </span><span class="nx" id="mwATg">yPosition</span><span class="o" id="mwATk">:</span><span class="w" id="mwATo"> </span><span class="mf" id="mwATs">50</span><span class="p" id="mwATw">,</span><span class="w" id="mwAT0"> </span><span class="nx" id="mwAT4">width</span><span class="o" id="mwAT8">:</span><span class="w" id="mwAUA"> </span><span class="mf" id="mwAUE">100</span><span class="p" id="mwAUI">,</span><span class="w" id="mwAUM"> </span><span class="nx" id="mwAUQ">height</span><span class="o" id="mwAUU">:</span><span class="w" id="mwAUY"> </span><span class="mf" id="mwAUc">5</span><span class="p" id="mwAUg">,</span> <span class="w" id="mwAUk"> </span><span class="nx" id="mwAUo">drawingNow</span><span class="o" id="mwAUs">:</span><span class="w" id="mwAUw"> </span><span class="kc" id="mwAU0">true</span><span class="w" id="mwAU4"> </span><span class="p" id="mwAU8">});</span><span id="mwAVI"></span><span class="nx" id="mwAVM">MyFunctionCall</span><span class="p" id="mwAVQ">({</span><span class="w" id="mwAVU"> </span><span class="nx" id="mwAVY">width</span><span class="o" id="mwAVc">:</span><span class="w" id="mwAVg"> </span><span class="mf" id="mwAVk">100</span><span class="p" id="mwAVo">,</span><span class="w" id="mwAVs"> </span><span class="nx" id="mwAVw">height</span><span class="o" id="mwAV0">:</span><span class="w" id="mwAV4"> </span><span class="mf" id="mwAV8">5</span><span class="p" id="mwAWA">,</span><span class="w" id="mwAWE"> </span><span class="nx" id="mwAWI">xPosition</span><span class="o" id="mwAWM">:</span><span class="w" id="mwAWQ"> </span><span class="mf" id="mwAWU">20</span><span class="p" id="mwAWY">,</span><span class="w" id="mwAWc"> </span><span class="nx" id="mwAWg">yPosition</span><span class="o" id="mwAWk">:</span><span class="w" id="mwAWo"> </span><span class="mf" id="mwAWs">50</span><span class="p" id="mwAWw">,</span> <span class="w" id="mwAW0"> </span><span class="nx" id="mwAW4">drawingNow</span><span class="o" id="mwAW8">:</span><span class="w" id="mwAXA"> </span><span class="kc" id="mwAXE">true</span><span class="w" id="mwAXI"> </span><span class="p" id="mwAXM">});</span>Compare to C99:
<span id="mwAXk"></span><span class="k" id="mwAXo">struct</span><span class="w" id="mwAXs"> </span><span class="nc" id="mwAXw">MyParam</span><span class="w" id="mwAX0"> </span><span class="p" id="mwAX4">{</span> <span class="w" id="mwAX8"> </span><span class="kt" id="mwAYA">int</span><span class="w" id="mwAYE"> </span><span class="n" id="mwAYI">xPosition</span><span class="p" id="mwAYM">;</span> <span class="w" id="mwAYQ"> </span><span class="kt" id="mwAYU">int</span><span class="w" id="mwAYY"> </span><span class="n" id="mwAYc">yPosition</span><span class="p" id="mwAYg">;</span> <span class="w" id="mwAYk"> </span><span class="kt" id="mwAYo">int</span><span class="w" id="mwAYs"> </span><span class="n" id="mwAYw">width</span><span class="p" id="mwAY0">;</span> <span class="w" id="mwAY4"> </span><span class="kt" id="mwAY8">int</span><span class="w" id="mwAZA"> </span><span class="n" id="mwAZE">height</span><span class="p" id="mwAZI">;</span> <span class="w" id="mwAZM"> </span><span class="kt" id="mwAZQ">unsigned</span><span class="w" id="mwAZU"> </span><span class="kt" id="mwAZY">char</span><span class="w" id="mwAZc"> </span><span class="n" id="mwAZg">drawingNow</span><span class="p" id="mwAZk">;</span> <span class="p" id="mwAZo">};</span> <span class="err" id="mwAZs">…</span> <span class="n" id="mwAZw">MyParam</span><span class="w" id="mwAZ0"> </span><span class="n" id="mwAZ4">parameters</span><span class="w" id="mwAZ8"> </span><span class="o" id="mwAaA">=</span><span class="w" id="mwAaE"> </span><span class="p" id="mwAaI">{</span><span class="w" id="mwAaM"> </span><span class="p" id="mwAaQ">.</span><span class="n" id="mwAaU">xPosition</span><span class="w" id="mwAaY"> </span><span class="o" id="mwAac">=</span><span class="w" id="mwAag"> </span><span class="mi" id="mwAak">20</span><span class="p" id="mwAao">,</span><span class="w" id="mwAas"> </span><span class="p" id="mwAaw">.</span><span class="n" id="mwAa0">yPosition</span><span class="w" id="mwAa4"> </span><span class="o" id="mwAa8">=</span><span class="w" id="mwAbA"> </span><span class="mi" id="mwAbE">50</span><span class="p" id="mwAbI">,</span> <span class="w" id="mwAbM"> </span><span class="p" id="mwAbQ">.</span><span class="n" id="mwAbU">width</span><span class="w" id="mwAbY"> </span><span class="o" id="mwAbc">=</span><span class="w" id="mwAbg"> </span><span class="mi" id="mwAbk">100</span><span class="p" id="mwAbo">,</span><span class="w" id="mwAbs"> </span><span class="p" id="mwAbw">.</span><span class="n" id="mwAb0">height</span><span class="w" id="mwAb4"> </span><span class="o" id="mwAb8">=</span><span class="w" id="mwAcA"> </span><span class="mi" id="mwAcE">5</span><span class="p" id="mwAcI">,</span><span class="w" id="mwAcM"> </span><span class="p" id="mwAcQ">.</span><span class="n" id="mwAcU">drawingNow</span><span class="w" id="mwAcY"> </span><span class="o" id="mwAcc">=</span><span class="w" id="mwAcg"> </span><span class="n" id="mwAck">TRUE</span><span class="w" id="mwAco"> </span><span class="p" id="mwAcs">};</span> <span class="n" id="mwAcw">MyFunctionCall</span><span class="p" id="mwAc0">(</span><span class="o" id="mwAc4">&</span><span class="n" id="mwAc8">parameters</span><span class="p" id="mwAdA">);</span>Special Support
In Perl and pre-2.0 Ruby a similar convention exists (generally called a hash or options hash), with special support for omitting the delimiters within function calls. As an example, the core module's Net::FTP new function accepts a hash of optional arguments.
With chained method calls
In object-oriented programming languages, it is possible to use method chaining to simulate named parameters, as a form of fluent interface. Each named-parameter argument is replaced with a method on an "arguments" object that modifies and then returns the object. In C++, this is termed the named parameter idiom. The object may then be passed to a function that uses the arguments it contains.
Method chaining is often used in conjunction with the builder pattern as a way to override default values provided by the builder class.