mpcqpsolverOptions

(To be removed) Create default option set for mpcqpsolver

mpcqpsolverOptions will be removed in a future release. Use mpcActiveSetOptions instead. For more information, see Compatibility Considerations.

Syntax

options = mpcqpsolverOptions

options = mpcqpsolverOptions(type)

Description

options = mpcqpsolverOptions creates a structure of default options for mpcqpsolver, which solves a quadratic programming (QP) problem using the KWIK algorithm.

options = mpcqpsolverOptions(type) creates a default option set using the specified input data type. All real options are specified using this data type.

Examples

Create Default Option Set for MPC QP Solver

opt = mpcqpsolverOptions;

Create and Modify Default MPC QP Solver Option Set

Create default option set.

opt = mpcqpsolverOptions;

Specify the maximum number of iterations allowed during computation.

opt.MaxIter = 100;

Specify a feasibility tolerance for verifying that the optimal solution satisfies the inequality constraints.

opt.FeasibilityTol = 1.0e-3;

Create Option Set Specifying Input Argument Type

opt = mpcqpsolverOptions('single');

Input Arguments

type — MPC QP solver input argument data type

'double' (default) | 'single'

MPC QP solver input argument data type, specified as either 'double' or 'single'. This data type is used for both simulation and code generation. All real options in the option set are specified using this data type, and all real input arguments to mpcqpsolver must match this type.

Output Arguments

options — Option set for mpcqpsolver

structure

Option set for mpcqpsolver, returned as a structure with the following fields:

Field	Description	Default
DataType	Input argument data type, specified as either 'double' or 'single'. This data type is used for both simulation and code generation, and all real input arguments to mpcqpsolver must match this type.	'double'
MaxIter	Maximum number of iterations allowed when computing the QP solution, specified as a positive integer.	200
FeasibilityTol	Tolerance used to verify that inequality constraints are satisfied by the optimal solution, specified as a positive scalar. A larger FeasibilityTol value allows for larger constraint violations.	1.0e-6
IntegrityChecks	Indicator of whether integrity checks are performed on the mpcqpsolver input data, specified as a logical value. If IntegrityChecks is true, then integrity checks are performed and diagnostic messages are displayed. Use false for code generation only.	true

Version History

Introduced in R2015b

R2020a: mpcqpsolverOptions will be removed

Warns starting in R2020a

mpcqpsolverOptions will be removed in a future release. Use mpcActiveSetOptions instead. There are differences between these functions that require updates to your code.

Update Code

To update your code:

• Change the function name from mpcqpsolverOptions to mpcActiveSetOptions. The syntaxes are equivalent.

• Some field names of the returned structure have changed. The default field values are the same. This table shows the new property names.

  Previous Property Name	New Property Name
  MaxIter	MaxIterations
  FeasibilityTol	ConstraintTolerance

• The returned structure of mpcActiveSetOptions contains the new field UseHessianAsInput. To continue to use the inverse of the lower-triangular decomposition of the Hessian matrix with mpcActiveSetSolver, you must set UseHessianAsInput to false.

For syntax examples showing how to update your code, see mpcqpsolver.