CPXXnewdblannotation and CPXnewdblannotation

The routine CPXXnewdblannotation/CPXnewdblannotation creates a new annotation with the specified name for annotating modeling objects with data of type double. By default all modeling objects are annotated with defval.

int CPXXnewdblannotation( CPXCENVptr env, CPXLPptr lp, char const * annotationname_str, double defval )

int CPXnewdblannotation( CPXCENVptr env, CPXLPptr lp, char const * annotationname_str, double defval )

Description

The routine CPXXnewdblannotation/CPXnewdblannotation creates a new annotation in a CPLEX problem object with the specified name for annotating modeling objects with data of type double. An argument to CPXXnewdblannotation/CPXnewdblannotation defines the name of the annotation. Another argument defines the default value with which all modeling objects in CPLEX are implicitly annotated in the new annotation.

This routine for annotations of type double resembles the similar routine CPXXnewlongannotation and CPXnewlongannotation for annotations of type long. The example benders.c distributed with the product shows that routine for type long in use; follow the same steps with the analogous double routines when you create annotations of type double.

For more routines supporting annotations, see Annotating Models in the CPLEX Callable Library (C API) in the reference manual of the CPLEX Callable Library (C API).

Arguments

env: A pointer to the CPLEX environment as returned by CPXXopenCPLEX/CPXopenCPLEX.
lp: A pointer to a CPLEX problem object as returned by CPXXcreateprob/CPXcreateprob.
annotationname_str: A pointer to a character string containing the name of the annotation. Annotation names must be non-NULL and unique.
defval: The default value the new annotation assigns to all modeling objects in the problem instance.

Return

The routine returns 0 (zero) if successful and nonzero if an error occurs.

Example


status = CPXnewdblannotation (env, lp, CPX_BENDERS_ANNOTATION, CPX_BENDERS_MASTERVALUE);