Alexandria 2.25.0
SDC-CH common library for the Euclid project
NpyMmap.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2012-2021 Euclid Science Ground Segment
3 *
4 * This library is free software; you can redistribute it and/or modify it under
5 * the terms of the GNU Lesser General Public License as published by the Free
6 * Software Foundation; either version 3.0 of the License, or (at your option)
7 * any later version.
8 *
9 * This library is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12 * details.
13 *
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this library; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19#ifndef ALEXANDRIA_NDARRAY_IO_NPYMMAP_H
20#define ALEXANDRIA_NDARRAY_IO_NPYMMAP_H
21
22#include "NdArray/NdArray.h"
23#include <boost/filesystem/path.hpp>
24#include <boost/iostreams/device/mapped_file.hpp>
25
26namespace Euclid {
27namespace NdArray {
28
48template <typename T>
49NdArray<T> mmapNpy(const boost::filesystem::path& path,
50 boost::iostreams::mapped_file_base::mapmode mode = boost::iostreams::mapped_file_base::readwrite,
51 size_t max_size = 0);
52
68template <typename T>
69NdArray<T> createMmapNpy(const boost::filesystem::path& path, const std::vector<size_t>& shape,
70 const std::vector<std::string>& attr_names, size_t max_size = 0);
71
85template <typename T>
86NdArray<T> createMmapNpy(const boost::filesystem::path& path, const std::vector<size_t>& shape, size_t max_size = 0) {
87 return createMmapNpy<T>(path, shape, {}, max_size);
88}
89
90} // end of namespace NdArray
91} // end of namespace Euclid
92
93#define NPYMMAP_IMPL
95#undef NPYMMAP_IMPL
96
97#endif // ALEXANDRIA_NDARRAY_IO_NPYMMAP_H
Path::Item path
NdArray< T > mmapNpy(const boost::filesystem::path &path, boost::iostreams::mapped_file_base::mapmode mode=boost::iostreams::mapped_file_base::readwrite, size_t max_size=0)
NdArray< T > createMmapNpy(const boost::filesystem::path &path, const std::vector< size_t > &shape, const std::vector< std::string > &attr_names, size_t max_size=0)