optim.coder.infbound

Infinite bound support for code generation

Since R2022b

Syntax

bnd = optim.coder.infbound

bnd = optim.coder.infbound(sz)

bnd = optim.coder.infbound(n1,n2,...,nt)

Description

bnd = optim.coder.infbound creates an infinite bound for use in code generation. bnd represents an infinite bound for code generation targets that do not support Inf.

bnd = optim.coder.infbound(sz) returns an infinite bound array of the same size as the argument sz. If sz is a scalar, the size of the returned array is sz-by-sz.

bnd = optim.coder.infbound(n1,n2,...,nt) returns an infinite bound array of size n1-by-n2-by-...-by-nt for the scalar values n1, n2,…,nt.

Examples

Create Infinite Bounds for Code Generation

Target hardware for code generation does not always accept Inf or –Inf as a bound. In this case, use optim.coder.infbound to represent the infinite bounds.

For example, suppose your problem has upper bounds of [Inf,1,10], meaning x(2) <= 1 and x(3) <= 10, and no upper bound on x(1). The problem also has lower bounds of [0,–Inf,0], meaning x(1) >= 0 and x(3) >= 0, and no lower bound on x(2). You can represent these bounds in several ways.

ub1 = [optim.coder.infbound 1 10]

ub1 = 1×3

   Inf     1    10

lb1 = [0 -optim.coder.infbound 0]

lb1 = 1×3

     0  -Inf     0

% Or
ub = optim.coder.infbound(1,3);
ub(2) = 1;
ub(3) = 10

ub = 1×3

   Inf     1    10

lb = -optim.coder.infbound([1,3]);
lb(1) = 0;
lb(3) = 0

lb = 1×3

     0  -Inf     0

These results are produced from running the code in MATLAB®, and show the MATLAB Inf output. When you run optim.coder.infbound for code generation, the resulting bounds are appropriate for the target hardware.

Input Arguments

sz — Size of returned Inf array

vector of positive integers

Size of the returned Inf array, specified as a vector of positive integers. Generally, the size of the returned array is sz(1)-by-sz(2)-by-...-by-sz(t), where t is the number of components of sz. However, if sz is a scalar, the size of the returned array is sz-by-sz.

Example: [2,3,1,4]

Data Types: double

n — Size of Inf array component

positive integer

Size of an Inf array component, specified as a positive integer.

Example: 2

Data Types: double

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

Code generation for Optimization Toolbox™ solvers is subject to the requirements noted in Code Generation in fmincon Background, Code Generation for quadprog Background, Code Generation in Linear Least Squares: Background, and Code Generation in Nonlinear Least Squares: Background. In particular:

• Solvers support code generation using either the codegen (MATLAB Coder) function or the MATLAB^® Coder™ app. You must have a MATLAB Coder license to generate code.

• The target hardware must support standard double-precision floating-point computations. You cannot generate code for single-precision or fixed-point computations.

• For lsqlin, the lb and ub arguments must have the same number of entries as the number of columns in C or must be empty []. Otherwise, the lb and ub arguments must have the same number of entries as the x0 argument or must be empty [].

Version History

Introduced in R2022b