summaryrefslogtreecommitdiff
path: root/compiler/gen-core/include/gencore/HDF5Common.h
blob: 87367c99c64441494e9306372b578578372bdd42 (plain)
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
/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __HDF5COMMON_H__
#define __HDF5COMMON_H__

#include <string>

namespace gencore
{

/**
 * @brief Construct HDF5-compatible dataset name from a given string
 *
 * When someone attempts to access 'A/B/C' dataset, HDF5 tries to open
 * dataset C in group B in top-level group A, which means that dataset
 * names SHOULD NOT contain '/' in it.
 *
 * This mangle function replaces all the occurence of '/' in a given
 * string with '_' to construct HDF5-compatible dataset name.
 */
std::string mangle(const std::string &);

#if 0
Let us assume that a tensor context includes N + 1 tensors.

Then, HDF5 export will generate a HDF5 file whose structure is given as follows:
[value group]/
  [file 0] <- A dataset that contains the value of 1st (=0) tensor
  [file 1]
  ...
  [file N]
[name group]/
  [file 0] <- An attribute that contains the name of 1st (=0) tensor
  [file 1]
  ...
  [file N]
#endif

/// @brief Return the name of "value group"
std::string value_grpname(void);
/// @brief Return the name of n-th tensor dataset
std::string value_filename(uint32_t n);

/// @brief Return the name of "name group"
std::string name_grpname(void);
/// @brief Return the name of n-th tensor attribute
std::string name_filename(uint32_t n);

} // namespace gencore

#endif // __HDF5COMMON_H__