This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

Current and Legacy Option Name Tables

Many option names changed in R2016a. optimset uses only legacy option names. optimoptions accepts both legacy and current names. However, when you set an option using a legacy name-value pair, optimoptions displays the current equivalent value. For example, the legacy TolX option is equivalent to the current StepTolerance option:

options = optimoptions('fsolve','TolX',1e-4)
options = 

  fsolve options:

   Options used by current Algorithm ('trust-region-dogleg'):
   (Other available algorithms: 'levenberg-marquardt', 'trust-region-reflective')

   Set properties:
               StepTolerance: 1.0000e-04

   Default properties:
                   Algorithm: 'trust-region-dogleg'
              CheckGradients: 0
                     Display: 'final'
    FiniteDifferenceStepSize: 'sqrt(eps)'
        FiniteDifferenceType: 'forward'
           FunctionTolerance: 1.0000e-06
      MaxFunctionEvaluations: '100*numberOfVariables'
               MaxIterations: 400
         OptimalityTolerance: 1.0000e-06
                   OutputFcn: []
                     PlotFcn: []
    SpecifyObjectiveGradient: 0
                    TypicalX: 'ones(numberOfVariables,1)'
                 UseParallel: 0

   Show options not used by current Algorithm ('trust-region-dogleg')

These two tables have identical information. One is in alphabetical order by legacy option name, the other is in order by current option name. The tables show values only when the values differ between legacy and current, and show only names that differ or have different values. For changes in Global Optimization Toolbox solvers, see Options Changes in R2016a (Global Optimization Toolbox).

Option Names in Legacy Order

Legacy NameCurrent NameLegacy ValuesCurrent Values
AlwaysHonorConstraintsHonorBounds'bounds', 'none'true, false
BranchingRuleBranchRule  
CutGenMaxIterCutMaxIterations  
DerivativeCheckCheckGradients'on', 'off'true, false
FinDiffRelStepFiniteDifferenceStepSize  
FinDiffTypeFiniteDifferenceType  
GoalsExactAchieveEqualityGoalCount  
GradConstrSpecifyConstraintGradient'on', 'off'true, false
GradObjSpecifyObjectiveGradient'on', 'off'true, false
HessianHessianApproximation'user-supplied', 'bfgs', 'lbfgs', 'fin-diff-grads', 'on', 'off'

'bfgs', 'lbfgs', 'finite-difference'

Ignored when HessianFcn or HessianMultiplyFcn is nonempty.

HessFcnHessianFcn  
HessMultHessianMultiplyFcn  
IPPreprocessIntegerPreprocess  
JacobianSpecifyObjectiveGradient  
JacobMultJacobianMultiplyFcn  
LPMaxIterLPMaxIterations  
MaxFunEvalsMaxFunctionEvaluations  
MaxIterMaxIterations  
MaxNumFeasPointsMaxFeasiblePoints  
MinAbsMaxAbsoluteMaxObjectiveCount  
PlotFcnsPlotFcn  
RelObjThresholdObjectiveImprovementThreshold  
RootLPMaxIterRootLPMaxIterations  
ScaleProblemScaleProblem'obj-and-constr', 'none'true, false
TolConConstraintTolerance  
TolFun (usage 1)OptimalityTolerance  
TolFun (usage 2)FunctionTolerance  
TolFunLPLPOptimalityTolerance  
TolGapAbsAbsoluteGapTolerance  
TolGapRelRelativeGapTolerance  
TolIntegerIntegerTolerance  
TolXStepTolerance  

Option Names in Current Order

Current NameLegacy NameCurrent ValuesLegacy Values
AbsoluteGapToleranceTolGapAbs  
AbsoluteMaxObjectiveCountMinAbsMax  
BranchRuleBranchingRule  
CheckGradientsDerivativeChecktrue, false'on', 'off'
ConstraintToleranceTolCon  
CutMaxIterationsCutGenMaxIter  
EqualityGoalCountGoalsExactAchieve  
FiniteDifferenceStepSizeFinDiffRelStep  
FiniteDifferenceTypeFinDiffType  
FunctionToleranceTolFun (usage 2)  
HessianApproximationHessian

'bfgs', 'lbfgs', 'finite-difference'

Ignored when HessianFcn is nonempty.

'user-supplied', 'bfgs', 'lbfgs', 'fin-diff-grads', 'on', 'off'
HessianFcnHessFcn  
HessianMultiplyFcnHessMult  
HonorBoundsAlwaysHonorConstraintstrue, false'bounds', 'none'
IntegerPreprocessIPPreprocess  
IntegerToleranceTolInteger  
JacobianMultiplyFcnJacobMult  
LPMaxIterationsLPMaxIter  
LPOptimalityToleranceTolFunLP  
MaxFeasiblePointsMaxNumFeasPoints  
MaxFunctionEvaluationsMaxFunEvals  
MaxIterationsMaxIter  
ObjectiveImprovementThresholdRelObjThreshold  
OptimalityToleranceTolFun (usage 1)  
PlotFcnPlotFcns  
RelativeGapToleranceTolGapRel  
RootLPMaxIterationsRootLPMaxIter  
ScaleProblemScaleProblemtrue, false'obj-and-constr', 'none'
SpecifyConstraintGradientGradConstrtrue, false'on', 'off'
SpecifyObjectiveGradientGradObj or Jacobiantrue, false'on', 'off'
StepToleranceTolX  

Related Topics