1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  */
22 
23 #ifndef DOUBLE_SERIALIZATION_H
24 #define DOUBLE_SERIALIZATION_H
25 
26 #include "common/types.h"
27 
28 /**
29  * @defgroup lua_ds Double serialization
30  * @ingroup lua
31  *
32  * @brief Functions for encoding and decoding double values.
33  *
34  * @{
35  */
36 
37 namespace Util {
38 
39 struct SerializedDouble {
40 	uint32 significandOne;
41 	uint32 signAndSignificandTwo;
42 	int16 exponent;
43 };
44 
45 struct CompactSerializedDouble {
46 	uint32 signAndSignificandOne;
47 	uint32 exponentAndSignificandTwo;
48 };
49 
50 /**
51  * Encodes a double as two uint32 and a one int16
52  *
53  * Supports denormalized numbers. Does NOT support NaN, or Inf
54  *
55  * @param value    The value to encode
56  * @return         The encoded value
57  */
58 SerializedDouble encodeDouble(double value);
59 /**
60  * Decodes a previously encoded double
61  *
62  * @param value    The value to decode
63  * @return         The decoded value
64  */
65 double decodeDouble(SerializedDouble value);
66 
67 } // End of namespace Util
68 
69 /** @} */
70 
71 #endif
72