ISparseArray.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 __ISPARSEArray_HPP
#define __ISPARSEArray_HPP
 
#include "Eigen/Eigen"
#include <ostream>
#include <vector>
 
namespace Gedim
{
class IArray;
 
class ISparseArray
{
  public:
    enum class SparseArrayTypes
    {
        None = 0,
        Lower = 1,
        Upper = 2,
        Symmetric = 3,
        Diagonal = 4
    };
 
    enum class ConditionNumberAlgorithm
    {
        SVDLapack = 0,
        CondestLapack = 1,
        CondestSuiteSparse = 2
    };
 
  public:
    virtual ~ISparseArray()
    {
    }
 
    virtual void SetSize(const unsigned int &numRows,
                         const unsigned int &numCols,
                         const SparseArrayTypes &type = SparseArrayTypes::None) = 0;
 
    virtual SparseArrayTypes Type() const = 0;
 
    virtual void Create() = 0;
    virtual void Destroy() = 0;
    virtual void Flush() = 0;
 
    virtual void Reset() = 0;
    virtual void Triplet(const unsigned int &i, const unsigned int &j, const double &val) = 0;
    virtual void Triplets(const std::vector<unsigned int> &i, const std::vector<unsigned int> &j, const std::vector<double> &val) = 0;
 
    virtual double Norm() const = 0;
 
    virtual std::ostream &Print(std::ostream &output) const = 0;
 
    virtual void ToBinaryFile(const std::string &filePath, const bool &append = false) const = 0;
 
    virtual double Cond(const ISparseArray::ConditionNumberAlgorithm &algorithm = ISparseArray::ConditionNumberAlgorithm::SVDLapack) const = 0;
 
    virtual unsigned int NonZeros() const = 0;
 
    virtual ISparseArray &operator+=(const ISparseArray &A) = 0;
    virtual ISparseArray &operator-=(const ISparseArray &A) = 0;
    virtual ISparseArray &operator*=(const double &c) = 0;
    virtual ISparseArray &operator/=(const double &c) = 0;
 
    inline friend std::ostream &operator<<(std::ostream &output, const ISparseArray &b)
    {
        return b.Print(output);
    }
};
} // namespace Gedim
 
#endif // __ISPARSEArray_HPP