write

Save optimization object description

Description

example

write(obj) saves a description of the optimization object obj in a file named obj.txt. Here, obj is the workspace variable name of the optimization object. If write cannot construct the file name from the expression, it writes the description to WriteOutput.txt instead. write overwrites any existing file. If the object display is small, consider using show instead to output the description at the command line.

example

write(obj,filename) saves a description of obj in a file named filename.

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)

write creates a file named var.txt in 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)

Export the expression to a file named 'VarExpression.txt'.

write(var,"VarExpression.txt")

The VarExpression.txt file contains the same text as var.txt.

Input Arguments

collapse all

Optimization object, specified as one of the following types.

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

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

  • OptimizationExpressionwrite(obj) saves a file containing the optimization expression.

  • OptimizationVariablewrite(obj) saves a file containing the optimization variables. This display does not indicate variable type or bounds, it writes only the variable dimensions and index names (if any).

  • OptimizationConstraintwrite(obj) saves a file containing the constraint expression.

  • OptimizationEqualitywrite(obj) saves a file containing the equality expression.

  • OptimizationInequalitywrite(obj) saves a file containing the inequality expression.

Example: write(obj)

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