CAGE User's Guide

List of Optimization Functions

Methods of cgoptimstore

Type help cgoptimstore/method_name to see online help (where method_name is the name of a function, such as `getDataset').

These methods are available:

Methods of cgptimstore

Task	Command
Evaluate optimization objectives and constraints	evaluate
Grid evaluation of optimization objectives and constraints	gridEvaluate
Evaluate prediction error variance (PEV)	pevEvaluate
Grid evaluation of prediction error variance (PEV)	gridPevEvaluate
Get optimization properties	get
Get values from optimization operating point sets	getDataset
Get the initial free values for the optimization	getInitFreeVal
Get the number of rows in an optimization operating point set	getNumRowsInDataset
Get output information for the optimization	getOutputInfo
Get optimization parameter	getParam
Set the optimal values of the free variables	setFreeVariables
Set output information for the optimization	setOutputInfo

Methods of cgoptimoptions

You use these functions to set up all your optimization settings in the Options section of the file. You can set up any or all of these seven attributes:

• Name
• Description
• Free variables
• Objective functions
• Constraints
• Operating point sets
• Optimization parameters

The following methods are available:

Methods of cgoptimoptions

Task	Command
Add a model constraint to the optimization	addModelConstraint
Add a linear constraint to the optimization	addLinearConstraint
Add a free variable to the optimization	addFreeVariable
Add an objective to the optimization	addObjective
Add an operating point set to the optimization	addOperatingPointSet
Add a parameter to the optimization	addParameter
Get model constraint placeholder information	getModelConstraints
Get linear constraint placeholder information	getLinearConstraints
Return the current usage of constraints	getConstraintsMode
Get the current description for the optimization function	getDescription
Get the current enabled status for the optimization	getEnabled
Return the optimization free variable labels	getFreeVariables
Return the current usage of free variables	getFreeVariablesMode
Get the current name label for the optimization function	getName
Return information about the optimization objectives	getObjectives
Return the current usage of objective functions	getObjectivesMode
Return information about the optimization operating point sets	getOperatingPointSets
Return the current usage of operating point sets	getOperatingPointsMode
Return information about the optimization parameters	getParameters
Set how the optimization constraints are to be used	setConstraintsMode
Provide a description for the optimization function	setDescription
Set the enabled status for this optimization function	setEnabled
Set how the optimization free variables are used	setFreeVariablesMode
Provide a name label for an optimization function	setName
Set how the optimization objective functions are used	setObjectivesMode
Set how the optimization operating point sets are used	setOperatingPointsMode

Optimization Function Reference

Following are the reference pages for all the functions you can use in user-defined optimizations. They are divided into two sections. See the tables above for an overview of all the available functions:

• Methods of cgoptimstore
• Methods of cgoptimoptions

Optimization Template

Alphabetical List of Functions