OptimizationVariable

Variable for optimization

expand all in page

Description

An OptimizationVariable object contains variables for optimization expressions. These expressions represent the objective function or constraints. Variables are symbolic in nature, and can be arrays of any size.

Creation

Create an OptimizationVariable object using optimvar.

Properties

expand all

Array-Wide Properties

This property is read-only.

Variable name, specified as a string or character vector.

Name gives the variable label to be displayed, such as in showbounds, showconstr, showexpr, showproblem, or showvar. Name also gives the field names in the solution structure that solve returns.

Tip

To avoid confusion, set name to be the MATLAB® variable name. For example,

metal = optimvar('metal')

Data Types: char | string

Variable type, specified as 'continuous' or 'integer'.

  • 'continuous' – Real values

  • 'integer' – Integer values

The variable type applies to all variables in the array. To have multiple variable types, create multiple variables.

Tip

To specify a binary variable, use the 'integer' type and specify LowerBound = 0 and UpperBound = 1.

Data Types: char | string

Index names, specified as a cell array of strings or character vectors. For information on using index names, see Named Index for Optimization Variables.

Data Types: cell

This property is read-only.

Indication that the variable is a reference, returned as true when the variable is a reference to another variable, or false when the variable is not a reference. When IsReference is true, you cannot specify any of the array-wide properties of the variable. See Tips.

Example: y = x(2:2:end) creates y as a reference variable containing the even elements of x.

Data Types: logical

Element-wise Properties

Lower bound, specified as a real scalar or as a real array having the same dimensions as the OptimizationVariable object. Scalar values apply to all elements of the variable.

The LowerBound property is always displayed as an array. However, you can set the property as a scalar that applies to all elements. For example,

var.LowerBound = 0

Data Types: double

Upper bound, specified as a real scalar or as a real array having the same dimensions as the OptimizationVariable object. Scalar values apply to all elements of the variable.

The UpperBound property is always displayed as an array. However, you can set the property as a scalar that applies to all elements. For example

var.UpperBound = 1

Data Types: double

Object Functions

showboundsDisplay variable bounds
showvarDisplay optimization variable
writeboundsSave description of variable bounds
writevarSave optimization variable description

Examples

expand all

Open Script

Create a scalar optimization variable named dollars.

dollars = optimvar('dollars')

dollars = 

  OptimizationVariable with properties:

          Name: 'dollars'
          Type: 'continuous'
    IndexNames: {{}  {}}
    LowerBound: -Inf
    UpperBound: Inf

  See variables with showvar.
  See bounds with showbounds.
Open Script

Create a 3-by-1 optimization variable vector named x.

x = optimvar('x',3)

x = 

  3x1 OptimizationVariable array with properties:

  Array-wide properties:
          Name: 'x'
          Type: 'continuous'
    IndexNames: {{}  {}}

  Elementwise properties:
    LowerBound: [3x1 double]
    UpperBound: [3x1 double]

  See variables with showvar.
  See bounds with showbounds.
Open Script

Create an integer optimization variable vector named bolts that is indexed by the strings "brass", "stainless", and "galvanized". Use the indices of bolts to create an optimization expression, and experiment with creating bolts using character arrays or in a different orientation.

Create bolts using strings in a row orientation.

bnames = ["brass","stainless","galvanized"];
bolts = optimvar('bolts',bnames,'Type','integer')

bolts = 

  1×3 OptimizationVariable array with properties:

  Array-wide properties:
          Name: 'bolts'
          Type: 'integer'
      IsSubset: 0
    IndexNames: {{}  {1×3 cell}}

  Elementwise properties:
    LowerBound: [-Inf -Inf -Inf]
    UpperBound: [Inf Inf Inf]

  See variables with showvar.
  See bounds with showbounds.

Create an optimization expression using the string indices.

y = bolts("brass") + 2*bolts("stainless") + 4*bolts("galvanized")

y = 

OptimizationExpression

    bolts(1, 'brass') + 2*bolts(1, 'stainless') + 4*bolts(1, 'galvanized')

Use a cell array of character vectors instead of strings to get a variable with the same indices as before.

bnames = {'brass','stainless','galvanized'};
bolts = optimvar('bolts',bnames,'Type','integer')

bolts = 

  1×3 OptimizationVariable array with properties:

  Array-wide properties:
          Name: 'bolts'
          Type: 'integer'
      IsSubset: 0
    IndexNames: {{}  {1×3 cell}}

  Elementwise properties:
    LowerBound: [-Inf -Inf -Inf]
    UpperBound: [Inf Inf Inf]

  See variables with showvar.
  See bounds with showbounds.

Use a column-oriented version of bnames, 3-by-1 instead of 1-by-3, and observe that bolts has that orientation as well.

bnames = ["brass";"stainless";"galvanized"];
bolts = optimvar('bolts',bnames,'Type','integer')

bolts = 

  3×1 OptimizationVariable array with properties:

  Array-wide properties:
          Name: 'bolts'
          Type: 'integer'
      IsSubset: 0
    IndexNames: {{1×3 cell}  {}}

  Elementwise properties:
    LowerBound: [3×1 double]
    UpperBound: [3×1 double]

  See variables with showvar.
  See bounds with showbounds.
Open Script

Create a 3-by-4-by-2 array of optimization variables named xarray.

xarray = optimvar('xarray',3,4,2)

xarray = 

  3×4×2 OptimizationVariable array with properties:

  Array-wide properties:
          Name: 'xarray'
          Type: 'continuous'
      IsSubset: 0
    IndexNames: {{}  {}  {}}

  Elementwise properties:
    LowerBound: [3×4×2 double]
    UpperBound: [3×4×2 double]

  See variables with showvar.
  See bounds with showbounds.

You can also create multidimensional variables indexed by a mixture of names and numeric indices. For example, create a 3-by-4 array of optimization variables where the first dimension is indexed by the strings 'brass', 'stainless', and 'galvanized', and the second dimension is numerically indexed.

bnames = ["brass","stainless","galvanized"];
bolts = optimvar('bolts',bnames,4)

bolts = 

  3×4 OptimizationVariable array with properties:

  Array-wide properties:
          Name: 'bolts'
          Type: 'continuous'
      IsSubset: 0
    IndexNames: {{1×3 cell}  {}}

  Elementwise properties:
    LowerBound: [3×4 double]
    UpperBound: [3×4 double]

  See variables with showvar.
  See bounds with showbounds.
Open Script

Create an optimization variable named x of size 3-by-3-by-3 that represents binary variables.

x = optimvar('x',3,3,3,'Type','integer','LowerBound',0,'UpperBound',1)

x = 

  3x3x3 OptimizationVariable array with properties:

  Array-wide properties:
          Name: 'x'
          Type: 'integer'
    IndexNames: {{}  {}  {}}

  Elementwise properties:
    LowerBound: [3x3x3 double]
    UpperBound: [3x3x3 double]

  See variables with showvar.
  See bounds with showbounds.

Definitions

expand all

Tips

  • OptimizationVariable objects have handle copy behavior. See Handle Object Behavior (MATLAB) and Comparison of Handle and Value Classes (MATLAB). Handle copy behavior means that a copy of an OptimizationVariable points to the original and does not have an independent existence. For example, create a variable x, copy it to y, then set a property of y. Note that x takes on the new property value.

    x = optimvar('x','LowerBound',1);
y = x;
y.LowerBound = 0;
showbounds(x)
        0 <= x

See Also

| | |

Topics

Introduced in R2017b

Was this topic helpful?
Optimization Toolbox Documentation
Other Documentation
Support