Commit 584516d4 authored by Tomáš Oberhuber's avatar Tomáš Oberhuber
Browse files

Writting documentation on tridiagonal matrix.

parent 90d4cebc

src/TNL/Matrices/MultidiagonalMatrix.h

+130 −127
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ namespace TNL { 
namespace Matrices {



/**

 * \brief Implementation of sparse multi-diagonal matrix.

 * \brief Implementation of sparse multidiagonal matrix.

 *

 * Use this matrix type for storing of matrices where the offsets of non-zero elements

 * from the diagonal are the same in each row. Typically such matrices arise from
@@ -202,11 +202,14 @@ class MultidiagonalMatrix : public Matrix< Real, Device, Index, RealAllocator > 
       *

       * The number of matrix rows is deduced from the size of the initializer list \e data.

       *

       * \tparam ListIndex is type used in the initializer list defining matrix diagonals offsets.

       * \tparam ListReal is type used in the initializer list defining matrix elements values.

       *

       * \param columns is number of matrix columns.

       * \param diagonalOffsets are offsets of sub-diagonals from the main diagonal.

       * \param data is initializer list holding matrix elements. The size of the outer list

       *    defines the number of matrix rows. Each inner list defines values of each sub-diagonal

       *    and so its size must be lower or equal to the size of \e diagonalsOffsets. Values

       *    and so its size should be lower or equal to the size of \e diagonalsOffsets. Values

       *    of sub-diagonals which do not fit to given row are omitted.

       *

       * \par Example
@@ -315,7 +318,7 @@ class MultidiagonalMatrix : public Matrix< Real, Device, Index, RealAllocator > 
       *

       * \param data is initializer list holding matrix elements. The size of the outer list

       *    defines the number of matrix rows. Each inner list defines values of each sub-diagonal

       *    and so its size must be lower or equal to the size of \e diagonalsOffsets. Values

       *    and so its size should be lower or equal to the size of \e diagonalsOffsets. Values

       *    of sub-diagonals which do not fit to given row are omitted.

       *

       * \par Example
@@ -659,7 +662,7 @@ class MultidiagonalMatrix : public Matrix< Real, Device, Index, RealAllocator > 
      void allRowsReduction( Fetch& fetch, Reduce& reduce, Keep& keep, const FetchReal& zero ) const;



      /**

       * \brief Method for iteration over all matrix rows for constant instances.

       * \brief Method for iteration over matrix rows for constant instances.

       *

       * \tparam Function is type of lambda function that will operate on matrix elements.

       *    It is should have form like
@@ -678,10 +681,10 @@ class MultidiagonalMatrix : public Matrix< Real, Device, Index, RealAllocator > 
       * \include MultidiagonalMatrixExample_forRows.out

       */

      template< typename Function >

      void forRows( IndexType first, IndexType last, Function& function ) const;

      void forRows( IndexType begin, IndexType end, Function& function ) const;



      /**

       * \brief Method for iteration over all matrix rows for non-constant instances.

       * \brief Method for iteration over matrix rows for non-constant instances.

       *

       * \tparam Function is type of lambda function that will operate on matrix elements.

       *    It is should have form like
@@ -700,7 +703,7 @@ class MultidiagonalMatrix : public Matrix< Real, Device, Index, RealAllocator > 
       * \include MultidiagonalMatrixExample_forRows.out

       */

      template< typename Function >

      void forRows( IndexType first, IndexType last, Function& function );

      void forRows( IndexType begin, IndexType end, Function& function );



      /**

       * \brief This method calls \e forRows for all matrix rows (for constant instances).

src/TNL/Matrices/Tridiagonal.h

deleted100644 → 0
+0 −196
Original line number Diff line number Diff line 
/***************************************************************************

                          Tridiagonal.h  -  description

                             -------------------

    begin                : Nov 30, 2013

    copyright            : (C) 2013 by Tomas Oberhuber

    email                : tomas.oberhuber@fjfi.cvut.cz

 ***************************************************************************/



/* See Copyright Notice in tnl/Copyright */



#pragma once



#include <TNL/Matrices/Matrix.h>

#include <TNL/Containers/Vector.h>

#include <TNL/Matrices/TridiagonalMatrixRowView.h>

#include <TNL/Containers/Segments/Ellpack.h>

#include <TNL/Matrices/details/TridiagonalMatrixIndexer.h>

#include <TNL/Matrices/TridiagonalMatrixView.h>



namespace TNL {

namespace Matrices {



template< typename Real = double,

          typename Device = Devices::Host,

          typename Index = int,

          ElementsOrganization Organization = Containers::Segments::DefaultElementsOrganization< Device >::getOrganization(),

          typename RealAllocator = typename Allocators::Default< Device >::template Allocator< Real > >

class Tridiagonal : public Matrix< Real, Device, Index, RealAllocator >

{

   public:

      using RealType = Real;

      using DeviceType = Device;

      using IndexType = Index;

      using RealAllocatorType = RealAllocator;

      using BaseType = Matrix< Real, Device, Index, RealAllocator >;

      using IndexerType = details::TridiagonalMatrixIndexer< IndexType, Organization >;

      using ValuesVectorType = typename BaseType::ValuesVectorType;

      using ValuesViewType = typename ValuesVectorType::ViewType;

      using ViewType = TridiagonalMatrixView< Real, Device, Index, Organization >;

      using ConstViewType = TridiagonalMatrixView< typename std::add_const< Real >::type, Device, Index, Organization >;

      using RowView = TridiagonalMatrixRowView< ValuesViewType, IndexerType >;



      // TODO: remove this - it is here only for compatibility with original matrix implementation

      typedef Containers::Vector< IndexType, DeviceType, IndexType > CompressedRowLengthsVector;

      typedef Containers::VectorView< IndexType, DeviceType, IndexType > CompressedRowLengthsVectorView;

      typedef typename CompressedRowLengthsVectorView::ConstViewType ConstCompressedRowLengthsVectorView;



      template< typename _Real = Real,

                typename _Device = Device,

                typename _Index = Index >

      using Self = Tridiagonal< _Real, _Device, _Index >;



      static constexpr ElementsOrganization getOrganization() { return Organization; };



      Tridiagonal();



      Tridiagonal( const IndexType rows, const IndexType columns );



      ViewType getView() const; // TODO: remove const



      //ConstViewType getConstView() const;



      static String getSerializationType();



      virtual String getSerializationTypeVirtual() const;



      void setDimensions( const IndexType rows,

                          const IndexType columns );



      //template< typename Vector >

      void setCompressedRowLengths( const ConstCompressedRowLengthsVectorView rowCapacities );



      template< typename Vector >

      void getCompressedRowLengths( Vector& rowLengths ) const;



      [[deprecated]]

      IndexType getRowLength( const IndexType row ) const;



      IndexType getMaxRowLength() const;



      template< typename Real_, typename Device_, typename Index_, ElementsOrganization Organization_, typename RealAllocator_ >

      void setLike( const Tridiagonal< Real_, Device_, Index_, Organization_, RealAllocator_ >& m );



      IndexType getNumberOfNonzeroMatrixElements() const;



      void reset();



      template< typename Real_, typename Device_, typename Index_, ElementsOrganization Organization_, typename RealAllocator_ >

      bool operator == ( const Tridiagonal< Real_, Device_, Index_, Organization_, RealAllocator_ >& matrix ) const;



      template< typename Real_, typename Device_, typename Index_, ElementsOrganization Organization_, typename RealAllocator_ >

      bool operator != ( const Tridiagonal< Real_, Device_, Index_, Organization_, RealAllocator_ >& matrix ) const;



      __cuda_callable__

      RowView getRow( const IndexType& rowIdx );



      __cuda_callable__

      const RowView getRow( const IndexType& rowIdx ) const;



      void setValue( const RealType& v );



      void setElement( const IndexType row,

                       const IndexType column,

                       const RealType& value );



      void addElement( const IndexType row,

                       const IndexType column,

                       const RealType& value,

                       const RealType& thisElementMultiplicator = 1.0 );



      RealType getElement( const IndexType row,

                           const IndexType column ) const;



      template< typename Fetch, typename Reduce, typename Keep, typename FetchReal >

      void rowsReduction( IndexType first, IndexType last, Fetch& fetch, Reduce& reduce, Keep& keep, const FetchReal& zero ) const;



      template< typename Fetch, typename Reduce, typename Keep, typename FetchReal >

      void allRowsReduction( Fetch& fetch, Reduce& reduce, Keep& keep, const FetchReal& zero ) const;



      template< typename Function >

      void forRows( IndexType first, IndexType last, Function& function ) const;



      template< typename Function >

      void forRows( IndexType first, IndexType last, Function& function );



      template< typename Function >

      void forAllRows( Function& function ) const;



      template< typename Function >

      void forAllRows( Function& function );



      template< typename Vector >

      __cuda_callable__

      typename Vector::RealType rowVectorProduct( const IndexType row,

                                                  const Vector& vector ) const;



      template< typename InVector,

                typename OutVector >

      void vectorProduct( const InVector& inVector,

                          OutVector& outVector ) const;



      template< typename Real_, typename Device_, typename Index_, ElementsOrganization Organization_, typename RealAllocator_ >

      void addMatrix( const Tridiagonal< Real_, Device_, Index_, Organization_, RealAllocator_ >& matrix,

                      const RealType& matrixMultiplicator = 1.0,

                      const RealType& thisMatrixMultiplicator = 1.0 );



      template< typename Real2, typename Index2 >

      void getTransposition( const Tridiagonal< Real2, Device, Index2 >& matrix,

                             const RealType& matrixMultiplicator = 1.0 );



      template< typename Vector1, typename Vector2 >

      __cuda_callable__

      void performSORIteration( const Vector1& b,

                                const IndexType row,

                                Vector2& x,

                                const RealType& omega = 1.0 ) const;



      // copy assignment

      Tridiagonal& operator=( const Tridiagonal& matrix );



      // cross-device copy assignment

      template< typename Real_, typename Device_, typename Index_, ElementsOrganization Organization_, typename RealAllocator_ >

      Tridiagonal& operator=( const Tridiagonal< Real_, Device_, Index_, Organization_, RealAllocator_ >& matrix );



      void save( File& file ) const;



      void load( File& file );



      void save( const String& fileName ) const;



      void load( const String& fileName );



      void print( std::ostream& str ) const;



      const IndexerType& getIndexer() const;



      IndexerType& getIndexer();



      __cuda_callable__

      IndexType getPaddingIndex() const;



   protected:



      __cuda_callable__

      IndexType getElementIndex( const IndexType row,

                                 const IndexType localIdx ) const;



      IndexerType indexer;



      ViewType view;

};



} // namespace Matrices

} // namespace TNL



#include <TNL/Matrices/Tridiagonal.hpp>

src/TNL/Matrices/TridiagonalMatrix.h

0 → 100644
+815 −0

File added.

Preview size limit exceeded, changes collapsed.

src/TNL/Matrices/Tridiagonal.hpp→src/TNL/Matrices/TridiagonalMatrix.hpp

+80 −197

File changed and moved.

Preview size limit exceeded, changes collapsed.

src/TNL/Matrices/TridiagonalMatrixView.h

+5 −1
Original line number Diff line number Diff line
@@ -121,7 +121,11 @@ class TridiagonalMatrixView : public MatrixView< Real, Device, Index > 
      template< typename InVector,

                typename OutVector >

      void vectorProduct( const InVector& inVector,

                          OutVector& outVector ) const;

                          OutVector& outVector,

                          const RealType matrixMultiplicator = 1.0,

                          const RealType outVectorMultiplicator = 0.0,

                          const IndexType begin = 0,

                          IndexType end = 0 ) const;



      template< typename Real_, typename Device_, typename Index_, ElementsOrganization Organization_ >

      void addMatrix( const TridiagonalMatrixView< Real_, Device_, Index_, Organization_ >& matrix,