Main Content

write

Save optimization object description

Description

Usewriteto save the description of an optimization object.

example

write(obj)saves a description of the optimization objectobjin a file namedobj.txt. Here,objis the workspace variable name of the optimization object. Ifwritecannot construct the file name from the expression, it writes the description toWriteOutput.txtinstead.writeoverwrites any existing file. If the object description is small, consider usingshowinstead to display the description at the command line.

example

write(obj,filename)saves a description ofobjin a file namedfilename.

Examples

collapse all

Create an optimization variable and an expression that uses the variable. Save a description of the expression to a file.

x = optimvar('x',3,3); A = magic(3); var = sum(sum(A.*x)); write(var)

writecreates a file namedvar.txtin the current folder. The file contains the following text:

8*x(1, 1) + 3*x(2, 1) + 4*x(3, 1) + x(1, 2) + 5*x(2, 2) + 9*x(3, 2) + 6*x(1, 3) + 7*x(2, 3) + 2*x(3, 3)

Save the expression in a file named'VarExpression.txt'in the current folder.

write(var,"VarExpression.txt")

TheVarExpression.txtfile contains the same text asvar.txt.

Input Arguments

collapse all

Optimization object, specified as one of the following:

  • OptimizationProblemobject —write(obj)saves a file containing the variables for the solution, objective function, constraints, and variable bounds.

  • EquationProblemobject —write(obj)saves a file containing the variables for the solution, equations for the solution, and variable bounds.

  • OptimizationExpressionobject —write(obj)saves a file containing the optimization expression.

  • OptimizationVariableobject —write(obj)saves a file containing the optimization variables. The saved description does not indicate variable types or bounds; it includes only the variable dimensions and index names (if any).

  • OptimizationConstraintobject —write(obj)saves a file containing the constraint expression.

  • OptimizationEqualityobject —write(obj)saves a file containing the equality expression.

  • OptimizationInequalityobject —write(obj)saves a file containing the inequality expression.

Path to the file, specified as a string or character vector. The path is relative to the current folder. The resulting file is a text file, so the file name typically has the extension.txt.

Example:"../Notes/steel_stuff.txt"

Data Types:char|string

版本历史

Introduced in R2019b