Scippy

SCIP

Solving Constraint Integer Programs

bitencode.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 bitencode.h
26  * @brief packing single and dual bit values
27  * @author Thorsten Koch
28  * @author Tobias Achterberg
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_BITENCODE_H__
34 #define __SCIP_BITENCODE_H__
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 typedef unsigned int SCIP_SINGLEPACKET; /**< storing single bits in packed format */
41 #define SCIP_SINGLEPACKETSIZE (sizeof(SCIP_SINGLEPACKET)*8) /**< each entry needs one bit of information */
42 typedef unsigned int SCIP_DUALPACKET; /**< storing bit pairs in packed format */
43 #define SCIP_DUALPACKETSIZE (sizeof(SCIP_DUALPACKET)*4) /**< each entry needs two bits of information */
44 
45 
46 /** encode a single bit vector into packed format */
48  const int* inp, /**< unpacked input vector */
49  SCIP_SINGLEPACKET* out, /**< buffer to store the packed vector */
50  int count /**< number of elements */
51  );
52 
53 /** decode a packed single bit vector into unpacked format */
55  const SCIP_SINGLEPACKET* inp, /**< packed input vector */
56  int* out, /**< buffer to store unpacked vector */
57  int count /**< number of elements */
58  );
59 
60 /** encode a dual bit vector into packed format */
62  const int* inp, /**< unpacked input vector */
63  SCIP_DUALPACKET* out, /**< buffer to store the packed vector */
64  int count /**< number of elements */
65  );
66 
67 /** decode a packed dual bit vector into unpacked format */
69  const SCIP_DUALPACKET* inp, /**< packed input vector */
70  int* out, /**< buffer to store unpacked vector */
71  int count /**< number of elements */
72  );
73 
74 #ifdef __cplusplus
75 }
76 #endif
77 
78 #endif
void SCIPdecodeDualBit(const SCIP_DUALPACKET *inp, int *out, int count)
Definition: bitencode.c:308
void SCIPdecodeSingleBit(const SCIP_SINGLEPACKET *inp, int *out, int count)
Definition: bitencode.c:131
unsigned int SCIP_DUALPACKET
Definition: bitencode.h:42
void SCIPencodeDualBit(const int *inp, SCIP_DUALPACKET *out, int count)
Definition: bitencode.c:238
unsigned int SCIP_SINGLEPACKET
Definition: bitencode.h:40
void SCIPencodeSingleBit(const int *inp, SCIP_SINGLEPACKET *out, int count)
Definition: bitencode.c:41