MultiDimensionalArray.h

Go to the documentation of this file.

#ifndef MATIOCPP_MULTIDIMENSIONALARRAY_H
#define MATIOCPP_MULTIDIMENSIONALARRAY_H
 
/*
 * Copyright (C) 2020 Fondazione Istituto Italiano di Tecnologia
 *
 * This software may be modified and distributed under the terms of the
 * BSD-2-Clause license (https://opensource.org/licenses/BSD-2-Clause).
 */
 
#include <matioCpp/ForwardDeclarations.h>
#include <matioCpp/ConversionUtilities.h>
#include <matioCpp/Span.h>
#include <matioCpp/Variable.h>
 
template<typename T>
class matioCpp::MultiDimensionalArray : public matioCpp::Variable
{
 
    virtual bool checkCompatibility(const matvar_t* inputPtr, matioCpp::VariableType variableType, matioCpp::ValueType valueType) const final;
 
public:
 
    using type = T; 
    using element_type = typename get_type<T>::type; 
    using value_type = std::remove_cv_t<element_type>; 
    using allocator_type = std::allocator<element_type>; 
    using index_type = size_t; 
    using reference = element_type&; 
    using pointer = typename std::allocator_traits<std::allocator<element_type>>::pointer; 
    using const_pointer = typename std::allocator_traits<std::allocator<element_type>>::const_pointer; 
    MultiDimensionalArray();
 
    MultiDimensionalArray(const std::string& name);
 
    MultiDimensionalArray(const std::string& name, const std::vector<index_type>& dimensions);
 
    MultiDimensionalArray(const std::string& name, const std::vector<index_type>& dimensions, const_pointer inputVector);
 
    MultiDimensionalArray(const MultiDimensionalArray<T>& other);
 
    MultiDimensionalArray(MultiDimensionalArray<T>&& other);
 
    MultiDimensionalArray(const MatvarHandler& handler);
 
    ~MultiDimensionalArray();
 
    MultiDimensionalArray<T>& operator=(const MultiDimensionalArray<T>& other);
 
    MultiDimensionalArray<T>& operator=(MultiDimensionalArray<T>&& other);
 
    bool fromVectorizedArray(const std::vector<index_type>& dimensions, const_pointer inputVector);
 
    index_type rawIndexFromIndices(const std::vector<index_type>& el) const;
 
    bool indicesFromRawIndex(size_t rawIndex, std::vector<index_type>& el) const;
 
    matioCpp::Span<element_type> toSpan();
 
    const matioCpp::Span<const element_type> toSpan() const;
 
    bool setName(const std::string& newName);
 
    void resize(const std::vector<index_type>& newDimensions);
 
    void clear();
 
    pointer data();
 
    const_pointer data() const;
 
    index_type numberOfElements() const;
 
    reference operator()(const std::vector<index_type>& el);
 
    value_type operator()(const std::vector<index_type>& el) const;
 
    reference operator()(index_type el);
 
    value_type operator()(index_type el) const;
 
    reference operator[](const std::vector<index_type>& el);
 
    value_type operator[](const std::vector<index_type>& el) const;
 
    reference operator[](index_type el);
 
    value_type operator[](index_type el) const;
};
 
#include "impl/MultiDimensionalArray.tpp"
 
#endif // MATIOCPP_MULTIDIMENSIONALARRAY_H