matpackIII.h

Go to the documentation of this file.

/* Copyright (C) 2001-2012 Stefan Buehler <sbuehler@ltu.se>

   This program is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by the
   Free Software Foundation; either version 2, or (at your option) any
   later version.

   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. */

#ifndef matpackIII_h
#define matpackIII_h

#include "matpackI.h"

class Iterator3D {
 public:
  // Constructors:
  Iterator3D() = default;

  Iterator3D(const MatrixView& x, Index stride)
      : msv(x), mstride(stride) { /* Nothing to do here. */
  }

  // Operators:
  Iterator3D& operator++() {
    msv.mdata += mstride;
    return *this;
  }

  bool operator!=(const Iterator3D& other) const {
    if (msv.mdata + msv.mrr.mstart + msv.mcr.mstart !=
        other.msv.mdata + other.msv.mrr.mstart + other.msv.mcr.mstart)
      return true;
    else
      return false;
  }

  MatrixView* operator->() { return &msv; }

  MatrixView& operator*() { return msv; }

 private:
  MatrixView msv;
  Index mstride{0};
};

class ConstIterator3D {
 public:
  // Constructors:
  ConstIterator3D() = default;

  ConstIterator3D(const ConstMatrixView& x, Index stride)
      : msv(x), mstride(stride) { /* Nothing to do here. */
  }

  // Operators:
  ConstIterator3D& operator++() {
    msv.mdata += mstride;
    return *this;
  }

  bool operator!=(const ConstIterator3D& other) const {
    if (msv.mdata + msv.mrr.mstart + msv.mcr.mstart !=
        other.msv.mdata + other.msv.mrr.mstart + other.msv.mcr.mstart)
      return true;
    else
      return false;
  }

  const ConstMatrixView* operator->() const { return &msv; }

  const ConstMatrixView& operator*() const { return msv; }

 private:
  ConstMatrixView msv;
  Index mstride{0};
};

// Declare class Tensor3:
class Tensor3;

class ConstTensor3View {
 public:
  constexpr ConstTensor3View(const ConstTensor3View&) = default;
  constexpr ConstTensor3View(ConstTensor3View&&) = default;
  ConstTensor3View& operator=(const ConstTensor3View&) = default;
  ConstTensor3View& operator=(ConstTensor3View&&) = default;

  // Member functions:

  bool empty() const;

  Index npages() const { return mpr.mextent; }

  Index nrows() const { return mrr.mextent; }

  Index ncols() const { return mcr.mextent; }

  // Const index operators:
  ConstTensor3View operator()(const Range& p,
                              const Range& r,
                              const Range& c) const;

  ConstMatrixView operator()(const Range& p, const Range& r, Index c) const;
  ConstMatrixView operator()(const Range& p, Index r, const Range& c) const;
  ConstMatrixView operator()(Index p, const Range& r, const Range& c) const;

  ConstVectorView operator()(Index p, Index r, const Range& c) const;
  ConstVectorView operator()(Index p, const Range& r, Index c) const;
  ConstVectorView operator()(const Range& p, Index r, Index c) const;

  Numeric operator()(Index p,
                     Index r,
                     Index c) const {  // Check if indices are valid:
    assert(0 <= p);
    assert(0 <= r);
    assert(0 <= c);
    assert(p < mpr.mextent);
    assert(r < mrr.mextent);
    assert(c < mcr.mextent);

    return get(p, r, c);
  }

  Numeric get(Index p, Index r, Index c) const {
    return *(mdata + mpr.mstart + p * mpr.mstride + mrr.mstart +
             r * mrr.mstride + mcr.mstart + c * mcr.mstride);
  }

  // Functions returning iterators:
  ConstIterator3D begin() const;
  ConstIterator3D end() const;

  virtual ~ConstTensor3View() = default;

  // Friends:
  friend class Tensor3View;
  friend class ConstIterator4D;
  friend class ConstTensor4View;
  friend class ConstTensor5View;
  friend class ConstTensor6View;
  friend class ConstTensor7View;

  // Special constructor to make a Tensor3 view of a matrix.
  ConstTensor3View(const ConstMatrixView& a);

 protected:
  // Constructors:
  ConstTensor3View() = default;
  ConstTensor3View(Numeric* data,
                   const Range& p,
                   const Range& r,
                   const Range& c);
  ConstTensor3View(Numeric* data,
                   const Range& pp,
                   const Range& pr,
                   const Range& pc,
                   const Range& np,
                   const Range& nr,
                   const Range& nc);

  // Data members:
  // -------------
  Range mpr{0, 0, 1};
  Range mrr{0, 0, 1};
  Range mcr{0, 0, 1};
  Numeric* mdata{nullptr};
};

