DiagonalMatrixRange.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_DIAGONALMATRIXRANGE_H
#define MYRAMATH_DENSE_DIAGONALMATRIXRANGE_H

#include <myramath/utility/Number.h>
#include <myramath/utility/detail/LIBPUBLIC.h>

#include <iosfwd>

namespace myra {

// Forward declarations.
template<int Arity, class Number> class Expression;
template<class Number> class  Matrix;
template<class Number> class  MatrixRange;
template<class Number> class CMatrixRange;
template<class Number> class  Vector;
template<class Number> class  VectorRange;
template<class Number> class CVectorRange;
template<class Number> class  DiagonalMatrixRange;
template<class Number> class CDiagonalMatrixRange;
class OutputStream;

template<class Number> class LIBPUBLIC DiagonalMatrixRange
  {
  public:

    Number* begin;
    int N;

    // Useful typedef.
    typedef std::pair<DiagonalMatrixRange<Number>, DiagonalMatrixRange<Number> > Pair;

    // ------------------------------------ Construction and range semantics.

    DiagonalMatrixRange();

    DiagonalMatrixRange(Number* in_begin, int in_N);

    void write(OutputStream& out) const;

    // ------------------------------------ Size queries.

    int size() const;

    int n_words() const; 

    // ------------------------------------ General slicing.

    const CDiagonalMatrixRange<Number> add_const() const;

    operator const CDiagonalMatrixRange<Number>() const;

    const DiagonalMatrixRange<Number> window(int n0, int n1) const;

    const VectorRange<Number> vector() const;

    Number& operator() (int n) const;

    Number& at(int n) const;

    Matrix<Number> make_Matrix() const;
    void make_Matrix(const MatrixRange<Number>& A) const;

    Vector<Number> make_Vector() const;
    void make_Vector(const VectorRange<Number>& A) const;
    
    // ------------------------------------ Diagonal slicing.

    const DiagonalMatrixRange<Number> first(int n) const;

    const DiagonalMatrixRange<Number> cut_first(int n) const;

    const Pair split_first(int n) const;

    const DiagonalMatrixRange<Number> last(int n) const;

    const DiagonalMatrixRange<Number> cut_last(int n) const;

    const Pair split_last(int n) const;

    // ------------------------------------ Mutating underlying contents.

    // Functor f should be a have an operator(), that takes a Number and returns a Number.
    template<class Functor> void transform(const Functor& f) const
      {
      for (int n = 0; n < N; ++n)
        *pointer(n) = f( *pointer(n) );
      }

    void assign(const CDiagonalMatrixRange<Number>& that) const;
    void assign(const Expression<1,Number>& that) const;

    void operator += (const CDiagonalMatrixRange<Number>& that) const;
    void operator += (const Expression<1,Number>& that) const;

    void operator -= (const CDiagonalMatrixRange<Number>& that) const;
    void operator -= (const Expression<1,Number>& that) const;
    
    void operator *= (Number alpha) const;

    void operator /= (Number alpha) const;

    void zero() const;
    
  private:
  
    // Returns pointer to n'th entry.
    Number* pointer(int n) const;

    // Throws if that is not the same size as *this.
    void check_size(const CDiagonalMatrixRange<Number>& that) const;

    // Throws if S is not the same size as *this.
    void check_size(int S) const;
    
  };

template<class Number> class LIBPUBLIC CDiagonalMatrixRange
  {
  public:

    const Number* begin;
    int N;

    // Useful typedef.
    typedef std::pair<CDiagonalMatrixRange<Number>, CDiagonalMatrixRange<Number> > Pair;

    // ------------------------------------ Construction and range semantics.

    CDiagonalMatrixRange();

    CDiagonalMatrixRange(const Number* in_begin, int in_N);

    void write(OutputStream& out) const;

    // ------------------------------------ Size queries.

    int size() const;

    int n_words() const; 

    // ------------------------------------ General slicing.

    const DiagonalMatrixRange<Number> remove_const() const;

    const CDiagonalMatrixRange<Number> window(int n0, int n1) const;
 
    const CVectorRange<Number> vector() const;

    const Number& operator() (int n) const;

    const Number& at(int n) const;

    Matrix<Number> make_Matrix() const;
    void make_Matrix(const MatrixRange<Number>& A) const;

    Vector<Number> make_Vector() const;
    void make_Vector(const VectorRange<Number>& A) const;
    
    // ------------------------------------ Diagonal slicing.

    const CDiagonalMatrixRange<Number> first(int n) const;

    const CDiagonalMatrixRange<Number> cut_first(int n) const;

    const Pair split_first(int n) const;

    const CDiagonalMatrixRange<Number> last(int n) const;

    const CDiagonalMatrixRange<Number> cut_last(int n) const;

    const Pair split_last(int n) const;

  private:
    
    // Returns pointer to n'th entry.
    const Number* pointer(int n) const;
    
  };

template<class Number> class ReflectNumber< DiagonalMatrixRange<Number> >
  { public: typedef Number type; };

template<class Number> class ReflectNumber< CDiagonalMatrixRange<Number> >
  { public: typedef Number type; };

LIBPUBLIC std::ostream& operator << (std::ostream& out, const CDiagonalMatrixRange<NumberS>& a);
LIBPUBLIC std::ostream& operator << (std::ostream& out, const CDiagonalMatrixRange<NumberD>& a);
LIBPUBLIC std::ostream& operator << (std::ostream& out, const CDiagonalMatrixRange<NumberC>& a);
LIBPUBLIC std::ostream& operator << (std::ostream& out, const CDiagonalMatrixRange<NumberZ>& a);

} // namespace myra

#endif