Scippy

SCIP

Solving Constraint Integer Programs

exprinterpret_none.c
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2014 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not email to scip@zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file exprinterpret_none.c
17  * @brief function definitions for nonexisting expression interpreter to resolve linking references
18  * @ingroup EXPRINTS
19  * @author Stefan Vigerske
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #include "scip/pub_message.h"
25 #include "nlpi/exprinterpret.h"
26 
27 struct SCIP_ExprInt
28 {
29  char dummy; /*lint !e830*/
30 };
31 
32 /** gets name and version of expression interpreter */
33 const char* SCIPexprintGetName(
34  void
35  )
36 {
37  return "NONE";
38 } /*lint !e715*/
39 
40 /** gets descriptive text of expression interpreter */
41 const char* SCIPexprintGetDesc(
42  void
43  )
44 {
45  return "dummy expression interpreter which solely purpose it is to resolve linking symbols";
46 } /*lint !e715*/
47 
48 /** gets capabilities of expression interpreter (using bitflags) */
49 SCIP_EXPRINTCAPABILITY SCIPexprintGetCapability(
50  void
51  )
52 {
53  return SCIP_EXPRINTCAPABILITY_NONE;
54 } /*lint !e715*/
55 
56 /** creates an expression interpreter object */
57 SCIP_RETCODE SCIPexprintCreate(
58  BMS_BLKMEM* blkmem, /**< block memory data structure */
59  SCIP_EXPRINT** exprint /**< buffer to store pointer to expression interpreter */
60  )
61 {
62  SCIPdebugMessage("SCIPexprintCreate()\n");
63  SCIPdebugMessage("Note that there is no expression interpreter linked to the binary.\n");
64 
65  SCIP_ALLOC( BMSallocMemory(exprint) );
66 
67  return SCIP_OKAY;
68 } /*lint !e715*/
69 
70 /** frees an expression interpreter object */
71 SCIP_RETCODE SCIPexprintFree(
72  SCIP_EXPRINT** exprint /**< expression interpreter that should be freed */
73  )
74 {
75  BMSfreeMemory(exprint);
76 
77  return SCIP_OKAY;
78 } /*lint !e715*/
79 
80 /** compiles an expression tree and stores compiled data in expression tree */
81 SCIP_RETCODE SCIPexprintCompile(
82  SCIP_EXPRINT* exprint, /**< interpreter data structure */
83  SCIP_EXPRTREE* tree /**< expression tree */
84  )
85 {
86  return SCIP_OKAY;
87 } /*lint !e715*/
88 
89 /** frees interpreter data */
90 SCIP_RETCODE SCIPexprintFreeData(
91  SCIP_EXPRINTDATA** interpreterdata /**< interpreter data that should freed */
92  )
93 {
94  assert(interpreterdata != NULL);
95  assert(*interpreterdata == NULL);
96 
97  return SCIP_OKAY;
98 } /*lint !e715*/
99 
100 /** notify expression interpreter that a new parameterization is used
101  * this probably causes retaping by AD algorithms
102  */
103 SCIP_RETCODE SCIPexprintNewParametrization(
104  SCIP_EXPRINT* exprint, /**< interpreter data structure */
105  SCIP_EXPRTREE* tree /**< expression tree */
106  )
107 {
108  return SCIP_OKAY;
109 } /*lint !e715*/
110 
111 /** evaluates an expression tree */
112 SCIP_RETCODE SCIPexprintEval(
113  SCIP_EXPRINT* exprint, /**< interpreter data structure */
114  SCIP_EXPRTREE* tree, /**< expression tree */
115  SCIP_Real* varvals, /**< values of variables */
116  SCIP_Real* val /**< buffer to store value */
117  )
118 {
119  SCIPerrorMessage("No expression interpreter linked to SCIP, try recompiling with EXPRINT=cppad.\n");
120  return SCIP_PLUGINNOTFOUND;
121 } /*lint !e715*/
122 
123 /** evaluates an expression tree on intervals */
124 SCIP_RETCODE SCIPexprintEvalInt(
125  SCIP_EXPRINT* exprint, /**< interpreter data structure */
126  SCIP_EXPRTREE* tree, /**< expression tree */
127  SCIP_Real infinity, /**< value for infinity */
128  SCIP_INTERVAL* varvals, /**< interval values of variables */
129  SCIP_INTERVAL* val /**< buffer to store interval value of expression */
130  )
131 {
132  SCIPerrorMessage("No expression interpreter linked to SCIP, try recompiling with EXPRINT=cppad.\n");
133  return SCIP_PLUGINNOTFOUND;
134 } /*lint !e715*/
135 
136 /** computes value and gradient of an expression tree */
137 SCIP_RETCODE SCIPexprintGrad(
138  SCIP_EXPRINT* exprint, /**< interpreter data structure */
139  SCIP_EXPRTREE* tree, /**< expression tree */
140  SCIP_Real* varvals, /**< values of variables, can be NULL if new_varvals is FALSE */
141  SCIP_Bool new_varvals, /**< have variable values changed since last call to a point evaluation routine? */
142  SCIP_Real* val, /**< buffer to store expression value */
143  SCIP_Real* gradient /**< buffer to store expression gradient, need to have length at least SCIPexprtreeGetNVars(tree) */
144  )
145 {
146  SCIPerrorMessage("No expression interpreter linked to SCIP, try recompiling with EXPRINT=cppad.\n");
147  return SCIP_PLUGINNOTFOUND;
148 } /*lint !e715*/
149 
150 /** computes interval value and interval gradient of an expression tree */
151 SCIP_RETCODE SCIPexprintGradInt(
152  SCIP_EXPRINT* exprint, /**< interpreter data structure */
153  SCIP_EXPRTREE* tree, /**< expression tree */
154  SCIP_Real infinity, /**< value for infinity */
155  SCIP_INTERVAL* varvals, /**< interval values of variables, can be NULL if new_varvals is FALSE */
156  SCIP_Bool new_varvals, /**< have variable interval values changed since last call to an interval evaluation routine? */
157  SCIP_INTERVAL* val, /**< buffer to store expression interval value */
158  SCIP_INTERVAL* gradient /**< buffer to store expression interval gradient, need to have length at least SCIPexprtreeGetNVars(tree) */
159  )
160 {
161  SCIPerrorMessage("No expression interpreter linked to SCIP, try recompiling with EXPRINT=cppad.\n");
162  return SCIP_PLUGINNOTFOUND;
163 } /*lint !e715*/
164 
165 /** gives sparsity pattern of hessian
166  * NOTE: this function might be replaced later by something nicer
167  * Since the AD code might need to do a forward sweep, you should pass variable values in here.
168  */
169 SCIP_RETCODE SCIPexprintHessianSparsityDense(
170  SCIP_EXPRINT* exprint, /**< interpreter data structure */
171  SCIP_EXPRTREE* tree, /**< expression tree */
172  SCIP_Real* varvals, /**< values of variables */
173  SCIP_Bool* sparsity /**< buffer to store sparsity pattern of Hessian, sparsity[i+n*j] indicates whether entry (i,j) is nonzero in the hessian */
174  )
175 {
176  SCIPerrorMessage("No expression interpreter linked to SCIP, try recompiling with EXPRINT=cppad.\n");
177  return SCIP_PLUGINNOTFOUND;
178 } /*lint !e715*/
179 
180 /** computes value and dense hessian of an expression tree
181  * the full hessian is computed (lower left and upper right triangle)
182  */
183 SCIP_RETCODE SCIPexprintHessianDense(
184  SCIP_EXPRINT* exprint, /**< interpreter data structure */
185  SCIP_EXPRTREE* tree, /**< expression tree */
186  SCIP_Real* varvals, /**< values of variables, can be NULL if new_varvals is FALSE */
187  SCIP_Bool new_varvals, /**< have variable values changed since last call to an evaluation routine? */
188  SCIP_Real* val, /**< buffer to store function value */
189  SCIP_Real* hessian /**< buffer to store hessian values, need to have size at least n*n */
190  )
191 {
192  SCIPerrorMessage("No expression interpreter linked to SCIP, try recompiling with EXPRINT=cppad.\n");
193  return SCIP_PLUGINNOTFOUND;
194 } /*lint !e715*/
195