Matrix.inl

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#include <vector>
 
#include "Stroika/Foundation/Characters/StringBuilder.h"
#include "Stroika/Foundation/Characters/ToString.h"
#include "Stroika/Foundation/Debug/AssertExternallySynchronizedMutex.h"
 
namespace Stroika::Foundation::Math::LinearAlgebra {
 
    /*
     ********************************************************************************
     ******************************** Matrix<T>::Rep_ *******************************
     ********************************************************************************
     */
    template <typename T>
    class Matrix<T>::Rep_ {
    public:
        Rep_ (const DimensionType& dimensions)
            : fDimensions_{dimensions}
        {
        }
 
        T GetAt (size_t row, size_t col) const
        {
            Debug::AssertExternallySynchronizedMutex::ReadContext declareContext{fThisAssertExternallySynchronized_};
            Require (row < fDimensions_.fRows);
            Require (col < fDimensions_.fColumns);
            return fData_[row * fDimensions_.fColumns + col];
        }
        void SetAt (size_t row, size_t col, T value)
        {
            Debug::AssertExternallySynchronizedMutex::WriteContext declareContext{fThisAssertExternallySynchronized_};
            Require (row < fDimensions_.fRows);
            Require (col < fDimensions_.fColumns);
            //fData_.SetAt (row * fDimensions_.fColumns + col, value);
            fData_[row * fDimensions_.fColumns + col] = value;
        }
        void push_back (Common::ArgByValueType<T> fillValue)
        {
            Debug::AssertExternallySynchronizedMutex::WriteContext declareContext{fThisAssertExternallySynchronized_};
            fData_.push_back (fillValue);
        }
 
        DimensionType GetDimensions () const
        {
            Debug::AssertExternallySynchronizedMutex::ReadContext declareContext{fThisAssertExternallySynchronized_};
            return fDimensions_;
        }
 
    private:
        DimensionType fDimensions_;
        // nb: use vector<> because for debug builds - big difference in speed  - and hidden anyhow
        // row*nCols + col is addressing scheme
        vector<T>                                                      fData_;
        [[no_unique_address]] Debug::AssertExternallySynchronizedMutex fThisAssertExternallySynchronized_;
    };
 
    /*
     ********************************************************************************
     ********************************** Matrix<T> ***********************************
     ********************************************************************************
     */
    template <typename T>
    inline Matrix<T>::Matrix (const DimensionType& dimensions)
        : Matrix{dimensions, T{0}}
    {
    }
    template <typename T>
    inline Matrix<T>::Matrix (size_t rows, size_t columns)
        : Matrix{DimensionType{rows, columns}}
    {
    }
    template <typename T>
    Matrix<T>::Matrix (const DimensionType& dimensions, Common::ArgByValueType<T> fillValue)
        : fRep_{make_shared<Rep_> (dimensions)}
    {
        for (size_t r = 0; r < dimensions.fRows; ++r) {
            for (size_t c = 0; c < dimensions.fColumns; ++c) {
                fRep_.rwget ()->push_back (fillValue);
            }
        }
    }
    template <typename T>
    inline Matrix<T>::Matrix (size_t rows, size_t columns, Common::ArgByValueType<T> fillValue)
        : Matrix{DimensionType{rows, columns}, fillValue}
    {
    }
    template <typename T>
    Matrix<T>::Matrix (const DimensionType& dimensions, const function<T ()>& filler)
        : fRep_{make_shared<Rep_> (dimensions)}
    {
        for (size_t r = 0; r < dimensions.fRows; ++r) {
            for (size_t c = 0; c < dimensions.fColumns; ++c) {
                fRep_.rwget ()->push_back (filler ());
            }
        }
    }
    template <typename T>
    Matrix<T> Matrix<T>::Identity (const DimensionType& dimensions)
    {
        size_t row = 0;
        size_t col = 0;
        return Matrix{dimensions, [&] () {
                          T result = (row == col) ? 1 : 0;
                          ++col;
                          if (col > dimensions.fColumns) {
                              col = 0;
                              ++row;
                          }
                      }};
    }
    template <typename T>
    inline auto Matrix<T>::GetDimensions () const -> DimensionType
    {
        return fRep_.cget ()->GetDimensions ();
    }
    template <typename T>
    Containers::Sequence<Vector<T>> Matrix<T>::GetRows () const
    {
        Containers::Sequence<Vector<T>> result;
        DimensionType                   dim = GetDimensions ();
        for (size_t r = 0; r < dim.fRows; ++r) {
            vector<T> row;
            for (size_t c = 0; c < dim.fColumns; ++c) {
                row.push_back (fRep_.cget ()->GetAt (r, c));
            }
            result += Vector<T>{row};
        }
        return result;
    }
    template <typename T>
    Containers::Sequence<Vector<T>> Matrix<T>::GetColumns () const
    {
        Containers::Sequence<Vector<T>> result;
        DimensionType                   dim = GetDimensions ();
        for (size_t c = 0; c < dim.fColumns; ++c) {
            vector<T> col;
            for (size_t r = 0; r < dim.fRows; ++r) {
                col.push_back (fRep_.cget ()->GetAt (r, c));
            }
            result += Vector<T>{col};
        }
        return result;
    }
    template <typename T>
    inline T Matrix<T>::GetAt (size_t r, size_t c) const
    {
        return fRep_.cget ()->GetAt (r, c);
    }
    template <typename T>
    inline void Matrix<T>::SetAt (size_t r, size_t c, T v)
    {
        fRep_.rwget ()->SetAt (r, c, v);
    }
    template <typename T>
    inline const typename Matrix<T>::ReadOnlyTemporaryRowReference_ Matrix<T>::operator[] (size_t row) const
    {
        return ReadOnlyTemporaryRowReference_{*this, row};
    }
    template <typename T>
    Characters::String Matrix<T>::ToString () const
    {
        Characters::StringBuilder sb;
        sb << "["sv;
        for (size_t row = 0; row < GetDimensions ().fRows; ++row) {
            sb << "["sv;
            for (size_t col = 0; col < GetDimensions ().fColumns; ++col) {
                sb << GetAt (row, col) << ", "sv;
            }
            sb << "],"sv;
        }
        sb << "]"sv;
        return sb;
    }
 
}