MatrixData.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2025 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
#pragma once
 
#include <memory>
 
#include <arccore/base/String.h>
 
#include <alien/data/IMatrix.h>
 
#include <alien/move/AlienMoveSemanticPrecomp.h>
#include <arccore/message_passing/MessagePassingGlobal.h>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Alien
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class Block;
class VBlock;
class Space;
class MatrixDistribution;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Move
{

  class ALIEN_MOVESEMANTIC_EXPORT MatrixData : public IMatrix
  {
   public:
    typedef Real ValueType;

    MatrixData();

    [[deprecated]] MatrixData(const Space& space, const MatrixDistribution& dist);

    [[deprecated]] MatrixData(
    const Space& row_space, const Space& col_space, const MatrixDistribution& dist);

    [[deprecated]] MatrixData(Integer size, const MatrixDistribution& dist);

    [[deprecated]] MatrixData(Integer row_size, Integer col_size, const MatrixDistribution& dist);

    explicit MatrixData(const MatrixDistribution& dist);

    MatrixData(MatrixData&& matrix);

    virtual ~MatrixData() = default;

    MatrixData& operator=(MatrixData&& matrix);

    void init(const Space& space, const MatrixDistribution& dist);

    MatrixData(const MatrixData&) = delete;
    void operator=(const MatrixData&) = delete;
 
    MatrixData clone() const;

 
    void setBlockInfos(const Integer block_size);
 
    void setBlockInfos(const Block* block);
 
    void setBlockInfos(const VBlock* block);
 
    Block const* block() const;
 
    VBlock const* vblock() const;

    void free();

    void clear();

    void visit(ICopyOnWriteMatrix&) const;

    const ISpace& rowSpace() const;

    const ISpace& colSpace() const;

    const MatrixDistribution& distribution() const;

    void lock() {}

    void unlock() {}

    bool isLocked() const { return false; }

    void setUserFeature(String feature);

    bool hasUserFeature(String feature) const;

    bool isTransposed() const { return hasUserFeature("transposed"); }

    bool isComposite() const;
    /* }@ */

    MultiMatrixImpl* impl();
 
    const MultiMatrixImpl* impl() const;
 
    friend MatrixData createMatrixData(std::shared_ptr<MultiMatrixImpl> multi);
 
   private:
    std::shared_ptr<MultiMatrixImpl> m_impl;
  };
 
  MatrixData ALIEN_MOVESEMANTIC_EXPORT
  readFromMatrixMarket(Arccore::MessagePassing::IMessagePassingMng* pm, const std::string& filename);
 
  MatrixData createMatrixData(std::shared_ptr<MultiMatrixImpl> multi);
} // namespace Move
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Alien
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/