SparseArray.hpp

Go to the documentation of this file.

 
#ifndef LLU_CONTAINERS_GENERIC_SPARSEARRAY_HPP
#define LLU_CONTAINERS_GENERIC_SPARSEARRAY_HPP
 
#include "LLU/Containers/Generic/Base.hpp"
#include "LLU/Containers/Generic/Tensor.hpp"
 
namespace LLU {
 
    template<>
    class MContainer<MArgumentType::SparseArray>;
 
    using GenericSparseArray = MContainer<MArgumentType::SparseArray>;
 
    template<>
    class MContainer<MArgumentType::SparseArray> : public MContainerBase<MArgumentType::SparseArray> {
    public:
        using MContainerBase<MArgumentType::SparseArray>::MContainerBase;
 
        MContainer() = default;
 
        MContainer(const GenericTensor& positions, const GenericTensor& values, const GenericTensor& dimensions, const GenericTensor& implicitValue);
 
        MContainer(const GenericTensor& data, const GenericTensor& implicitValue);
 
        MContainer(const GenericSparseArray& s, const GenericTensor& implicitValue);
 
        MContainer clone() const {
            return MContainer {cloneContainer(), Ownership::Library};
        }
 
        GenericTensor getImplicitValueAsTensor() const;
 
        void setImplicitValueFromTensor(const GenericTensor& implicitValue);
 
        mint getRank() const {
            return LibraryData::SparseArrayAPI()->MSparseArray_getRank(this->getContainer());
        }
 
        mint const* getDimensions() const {
            return LibraryData::SparseArrayAPI()->MSparseArray_getDimensions(this->getContainer());
        }
 
        GenericTensor getExplicitValues() const;
 
        GenericTensor getRowPointers() const;
 
        GenericTensor getColumnIndices() const;
 
        [[nodiscard]] GenericTensor getExplicitPositions() const;
 
        [[nodiscard]] GenericTensor toGenericTensor() const;
 
        void resparsify();
 
        mint type() const;
 
    private:
 
        Container cloneImpl() const override;
 
        mint shareCountImpl() const noexcept override {
            return LibraryData::SparseArrayAPI()->MSparseArray_shareCount(this->getContainer());
        }
 
        void passImpl(MArgument& res) const noexcept override {
            MArgument_setMSparseArray(res, this->getContainer());
        }
    };
 
}  // namespace LLU
 
#endif    // LLU_CONTAINERS_GENERIC_SPARSEARRAY_HPP