class Tensor3View : public ConstTensor3View {
 public:
  // Make const methods visible from base class
  using ConstTensor3View::begin;
  using ConstTensor3View::end;
  using ConstTensor3View::operator();
  using ConstTensor3View::get;

  constexpr Tensor3View(const Tensor3View&) = default;

  // Non-const index operators:

  Tensor3View operator()(const Range& p, const Range& r, const Range& c);

  MatrixView operator()(const Range& p, const Range& r, Index c);
  MatrixView operator()(const Range& p, Index r, const Range& c);
  MatrixView operator()(Index p, const Range& r, const Range& c);

  VectorView operator()(Index p, Index r, const Range& c);
  VectorView operator()(Index p, const Range& r, Index c);
  VectorView operator()(const Range& p, Index r, Index c);

  Numeric& operator()(Index p, Index r, Index c) {
    // Check if indices are valid:
    assert(0 <= p);
    assert(0 <= r);
    assert(0 <= c);
    assert(p < mpr.mextent);
    assert(r < mrr.mextent);
    assert(c < mcr.mextent);

    return get(p, r, c);
  }

  Numeric& get(Index p, Index r, Index c) {
    return *(mdata + mpr.mstart + p * mpr.mstride + mrr.mstart +
             r * mrr.mstride + mcr.mstart + c * mcr.mstride);
  }

  // Conversion to a plain C-array
  const Numeric* get_c_array() const;
  Numeric* get_c_array();

  // Functions returning iterators:
  Iterator3D begin();
  Iterator3D end();

  // Assignment operators:
  Tensor3View& operator=(const ConstTensor3View& v);
  Tensor3View& operator=(const Tensor3View& v);
  Tensor3View& operator=(const Tensor3& v);
  Tensor3View& operator=(Numeric x);

  // Other operators:
  Tensor3View& operator*=(Numeric x);
  Tensor3View& operator/=(Numeric x);
  Tensor3View& operator+=(Numeric x);
  Tensor3View& operator-=(Numeric x);

  Tensor3View& operator*=(const ConstTensor3View& x);
  Tensor3View& operator/=(const ConstTensor3View& x);
  Tensor3View& operator+=(const ConstTensor3View& x);
  Tensor3View& operator-=(const ConstTensor3View& x);

  virtual ~Tensor3View() = default;

  // Friends:
  friend class Iterator4D;
  friend class Tensor4View;
  friend class Tensor5View;
  friend class Tensor6View;
  friend class Tensor7View;

  // Special constructor to make a Tensor3 view of a matrix.
  Tensor3View(const MatrixView& a);

 protected:
  // Constructors:
  Tensor3View() = default;
  Tensor3View(Numeric* data, const Range& p, const Range& r, const Range& c);
  Tensor3View(Numeric* data,
              const Range& pp,
              const Range& pr,
              const Range& pc,
              const Range& np,
              const Range& nr,
              const Range& nc);
};

class Tensor3 : public Tensor3View {
 public:
  // Constructors:
  Tensor3() = default;
  Tensor3(Index p, Index r, Index c);
  Tensor3(Index p, Index r, Index c, Numeric fill);
  Tensor3(const ConstTensor3View& v);
  Tensor3(const Tensor3& v);
  Tensor3(Tensor3&& v) noexcept : Tensor3View(std::forward<Tensor3View>(v)) {
    v.mdata = nullptr;
  }

  // Assignment operators:
  Tensor3& operator=(const Tensor3& x);
  Tensor3& operator=(Tensor3&& x) noexcept;
  Tensor3& operator=(Numeric x);

  // Resize function:
  void resize(Index p, Index r, Index c);

  // Swap function:
  friend void swap(Tensor3& t1, Tensor3& t2);

  // Destructor:
  virtual ~Tensor3();
};

// Function declarations:
// ----------------------

void copy(ConstIterator3D origin,
          const ConstIterator3D& end,
          Iterator3D target);

void copy(Numeric x, Iterator3D target, const Iterator3D& end);

void transform(Tensor3View y, double (&my_func)(double), ConstTensor3View x);

Numeric max(const ConstTensor3View& x);

Numeric min(const ConstTensor3View& x);

std::ostream& operator<<(std::ostream& os, const ConstTensor3View& v);

// Helper function for debugging
#ifndef NDEBUG

Numeric debug_tensor3view_get_elem(Tensor3View& tv, Index p, Index r, Index c);

#endif

void mult(Tensor3View A, const ConstVectorView B, const ConstMatrixView C);

#endif  // matpackIII_h