IArray.hpp

Go to the documentation of this file.

// _LICENSE_HEADER_
//
// Copyright (C) 2019 - 2025.
// Terms register on the GPL-3.0 license.
//
// This file can be redistributed and/or modified under the license terms.
//
// See top level LICENSE file for more details.
//
// This file can be used citing references in CITATION.cff file.
 
#ifndef __IArray_HPP
#define __IArray_HPP
 
#include "ISparseArray.hpp"
#include <ostream>
#include <vector>
 
namespace Gedim
{
class IArray
{
  public:
    virtual ~IArray()
    {
    }
 
    virtual void Create() = 0;
    virtual void Destroy() = 0;
    virtual void SetSize(const unsigned int &numCols) = 0;
    virtual void SetSizes(const unsigned int &numCols, const unsigned int &numLocalCols) = 0;
    virtual unsigned int Size() const = 0;
    virtual const double *Data() const = 0;
    virtual double *Data() = 0;
    virtual void Zeros() = 0;
    virtual void Ones() = 0;
    virtual void Constant(const double &c) = 0;
    virtual double &operator[](const int &i) = 0;
    virtual const double &operator[](const int &i) const = 0;
    virtual void SetValue(const int &i, const double &val) = 0;
    virtual void SetValues(const std::vector<int> &indices, const std::vector<double> &values) = 0;
 
    virtual std::vector<double> GetValues(const std::vector<int> &indices = {}) const = 0;
    virtual double GetValue(const int &i) const = 0;
 
    virtual void AddValue(const int &i, const double &val) = 0;
    virtual void AddValues(const std::vector<int> &indices, const std::vector<double> &values) = 0;
 
    virtual void SumMultiplication(const ISparseArray &A, const IArray &w) = 0;
 
    virtual void SubtractionMultiplication(const ISparseArray &A, const IArray &w) = 0;
 
    virtual void Concatenate(const IArray &v, const IArray &w) = 0;
 
    virtual double Norm() const = 0;
    virtual double Dot(const IArray &v) const = 0;
 
    virtual void Copy(const IArray &v) = 0;
 
    virtual std::ostream &Print(std::ostream &output) const = 0;
 
    virtual void ToBinaryFile(const std::string &filePath,
                              const unsigned int &dataSizeToWrite = 0,
                              const unsigned int &dataStartingPositionToWrite = 0,
                              const bool &append = false) const = 0;
 
    virtual IArray &operator+=(const IArray &v) = 0;
    virtual IArray &operator-=(const IArray &v) = 0;
    virtual IArray &operator*=(const double &c) = 0;
    virtual IArray &operator/=(const double &c) = 0;
 
    inline friend std::ostream &operator<<(std::ostream &output, const IArray &b)
    {
        return b.Print(output);
    }
};
} // namespace Gedim
 
#endif // __IArray_HPP