Difference between revisions of "Using Named Parameters"
| Line 3: | Line 3: | ||
<breadcrumbs> Analytica Optimizer Guide > Optimizer Function Reference > {{PAGENAME}}</breadcrumbs> | <breadcrumbs> Analytica Optimizer Guide > Optimizer Function Reference > {{PAGENAME}}</breadcrumbs> | ||
| − | When calling a function in Analytica, you can use the conventional method of listing parameters in their standard sequence, or named-parameter syntax, where you type the parameter name, followed by a colon (:), followed by the parameter value. Here is an example: | + | When calling a function in Analytica, you can use the conventional method of listing parameters in their standard sequence, or named-parameter syntax, where you type the parameter name, in any order, followed by a colon (:), followed by the parameter value. Here is an example: |
:<code>DefineOptimization(</code> | :<code>DefineOptimization(</code> | ||
| Line 10: | Line 10: | ||
::<code>Maximize: x)</code> | ::<code>Maximize: x)</code> | ||
| − | + | If a function, such as [[DefineOptimization]](), has a large number of optional parameters, named-parameters are much more convenient to write and read. So, we use that method in our examples. | |
You can view the full parameter declarations from Analytica, in the actual parameter order, by selecting '''Definition''' >'''Optimizer''' > '''''<function>''''' from the Analytica menu. | You can view the full parameter declarations from Analytica, in the actual parameter order, by selecting '''Definition''' >'''Optimizer''' > '''''<function>''''' from the Analytica menu. | ||
Revision as of 22:05, 30 December 2015
When calling a function in Analytica, you can use the conventional method of listing parameters in their standard sequence, or named-parameter syntax, where you type the parameter name, in any order, followed by a colon (:), followed by the parameter value. Here is an example:
DefineOptimization(Decisions: [d1, d2],Constraints: [c1, c2, c3],Maximize: x)
If a function, such as DefineOptimization(), has a large number of optional parameters, named-parameters are much more convenient to write and read. So, we use that method in our examples.
You can view the full parameter declarations from Analytica, in the actual parameter order, by selecting Definition >Optimizer > <function> from the Analytica menu.
See Also
Comments
Enable comment auto-refresher