SCIP Doxygen Documentation
Loading...
Searching...
No Matches
scip_validation.h
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-2024 Zuse Institute Berlin (ZIB) */
7
/* */
8
/* Licensed under the Apache License, Version 2.0 (the "License"); */
9
/* you may not use this file except in compliance with the License. */
10
/* You may obtain a copy of the License at */
11
/* */
12
/* http://www.apache.org/licenses/LICENSE-2.0 */
13
/* */
14
/* Unless required by applicable law or agreed to in writing, software */
15
/* distributed under the License is distributed on an "AS IS" BASIS, */
16
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17
/* See the License for the specific language governing permissions and */
18
/* limitations under the License. */
19
/* */
20
/* You should have received a copy of the Apache-2.0 license */
21
/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22
/* */
23
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24
25
/**@file scip_validation.h
26
* @ingroup PUBLICCOREAPI
27
* @brief public methods for validation
28
* @author Tobias Achterberg
29
* @author Timo Berthold
30
* @author Thorsten Koch
31
* @author Alexander Martin
32
* @author Marc Pfetsch
33
* @author Kati Wolter
34
* @author Gregor Hendel
35
* @author Leona Gottwald
36
*/
37
38
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
39
40
#ifndef __SCIP_SCIP_VALIDATION_H__
41
#define __SCIP_SCIP_VALIDATION_H__
42
43
44
#include "
scip/def.h
"
45
#include "
scip/type_retcode.h
"
46
#include "
scip/type_scip.h
"
47
48
#ifdef __cplusplus
49
extern
"C"
{
50
#endif
51
52
/**@addtogroup PublicValidationMethods
53
*
54
* @{
55
*/
56
57
/** validate the result of the solve
58
*
59
* the validation includes
60
*
61
* - checking the feasibility of the incumbent solution in the original problem (using SCIPcheckSolOrig())
62
*
63
* - checking if the objective bounds computed by SCIP agree with external primal and dual reference bounds.
64
*
65
* All external reference bounds the original problem space and the original objective sense.
66
*
67
* For infeasible problems, +/-SCIPinfinity() should be passed as reference bounds depending on the objective sense
68
* of the original problem.
69
*/
70
SCIP_EXPORT
71
SCIP_RETCODE
SCIPvalidateSolve
(
72
SCIP
*
scip
,
/**< SCIP data structure */
73
SCIP_Real
primalreference,
/**< external primal reference value for the problem, or SCIP_UNKNOWN */
74
SCIP_Real
dualreference,
/**< external dual reference value for the problem, or SCIP_UNKNOWN */
75
SCIP_Real
reftol,
/**< relative tolerance for acceptable violation of reference values */
76
SCIP_Bool
quiet,
/**< TRUE if no status line should be printed */
77
SCIP_Bool
* feasible,
/**< pointer to store if the best solution is feasible in the original problem,
78
* or NULL */
79
SCIP_Bool
* primalboundcheck,
/**< pointer to store if the primal bound respects the given dual reference
80
* value, or NULL */
81
SCIP_Bool
* dualboundcheck
/**< pointer to store if the dual bound respects the given primal reference
82
* value, or NULL */
83
);
84
85
/**@} */
86
87
#ifdef __cplusplus
88
}
89
#endif
90
91
#endif
def.h
common defines and data types used in all packages of SCIP
SCIP_Bool
#define SCIP_Bool
Definition
def.h:91
SCIP_Real
#define SCIP_Real
Definition
def.h:172
SCIPvalidateSolve
SCIP_RETCODE SCIPvalidateSolve(SCIP *scip, SCIP_Real primalreference, SCIP_Real dualreference, SCIP_Real reftol, SCIP_Bool quiet, SCIP_Bool *feasible, SCIP_Bool *primalboundcheck, SCIP_Bool *dualboundcheck)
Definition
scip_validation.c:69
scip
Definition
objbenders.h:44
type_retcode.h
type definitions for return codes for SCIP methods
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition
type_retcode.h:63
type_scip.h
type definitions for SCIP's main datastructure
SCIP
struct Scip SCIP
Definition
type_scip.h:39
scip_validation.h
© 2002-2024 by Zuse Institute Berlin (ZIB),
Imprint
Generated by
1.13.2