View source for Standard libraries/Structured Opt Tools library

[[category:Function libraries]]
== Structured Opt Tools library ==

This library contains functions of use for Structured Optimization models.

Structured optimization functionality requires Analytica Optimizer.

== Using the Library ==

To use these functions in your model, you must add the <code>Structured Optimization Tools.ana</code> library to your model. To add, select [[File menu|File]] &rarr; '''Add Library...''' and find the <code>Structured Optimization Tools.ana</code> file. After selecting, you should select linked. Once added, the library appears on your definition menu and the functions may be used.

== Functions in library ==

=== Function Set_Decisions_To_Opt( optdef ) ===

;Identifier: Set_Decisions_To_Opt
;Title: Set Decisions To Opt
;Parameter declaration: (optdef : Optimization orNull)
;Description:
::Sets the definitions of all the decisions that appear in an Optimization to their optimal solution. This must be called from a Button Script. The parameter, «optdef», must be a variable defined by a call to DefineOptimization.
::This does not preserve the original definitions - see Use_opt_decisions for that.
::This must be run from a button script.

=== Function Use_Opt_Decisions( optdef ) ===

;Identifier: Use_Opt_Decisions
;Title: Use Opt Decisions
;Parameter declaration: (optdef : Optimization orNull)
;Description:
::This preserves the original definition (in the event that it isn't already preserved) for each decision node, and then sets each decision to its optimized value.
::This must be used from a button script.
::Optdef must be the variable that is defined using DefineOptimization.

=== Function Restore_Decision_Def( optdef ) ===

;Identifier: Restore_Decision_Def
;Title: Restore Decision Defs
;Parameter declaration: (optdef : Variable)
;Description:
::This restores all the decisions to their original definitions, after they have previous been set to optimized values with the Use_opt_decisions function.
::This must be used from a button script.

== See also ==

* [[Standard libraries]]