PivotMatrix.h

Go to the documentation of this file.

// ========================================================================= //
// This file is part of MyraMath, copyright (c) 2014-2019 by Ryan A Chilton  //
// and distributed by MyraCore, LLC. See LICENSE.txt for license terms.      //
// ========================================================================= //

#ifndef MYRAMATH_DENSE_PIVOTMATRIX_H
#define MYRAMATH_DENSE_PIVOTMATRIX_H

#include <myramath/MYRAMATH_EXPORT.h>
#include <myramath/utility/Number.h>

#include <myramath/dense/Matrix22.h>

#include <vector>

namespace myra {

// Forward declarations.
class InputStream;
class OutputStream;
template<class Number> class Matrix;

template<class Number> class MYRAMATH_EXPORT PivotMatrix
  {
  public:

    typedef std::vector<int> Offsets;
    typedef Matrix22<Number> Pivot;
    typedef std::vector<Pivot> Pivots;
    typedef MatrixRange<Number> Range;
    typedef CMatrixRange<Number> CRange;

    // ------------------------------------ Construction, serialization, value semantics.

    PivotMatrix();

    PivotMatrix(int in_N);

    PivotMatrix(const PivotMatrix<Number>& that);
    
    void swap(PivotMatrix<Number>& that);

    PivotMatrix<Number>& operator = (PivotMatrix that);

    explicit PivotMatrix(InputStream& in);

    void write(OutputStream& out) const;

    // ------------------------------------ Initialization API.

    Matrix22<Number>& operator[] (int n);

    void push_back(const PivotMatrix<Number>& that);

    void conjugate();

    void transpose();

    void hermitian();

    void reverse();

    // ------------------------------------ Solve API.

    //    side  = Solve by A from the 'L'eft or from the 'R'ight?
    //    op    = Apply an operation to A? ('T'ranspose, 'H'ermitian, 'C'onjugate or 'N'othing)
    void solve(const Range& B, char side, char op) const;

    //    side  = Solve by A from the 'L'eft or from the 'R'ight?
    //    op    = Apply an operation to A? ('T'ranspose, 'H'ermitian, 'C'onjugate or 'N'othing)
    void multiply(const Range& B, char side, char op) const;

    Matrix<Number> make_Matrix() const;

  private:

    // Implements solve(B,'L'eft,op)
    void solve_left(const Range& B, char op) const;
    
    // Implements solve(B,'R'ight,op)
    void solve_right(const Range& B, char op) const;

    // Implements solve(B,'L'eft,op)
    void multiply_left(const Range& B, char op) const;
    
    // Implements solve(B,'R'ight,op)
    void multiply_right(const Range& B, char op) const;

    // Returns op(inverse(pivot))
    Matrix22<Number> apply_op(char op, const Matrix22<Number>& pivot) const;

    // Underlying system size.
    int N;

    // Row/column offsets.
    Offsets offsets;

    // Numeric contents.
    Pivots pivots;
    
  };

} // namespace

#endif