matrix-array.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Biljana Bojovic <bbojovic@cttc.es>
 */
 
#ifndef MATRIX_ARRAY_H
#define MATRIX_ARRAY_H
 
#include "val-array.h"
 
#include <valarray>
 
namespace ns3
{
 
template <class T>
class MatrixArray : public ValArray<T>
{
  public:
    // instruct the compiler to generate the default constructor
    MatrixArray() = default;
    MatrixArray(size_t numRows, size_t numCols = 1, size_t numPages = 1);
    explicit MatrixArray(const std::valarray<T>& values);
    MatrixArray(std::valarray<T>&& values);
    explicit MatrixArray(const std::vector<T>& values);
    MatrixArray(size_t numRows, size_t numCols, const std::valarray<T>& values);
    MatrixArray(size_t numRows, size_t numCols, std::valarray<T>&& values);
    MatrixArray(size_t numRows, size_t numCols, size_t numPages, const std::valarray<T>& values);
    MatrixArray(size_t numRows, size_t numCols, size_t numPages, std::valarray<T>&& values);
 
    MatrixArray operator*(const T& rhs) const;
    MatrixArray operator+(const MatrixArray<T>& rhs) const;
    MatrixArray operator-(const MatrixArray<T>& rhs) const;
    MatrixArray operator-() const;
    MatrixArray operator*(const MatrixArray<T>& rhs) const;
    MatrixArray Transpose() const;
    MatrixArray MultiplyByLeftAndRightMatrix(const MatrixArray<T>& lMatrix,
                                             const MatrixArray<T>& rMatrix) const;
 
    using ValArray<T>::GetPagePtr;
    using ValArray<T>::EqualDims;
    using ValArray<T>::AssertEqualDims;
 
    template <bool EnableBool = true,
              typename = std::enable_if_t<(std::is_same_v<T, std::complex<double>> && EnableBool)>>
    MatrixArray<T> HermitianTranspose() const;
 
  protected:
    // To simplify functions in MatrixArray that are using members from the template base class
    using ValArray<T>::m_numRows;
    using ValArray<T>::m_numCols;
    using ValArray<T>::m_numPages;
    using ValArray<T>::m_values;
};
 
using IntMatrixArray = MatrixArray<int>;
 
using DoubleMatrixArray = MatrixArray<double>;
 
using ComplexMatrixArray = MatrixArray<std::complex<double>>;
 
/*************************************************
 **  Class MatrixArray inline implementations
 ************************************************/
template <class T>
inline MatrixArray<T>
MatrixArray<T>::operator*(const T& rhs) const
{
    return MatrixArray<T>(m_numRows,
                          m_numCols,
                          m_numPages,
                          m_values * std::valarray<T>(rhs, m_numRows * m_numCols * m_numPages));
}
 
template <class T>
inline MatrixArray<T>
MatrixArray<T>::operator+(const MatrixArray<T>& rhs) const
{
    AssertEqualDims(rhs);
    return MatrixArray<T>(m_numRows, m_numCols, m_numPages, m_values + rhs.m_values);
}
 
template <class T>
inline MatrixArray<T>
MatrixArray<T>::operator-(const MatrixArray<T>& rhs) const
{
    AssertEqualDims(rhs);
    return MatrixArray<T>(m_numRows, m_numCols, m_numPages, m_values - rhs.m_values);
}
 
template <class T>
inline MatrixArray<T>
MatrixArray<T>::operator-() const
{
    return MatrixArray<T>(m_numRows, m_numCols, m_numPages, -m_values);
}
 
} // namespace ns3
 
#endif // MATRIX_ARRAY_H