File: serialization_tools.h

package info (click to toggle)
ergo 3.8.2-1.1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 17,568 kB
  • sloc: cpp: 94,763; ansic: 17,785; sh: 10,701; makefile: 1,403; yacc: 127; lex: 116; awk: 23
file content (86 lines) | stat: -rw-r--r-- 3,056 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/* Ergo, version 3.8.2, a program for linear scaling electronic structure
 * calculations.
 * Copyright (C) 2023 Elias Rudberg, Emanuel H. Rubensson, Pawel Salek,
 * and Anastasia Kruchinina.
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * Primary academic reference:
 * Ergo: An open-source program for linear-scaling electronic structure
 * calculations,
 * Elias Rudberg, Emanuel H. Rubensson, Pawel Salek, and Anastasia
 * Kruchinina,
 * SoftwareX 7, 107 (2018),
 * <http://dx.doi.org/10.1016/j.softx.2018.03.005>
 * 
 * For further information about Ergo, see <http://www.ergoscf.org>.
 */

/** @file serialization_tools.h

    \brief Tools to simplify serialization of e.g. std::vector
    objects, useful when writing serialization functions needed for
    Chunks and Tasks usage.

    @author: Elias Rudberg <em>responsible</em>.
*/

#ifndef SERIALIZATION_TOOLS_HEADER
#define SERIALIZATION_TOOLS_HEADER

#include <vector>

/* general std::vector serialization template code */

template <typename VectorType>
size_t std_vector_getSize(const VectorType & v) {
  // One size_t for storing the number of elements, plus the space needed for the elements themselves.
  size_t sizeOfOneElement = sizeof(typename VectorType::value_type);
  return sizeof(size_t) + v.size() * sizeOfOneElement;
}

typedef char* CharPtrType;

template <typename VectorType>
void std_vector_writeToBuffer_and_move_ptr(const VectorType & v, CharPtrType & p) {
  size_t nElements = v.size();
  memcpy(p, &nElements, sizeof(size_t));
  p += sizeof(size_t);
  size_t sizeOfOneElement = sizeof(typename VectorType::value_type);
  size_t sizeOfAllElements = v.size() * sizeOfOneElement;
  memcpy(p, &v[0], sizeOfAllElements);
  p += sizeOfAllElements;
}

typedef const char* ConstCharPtrType;

template <typename VectorType>
void std_vector_assignFromBuffer_and_move_ptr(VectorType & v, ConstCharPtrType & p, const char* bufEndPtr) {
  assert(bufEndPtr > p);
  size_t nBytesInBuffer = bufEndPtr - p;
  assert(nBytesInBuffer >= sizeof(size_t));
  size_t nElements;
  memcpy(&nElements, p, sizeof(size_t));
  p += sizeof(size_t);
  // Check that nElements has a reasonable value.
  size_t sizeOfOneElement = sizeof(typename VectorType::value_type);
  size_t sizeOfAllElements = nElements * sizeOfOneElement;
  assert(sizeOfAllElements + sizeof(size_t) <= nBytesInBuffer);
  v.resize(nElements);
  memcpy(&v[0], p, sizeOfAllElements);
  p += sizeOfAllElements;
}


#endif