Annotations for Callable Library (C API) users
CPLEX supports annotations for Benders decomposition in the Callable Library (C API).
In the Callable Library (C API), CPLEX offers these routines to support annotation of
your model:
- CPXXdeldblannotation and CPXdeldblannotation and CPXXdellongannotation and CPXdellongannotation delete an annotation of the specified type from your model.
- CPXXgetdblannotationname and CPXgetdblannotationname and CPXXgetlongannotationname and CPXgetlongannotationname retrieve the name of the annotation of the specified type designated by its index.
- CPXXgetdblannotationindex and CPXgetdblannotationindex and CPXXgetlongannotationindex and CPXgetlongannotationindex retrieve the index of the annotation of the specified type.
- CPXXgetdblannotationdefval and CPXgetdblannotationdefval accesses the default value of an annotation.
- CPXXgetdblannotations and CPXgetdblannotations accesses the values of the annotations of a range of modeling objects in a model.
- CPXXgetlongannotationdefval and CPXgetlongannotationdefval accesses the default value of an annotation.
- CPXXgetlongannotations and CPXgetlongannotations accesses the values of the annotations of a range of modeling objects in a model.
- CPXXgetnumdblannotations and CPXgetnumdblannotations and CPXXgetnumlongannotations and CPXgetnumlongannotations access the number of annotations of the specified type in a model.
-
CPXXnewdblannotation and CPXnewdblannotation creates an
annotation with the specified name for annotating modeling objects with data of type
dbl. -
CPXXnewlongannotation and CPXnewlongannotation creates
an annotation with the specified name for annotating modeling objects with data of type
long. -
CPXXreadcopyannotations and CPXreadcopyannotations reads a
file in the
.annfile format and copies the information of all the annotations contained in that file into a CPLEX problem object. That is, this routine annotates a model with data from a formatted file of annotations. - CPXXsetdblannotations and CPXsetdblannotations sets the annotation values for a set of modeling objects in the CPLEX problem object.
- CPXXsetlongannotations and CPXsetlongannotations sets the annotation values for a set of modeling objects in the CPLEX problem object.
- CPXXwriteannotations and CPXwriteannotations writes all the annotations of a model to a specified file.
- CPXXwritebendersannotation and CPXwritebendersannotation collects the annotations that CPLEX automatically generated for your model and writes those annotations to a formatted file.