ConvertOptions#

class gamspy.ConvertOptions(*, AmplNLBin: bool | None = None, AmplNlInitDual: int | None = None, AmplNlInitPrimal: int | None = None, GDXHessian: bool | None = None, GDXNames: bool | None = None, GDXQuadratic: bool | None = None, GDXUELs: bool | None = None, GAMSInsert: str | None = None, HeaderTimeStamp: bool | None = None, GDXIntervalEval: bool | None = None, GAMSObjVar: str | None = None, PermuteEqus: bool | None = None, PermuteVars: bool | None = None, QExtractAlg: int | None = None, Reform: int | None = None, SkipNRows: int | None = None, Width: int | None = None)[source]#

Options for the conversion of GAMSPy models into different formats.

Attributes:
AmplNLBinOptional[bool]

Enables binary .nl file. False by default.

AmplNlInitDualOptional[int]

Specifies which initial equation marginal values to write to the .nl file.

  • 0: Write no values

  • 1: Write only nondefault values

  • 2: Write all values.

1 by default.

AmplNlInitPrimalOptional[int]

Specifies which initial primal values to write to the .nl file.

  • 0: Write no values

  • 1: Write only nondefault values

  • 2: Write all values.

2 by default.

GDXHessianOptional[bool]

Controls whether Hessian information is included in GDX Jacobian file. False by default.

GDXNamesOptional[bool]

Controls whether variable and equation names are included in GDX Jacobian file. True by default.

GDXQuadraticOptional[bool]

Specifies whether quadratic terms are included in GDX Jacobian file. False by default.

GDXUELsOptional[bool]

Controls whether Universal Element List (UEL) information is included in GDX Jacobian file. True by default.

GAMSInsertOptional[str]

Allows the insertion of custom GAMS code into the model.

HeaderTimeStampOptional[bool]

Specifies a timestamp to include in the header of the output file.

GDXIntervalEvalOptional[bool]

Controls the inclusion of interval evaluation (symbols A_int and e_int) into the GDX Jacobian format. False by default.

GAMSObjVarOptional[str]

Specifies the name of the objective variable in the GAMS scalar model.

PermuteEqusOptional[bool]

Enables or disables the permutation of equations. False by default.

PermuteVarsOptional[bool]

Enables or disables the permutation of variables. False by default.

QExtractAlgOptional[int]

Specifies the algorithm used for quadratic extraction.

  • 0: Automatic

  • 1: ThreePass: Uses a three-pass forward / backward / forward AD technique to compute function / gradient / Hessian values and a hybrid scheme for storage.

  • 2: DoubleForward: Uses forward-mode AD to compute and store function, gradient, and Hessian values at each node or stack level as required. The gradients and Hessians are stored in linked lists.

  • 3: Concurrent: Uses ThreePass and DoubleForward in parallel. As soon as one finishes, the other one stops.

0 by default.

ReformOptional[int]

Controls the reformulation of certain structures in the model. 0: No reformulation, 1: Apply reformulation.

SkipNRowsOptional[int]

Skip constraints of type NONBINDING.

WidthOptional[int]

Sets the width for certain output formats, such as tables or reports.

GAMSInsert: str | None#
GAMSObjVar: str | None#
GDXIntervalEval: bool | None#