csrSparsityPattern.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 - 2026 NeoN authors
//
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include "NeoN/core/copyTo.hpp"
#include "NeoN/core/vector/vector.hpp"
#include "NeoN/mesh/unstructured/unstructuredMesh.hpp"
#include "NeoN/linearAlgebra/sparsityView.hpp"
 
namespace NeoN::la
{
 
template<typename IndexType>
class CsrSparsityPattern : public NeoN::SupportsCopyTo<CsrSparsityPattern<IndexType>>
{
 
    void validate() const;
 
public:
 
    using SparsityIndexType = IndexType;
 
    /* @brief create an "empty" SparsityPattern with a given size  */
    CsrSparsityPattern(const CsrSparsityPattern& sp);
 
    CsrSparsityPattern(Vector<IndexType>&& colIdx, Vector<IndexType>&& rowOffs, Dimensions dim);
 
    [[nodiscard]] CsrSparsityPattern copyToExecutor(Executor dstExec) const override
    {
        return CsrSparsityPattern<IndexType>(
            colIdxs_.copyToExecutor(dstExec), rowOffs_.copyToExecutor(dstExec), dimensions_
        );
    }
 
    ~CsrSparsityPattern() = default;
 
    /*@brief getter for executor */
    const Executor& exec() const { return rowOffs_.exec(); }
 
    /*@brief getter for colIdxs */
    [[nodiscard]] const Vector<IndexType>& colIdxs() const { return colIdxs_; };
 
    [[nodiscard]] Vector<IndexType>& colIdxs() { return colIdxs_; };
 
    /*@brief getter for rowOffs */
    [[nodiscard]] const Vector<IndexType>& rowOffs() const { return rowOffs_; };
 
    /*@brief getter for non-const rowOffs */
    [[nodiscard]] Vector<IndexType>& rowOffs() { return rowOffs_; };
 
    [[nodiscard]] localIdx rows() const { return dimensions_.rows; };
 
    [[nodiscard]] localIdx nnz() const { return colIdxs_.size(); };
 
    [[nodiscard]] Dimensions dimension() const { return dimensions_; };
    [[nodiscard]] SparsityView<IndexType> view() const
    {
        return SparsityView<IndexType>(colIdxs_.view(), rowOffs_.view());
    }
 
private:
 
    Dimensions dimensions_;
 
    Vector<IndexType> rowOffs_; 
 
    Vector<IndexType> colIdxs_; 
};
 
} // namespace NeoN::la