VectorData.h

/*
 * Copyright 2020 IFPEN-CEA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <memory>
 
#include <alien/data/IVector.h>
#include <alien/move/AlienMoveSemanticPrecomp.h>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Alien
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class Block;
class VBlock;
class Space;
class VectorDistribution;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Move
{

  class ALIEN_MOVESEMANTIC_EXPORT VectorData : public IVector
  {
   public:
    typedef Real ValueType;

    VectorData();

    [[deprecated]] VectorData(const ISpace& space, const VectorDistribution& dist);

    [[deprecated]] VectorData(Integer size, const VectorDistribution& dist);

    explicit VectorData(const VectorDistribution& dist);

    VectorData(VectorData&& vector);

    virtual ~VectorData() = default;

    VectorData& operator=(VectorData&& vector);

    void init(const ISpace& space, const VectorDistribution& dist);

    VectorData(const VectorData&) = delete;
    VectorData& operator=(const VectorData&) = delete;
 
    VectorData clone() const;

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

    void free();

    void clear();

    void visit(ICopyOnWriteVector&) const;

    const ISpace& space() const;

    const VectorDistribution& distribution() const;

    void setUserFeature(String feature);

    bool hasUserFeature(String feature) const;

    MultiVectorImpl* impl();
 
    const MultiVectorImpl* impl() const;
 
    friend VectorData createVectorData(std::shared_ptr<MultiVectorImpl> multi);
 
   private:
    std::shared_ptr<MultiVectorImpl> m_impl;
  };
 
  VectorData ALIEN_MOVESEMANTIC_EXPORT
  readFromMatrixMarket(const VectorDistribution& distribution, const std::string& filename);
 
  // Do not export this factory.
  VectorData createVectorData(std::shared_ptr<MultiVectorImpl> multi);
} // namespace Move
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Alien
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/