Scippy

SCIP

Solving Constraint Integer Programs

type_misc.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-2015 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 type_misc.h
17  * @ingroup TYPEDEFINITIONS
18  * @brief type definitions for miscellaneous datastructures
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_TYPE_MISC_H__
25 #define __SCIP_TYPE_MISC_H__
26 
27 #include "scip/def.h"
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 /** represents different confidence levels for (one-sided) hypothesis testing; in order to obtain two-sided confidence
34  * levels, calculate 2 * c - 1, i.e., if the one-sided confidence level is 90 %, the two-sided level is 80 %
35  */
37 {
38  SCIP_CONFIDENCELEVEL_MIN = 0, /**< one-sided confidence level 75 %, two-sided 50 % */
39  SCIP_CONFIDENCELEVEL_LOW = 1, /**< (one-sided) confidence level 87.5 %, two-sided 75 % */
40  SCIP_CONFIDENCELEVEL_MEDIUM = 2, /**< (one-sided) confidence level 90 %, two-sided 80 % */
41  SCIP_CONFIDENCELEVEL_HIGH = 3, /**< (one-sided) confidence level 95 %, two-sided 90 % */
42  SCIP_CONFIDENCELEVEL_MAX = 4 /**< (one-sided) confidence level 97.5 %, two-sided 95 % */
43 };
45 
46 
47 /** Sparse solution data structure
48  *
49  * - \ref SparseSol "List of all available methods"
50  */
51 typedef struct SCIP_SparseSol SCIP_SPARSESOL;
52 
53 /** (circular) Queue data structure
54  *
55  * - \ref Queue "List of all available methods"
56  */
57 typedef struct SCIP_Queue SCIP_QUEUE;
58 
59 /** Priority queue data structure
60  *
61  * - \ref PriorityQueue "List of all available methods"
62  */
63 typedef struct SCIP_PQueue SCIP_PQUEUE;
64 
65 /** Hash table data structure
66  *
67  * - \ref HashTable "List of all available methods"
68  */
69 typedef struct SCIP_HashTable SCIP_HASHTABLE;
70 
71 /** Hash table element list to store single elements of a hash table */
72 typedef struct SCIP_HashTableList SCIP_HASHTABLELIST;
73 
74 /** Hash map data structure
75  *
76  * - \ref HashMap "List of all available methods"
77  */
78 typedef struct SCIP_HashMap SCIP_HASHMAP;
79 
80 /** Hash map element list to store single mappings of a hash map */
81 typedef struct SCIP_HashMapList SCIP_HASHMAPLIST;
82 
83 /** dynamic array for storing SCIP_Real values */
84 typedef struct SCIP_RealArray SCIP_REALARRAY;
85 
86 /** dynamic array for storing int values */
87 typedef struct SCIP_IntArray SCIP_INTARRAY;
88 
89 /** dynamic array for storing SCIP_Bool values */
90 typedef struct SCIP_BoolArray SCIP_BOOLARRAY;
91 
92 /** dynamic array for storing pointers */
93 typedef struct SCIP_PtrArray SCIP_PTRARRAY;
94 
95 /** Resource activity data structure
96  *
97  * - \ref ResourceActivity "List of all available methods"
98  */
99 typedef struct SCIP_ResourceActivity SCIP_RESOURCEACTIVITY;
100 
101 /** Resource profile data structure
102  *
103  * - \ref ResourceProfile "List of all available methods"
104  */
105 typedef struct SCIP_Profile SCIP_PROFILE;
106 
107 /** Directed graph data structure (stored as adjacency list)
108  *
109  * - \ref DirectedGraph "List of all available methods"
110  */
111 typedef struct SCIP_Digraph SCIP_DIGRAPH;
112 
113 /** Binary tree data structure
114  *
115  * - \ref BinaryTree "List of all available methods"
116  */
117 typedef struct SCIP_Bt SCIP_BT;
118 
119 /** search node of \ref SCIP_BT "binary tree" */
120 typedef struct SCIP_BtNode SCIP_BTNODE;
121 
122 /** compares two element indices
123  * result:
124  * < 0: ind1 comes before (is better than) ind2
125  * = 0: both indices have the same value
126  * > 0: ind2 comes after (is worse than) ind2
127  */
128 #define SCIP_DECL_SORTINDCOMP(x) int x (void* dataptr, int ind1, int ind2)
129 
130 /** compares two data element pointers
131  * result:
132  * < 0: elem1 comes before (is better than) elem2
133  * = 0: both elements have the same value
134  * > 0: elem2 comes after (is worse than) elem2
135  */
136 #define SCIP_DECL_SORTPTRCOMP(x) int x (void* elem1, void* elem2)
137 
138 /** gets the key of the given element */
139 #define SCIP_DECL_HASHGETKEY(x) void* x (void* userptr, void* elem)
140 
141 /** returns TRUE iff both keys are equal */
142 #define SCIP_DECL_HASHKEYEQ(x) SCIP_Bool x (void* userptr, void* key1, void* key2)
143 
144 /** returns the hash value of the key */
145 #define SCIP_DECL_HASHKEYVAL(x) unsigned int x (void* userptr, void* key)
146 
147 #ifdef __cplusplus
148 }
149 #endif
150 
151 #endif
struct SCIP_PQueue SCIP_PQUEUE
Definition: type_misc.h:63
struct SCIP_Digraph SCIP_DIGRAPH
Definition: type_misc.h:111
struct SCIP_Bt SCIP_BT
Definition: type_misc.h:117
struct SCIP_HashMap SCIP_HASHMAP
Definition: type_misc.h:78
struct SCIP_ResourceActivity SCIP_RESOURCEACTIVITY
Definition: type_misc.h:99
struct SCIP_IntArray SCIP_INTARRAY
Definition: type_misc.h:87
struct SCIP_HashTable SCIP_HASHTABLE
Definition: type_misc.h:69
enum SCIP_Confidencelevel SCIP_CONFIDENCELEVEL
Definition: type_misc.h:44
struct SCIP_BtNode SCIP_BTNODE
Definition: type_misc.h:120
SCIP_Confidencelevel
Definition: type_misc.h:36
struct SCIP_PtrArray SCIP_PTRARRAY
Definition: type_misc.h:93
struct SCIP_Queue SCIP_QUEUE
Definition: type_misc.h:57
struct SCIP_HashTableList SCIP_HASHTABLELIST
Definition: type_misc.h:72
struct SCIP_SparseSol SCIP_SPARSESOL
Definition: type_misc.h:51
struct SCIP_HashMapList SCIP_HASHMAPLIST
Definition: type_misc.h:81
struct SCIP_RealArray SCIP_REALARRAY
Definition: type_misc.h:84
struct SCIP_Profile SCIP_PROFILE
Definition: type_misc.h:105
struct SCIP_BoolArray SCIP_BOOLARRAY
Definition: type_misc.h:90
common defines and data types used in all packages of SCIP