matpackIV.h

Go to the documentation of this file.

/* Copyright (C) 2002-2012
   Stefan Buehler <sbuehler@ltu.se>
   Wolfram-Andre Haas <wolhaas@hermes.fho-emden.de>
 
   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 matpackIV_h
#define matpackIV_h
 
#include <utility>
 
#include "matpackIII.h"
 
class Iterator4D {
 public:
  // Constructors:
  Iterator4D() = default;
 
  Iterator4D(const Tensor3View& x, Index stride)
      : msv(x), mstride(stride) { /* Nothing to do here. */
  }
 
  // Operators:
  Iterator4D& operator++() {
    msv.mdata += mstride;
    return *this;
  }
 
  bool operator!=(const Iterator4D& other) const {
    if (msv.mdata + msv.mpr.mstart + msv.mrr.mstart + msv.mcr.mstart !=
        other.msv.mdata + other.msv.mpr.mstart + other.msv.mrr.mstart +
            other.msv.mcr.mstart)
      return true;
    return false;
  }
 
  Tensor3View* operator->();
  Tensor3View& operator*();
 
 private:
  Tensor3View msv;
  Index mstride{0};
};
 
class ConstIterator4D {
 public:
  // Constructors:
  // Functions for ConstIterator4D
  // -----------------------------
 
  ConstIterator4D() = default;
 
  ConstIterator4D(ConstTensor3View x, Index stride)
      : msv(std::move(x)), mstride(stride) { /* Nothing to do here. */
  }
 
  // Operators:
  ConstIterator4D& operator++() {
    msv.mdata += mstride;
    return *this;
  }
 
  bool operator!=(const ConstIterator4D& other) const {
    if (msv.mdata + msv.mpr.mstart + msv.mrr.mstart + msv.mcr.mstart !=
        other.msv.mdata + other.msv.mpr.mstart + other.msv.mrr.mstart +
            other.msv.mcr.mstart)
      return true;
    return false;
  }
 
  const ConstTensor3View* operator->() const;
  const ConstTensor3View& operator*() const;
 
 private:
  ConstTensor3View msv;
  Index mstride{0};
};
 
// Declare class Tensor4:
class Tensor4;
 
class ConstTensor4View {
 public:
  static constexpr bool matpack_type{true};
  
  constexpr ConstTensor4View(const ConstTensor4View&) = default;
  constexpr ConstTensor4View(ConstTensor4View&&) = default;
  ConstTensor4View& operator=(const ConstTensor4View&) = default;
  ConstTensor4View& operator=(ConstTensor4View&&) = default;
 
  // Member functions:
  [[nodiscard]] Index nbooks() const noexcept { return mbr.mextent; }
  [[nodiscard]] Index npages() const noexcept { return mpr.mextent; }
  [[nodiscard]] Index nrows() const noexcept { return mrr.mextent; }
  [[nodiscard]] Index ncols() const noexcept { return mcr.mextent; }
 
  // Total size
  [[nodiscard]] Index size() const noexcept {
    return nbooks() * npages() * nrows() * ncols();
  }
  [[nodiscard]] bool empty() const noexcept { return size() == 0; }
 
  [[nodiscard]] Shape<4> shape() const {
    return {nbooks(), npages(), nrows(), ncols()};
  }
 
  // Const index operators:
  ConstTensor4View operator()(const Range& b,
                              const Range& p,
                              const Range& r,
                              const Range& c) const;
 
  ConstTensor3View operator()(const Range& b,
                              const Range& p,
                              const Range& r,
                              Index c) const;
  ConstTensor3View operator()(const Range& b,
                              const Range& p,
                              Index r,
                              const Range& c) const;
  ConstTensor3View operator()(const Range& b,
                              Index p,
                              const Range& r,
                              const Range& c) const;
  ConstTensor3View operator()(Index b,
                              const Range& p,
                              const Range& r,
                              const Range& c) const;
 
  ConstMatrixView operator()(const Range& b,
                             const Range& p,
                             Index r,
                             Index c) const;
  ConstMatrixView operator()(const Range& b,
                             Index p,
                             const Range& r,
                             Index c) const;
  ConstMatrixView operator()(const Range& b,
                             Index p,
                             Index r,
                             const Range& c) const;
  ConstMatrixView operator()(Index b,
                             const Range& p,
                             Index r,
                             const Range& c) const;
  ConstMatrixView operator()(Index b,
                             const Range& p,
                             const Range& r,
                             Index c) const;
  ConstMatrixView operator()(Index b,
                             Index p,
                             const Range& r,
                             const Range& c) const;
 
  ConstVectorView operator()(const Range& b, Index p, Index r, Index c) const;
  ConstVectorView operator()(Index b, const Range& p, Index r, Index c) const;
  ConstVectorView operator()(Index b, Index p, const Range& r, Index c) const;
  ConstVectorView operator()(Index b, Index p, Index r, const Range& c) const;
 
  Numeric operator()(Index b,
                     Index p,
                     Index r,
                     Index c) const {  // Check if indices are valid:
    ARTS_ASSERT(0 <= b);
    ARTS_ASSERT(0 <= p);
    ARTS_ASSERT(0 <= r);
    ARTS_ASSERT(0 <= c);
    ARTS_ASSERT(b < mbr.mextent);
    ARTS_ASSERT(p < mpr.mextent);
    ARTS_ASSERT(r < mrr.mextent);
    ARTS_ASSERT(c < mcr.mextent);
 
    return get(b, p, r, c);
  }
 
  [[nodiscard]] Numeric get(Index b, Index p, Index r, Index c) const {
    return *(mdata + mbr.mstart + b * mbr.mstride + mpr.mstart +
             p * mpr.mstride + mrr.mstart + r * mrr.mstride + mcr.mstart +
             c * mcr.mstride);
  }
 
  // Functions returning iterators:
  [[nodiscard]] ConstIterator4D begin() const;
  [[nodiscard]] ConstIterator4D end() const;
 
  virtual ~ConstTensor4View() = default;
 
  // Friends:
  friend class Tensor4View;
  friend class ConstIterator5D;
  friend class ConstTensor5View;
  friend class ConstTensor6View;
  friend class ConstTensor7View;
 
  friend std::ostream& operator<<(std::ostream& os, const ConstTensor4View& v);
 
  // Special constructor to make a Tensor4 view of a Tensor3.
  ConstTensor4View(const ConstTensor3View& a);
 
 protected:
  // Constructors:
  ConstTensor4View() = default;
  ConstTensor4View(Numeric* data,
                   const Range& b,
                   const Range& p,
                   const Range& r,
                   const Range& c);
  ConstTensor4View(Numeric* data,
                   const Range& pb,
                   const Range& pp,
                   const Range& pr,
                   const Range& pc,
                   const Range& nb,
                   const Range& np,
                   const Range& nr,
                   const Range& nc);
 
  // Data members:
  // -------------
  Range mbr{0, 0, 1};
  Range mpr{0, 0, 1};
  Range mrr{0, 0, 1};
  Range mcr{0, 0, 1};
  Numeric* mdata{nullptr};
};
 
class Tensor4View : public ConstTensor4View {
 public:
  // Make const methods visible from base class
  using ConstTensor4View::begin;
  using ConstTensor4View::end;
  using ConstTensor4View::operator();
  using ConstTensor4View::get;
 
  constexpr Tensor4View(const Tensor4View&) = default;
 
  // Non-const index operators:
 
  Tensor4View operator()(const Range& b,
                         const Range& p,
                         const Range& r,
                         const Range& c);
 
  Tensor3View operator()(const Range& b,
                         const Range& p,
                         const Range& r,
                         Index c);
  Tensor3View operator()(const Range& b,
                         const Range& p,
                         Index r,
                         const Range& c);
  Tensor3View operator()(const Range& b,
                         Index p,
                         const Range& r,
                         const Range& c);
  Tensor3View operator()(Index b,
                         const Range& p,
                         const Range& r,
                         const Range& c);
 
  MatrixView operator()(const Range& b, const Range& p, Index r, Index c);
  MatrixView operator()(const Range& b, Index p, const Range& r, Index c);
  MatrixView operator()(const Range& b, Index p, Index r, const Range& c);
  MatrixView operator()(Index b, const Range& p, Index r, const Range& c);
  MatrixView operator()(Index b, const Range& p, const Range& r, Index c);
  MatrixView operator()(Index b, Index p, const Range& r, const Range& c);
 
  VectorView operator()(const Range& b, Index p, Index r, Index c);
  VectorView operator()(Index b, const Range& p, Index r, Index c);
  VectorView operator()(Index b, Index p, const Range& r, Index c);
  VectorView operator()(Index b, Index p, Index r, const Range& c);
 
#define GETFUN(b, p, r, c)                                                \
  *(mdata + mbr.mstart + b * mbr.mstride + mpr.mstart + p * mpr.mstride + \
    mrr.mstart + r * mrr.mstride + mcr.mstart + c * mcr.mstride)
  Numeric& operator()(Index b,
                      Index p,
                      Index r,
                      Index c) {  // Check if indices are valid:
    ARTS_ASSERT(0 <= b);
    ARTS_ASSERT(0 <= p);
    ARTS_ASSERT(0 <= r);
    ARTS_ASSERT(0 <= c);
    ARTS_ASSERT(b < mbr.mextent);
    ARTS_ASSERT(p < mpr.mextent);
    ARTS_ASSERT(r < mrr.mextent);
    ARTS_ASSERT(c < mcr.mextent);
 
    return GETFUN(b, p, r, c);
  }
 
  Numeric& get(Index b, Index p, Index r, Index c) {
    return GETFUN(b, p, r, c);
  }
#undef GETFUN
 
  // Conversion to a plain C-array
  [[nodiscard]] const Numeric* get_c_array() const ARTS_NOEXCEPT;
  Numeric* get_c_array() ARTS_NOEXCEPT;
 
  // Functions returning iterators:
  Iterator4D begin();
  Iterator4D end();
 
  // Assignment operators:
  Tensor4View& operator=(const ConstTensor4View& v);
  Tensor4View& operator=(const Tensor4View& v);
  Tensor4View& operator=(const Tensor4& v);
  Tensor4View& operator=(Numeric x);
 
  // Other operators:
  Tensor4View& operator*=(Numeric x);
  Tensor4View& operator/=(Numeric x);
  Tensor4View& operator+=(Numeric x);
  Tensor4View& operator-=(Numeric x);
 
  Tensor4View& operator*=(const ConstTensor4View& x);
  Tensor4View& operator/=(const ConstTensor4View& x);
  Tensor4View& operator+=(const ConstTensor4View& x);
  Tensor4View& operator-=(const ConstTensor4View& x);
 
  ~Tensor4View() override = default;
 
  // Friends:
  // friend class VectorView;
  // friend ConstTensor4View transpose(ConstTensor4View m);
  // friend Tensor4View transpose(Tensor4View m);
  friend class Iterator5D;
  friend class Tensor5View;
  friend class Tensor6View;
  friend class Tensor7View;
 
  // Special constructor to make a Tensor4 view of a Tensor3.
  Tensor4View(const Tensor3View& a);
 
 protected:
  // Constructors:
  Tensor4View() = default;
  Tensor4View(Numeric* data,
              const Range& b,
              const Range& p,
              const Range& r,
              const Range& c);
  Tensor4View(Numeric* data,
              const Range& pb,
              const Range& pp,
              const Range& pr,
              const Range& pc,
              const Range& nb,
              const Range& np,
              const Range& nr,
              const Range& nc);
};
 
class Tensor4 : public Tensor4View {
 public:
  // Constructors:
  Tensor4() = default;
  Tensor4(Index b, Index p, Index r, Index c);
  Tensor4(Index b, Index p, Index r, Index c, Numeric fill);
  Tensor4(const ConstTensor4View& v);
  Tensor4(const Tensor4& v);
  Tensor4(Tensor4&& v) noexcept : Tensor4View(std::forward<Tensor4View>(v)) {
    v.mdata = nullptr;
  }
 
  explicit Tensor4(const matpack::tensor4_like_not_tensor4 auto &init)
      : Tensor4(matpack::book_size(init), matpack::page_size(init),
                matpack::row_size(init), matpack::column_size(init)) {
    *this = init;
  }
 
  Tensor4 &operator=(const matpack::tensor4_like_not_tensor4 auto &init) {
    if (const auto s = matpack::shape<Index, 4>(init); shape().data not_eq s)
      resize(s[0], s[1], s[2], s[3]);
 
    auto [I, J, K, L] = shape().data;
    for (Index i = 0; i < I; i++)
      for (Index j = 0; j < J; j++)
        for (Index k = 0; k < K; k++)
          for (Index x = 0; x < L; x++)
            operator()(i, j, k, x) = init(i, j, k, x);
 
    return *this;
  }
 
  Tensor4(Numeric* d,
          const Range& r0,
          const Range& r1,
          const Range& r2,
          const Range& r3) ARTS_NOEXCEPT : Tensor4View(d, r0, r1, r2, r3) {
    ARTS_ASSERT(not(r0.get_extent() < 0), "Must have size");
    ARTS_ASSERT(not(r1.get_extent() < 0), "Must have size");
    ARTS_ASSERT(not(r2.get_extent() < 0), "Must have size");
    ARTS_ASSERT(not(r3.get_extent() < 0), "Must have size");
  }
 
  // Assignment operators:
  Tensor4& operator=(const Tensor4& x);
  Tensor4& operator=(Tensor4&& x) ARTS_NOEXCEPT;
  Tensor4& operator=(Numeric x);
 
  // Resize function:
  void resize(Index b, Index p, Index r, Index c);
 
  // Swap function:
  friend void swap(Tensor4& t1, Tensor4& t2) noexcept;
 
  // Destructor:
  ~Tensor4() noexcept override;
  
  // Returns data as a Vector
  Vector flatten() && ARTS_NOEXCEPT;
 
  template <std::size_t dim0>
      Vector reduce_rank() && ARTS_NOEXCEPT {
    static_assert(dim0 < 4, "Bad Dimension, Out-of-Bounds");
 
    Range r0(0,
             dim0 == 0   ? nbooks()
             : dim0 == 1 ? npages()
             : dim0 == 2 ? nrows()
                         : ncols());
 
    Vector out(mdata, r0);
    ARTS_ASSERT(size() == out.size(),
                "Can only reduce size on same size input");
    mdata = nullptr;
    return out;
  }
 
  template <std::size_t dim0, std::size_t dim1>
      Matrix reduce_rank() && ARTS_NOEXCEPT {
    static_assert(dim1 < 4, "Bad Dimension, Out-of-Bounds");
    static_assert(dim0 < dim1, "Bad Dimensions, dim1 must be larger than dim0");
 
    const Range r1(0, dim1 == 1 ? npages() : dim1 == 2 ? nrows() : ncols());
    const Range r0(0,
                   dim0 == 0   ? nbooks()
                   : dim0 == 1 ? npages()
                               : nrows(),
                   r1.get_extent());
 
    Matrix out(mdata, r0, r1);
    ARTS_ASSERT(size() == out.size(),
                "Can only reduce size on same size input");
    mdata = nullptr;
    return out;
  }
 
  template <std::size_t dim0, std::size_t dim1, std::size_t dim2>
      Tensor3 reduce_rank() && ARTS_NOEXCEPT {
    static_assert(dim2 < 4, "Bad Dimension, Out-of-Bounds");
    static_assert(dim0 < dim1, "Bad Dimensions, dim1 must be larger than dim0");
    static_assert(dim1 < dim2, "Bad Dimensions, dim2 must be larger than dim1");
 
    const Range r2(0, dim2 == 2 ? nrows() : ncols());
    const Range r1(0, dim1 == 1 ? npages() : nrows(), r2.get_extent());
    const Range r0(
        0, dim0 == 0 ? nbooks() : npages(), r1.get_extent() * r2.get_extent());
 
    Tensor3 out(mdata, r0, r1, r2);
    ARTS_ASSERT(size() == out.size(),
                "Can only reduce size on same size input");
    mdata = nullptr;
    return out;
  }
 
  template <class F>
  void transform_elementwise(F&& func) {
    std::transform(mdata, mdata + size(), mdata, func);
  }
};
 
// Function declarations:
// ----------------------
 
void copy(ConstIterator4D origin,
          const ConstIterator4D& end,
          Iterator4D target);
 
void copy(Numeric x, Iterator4D target, const Iterator4D& end);
 
void transform(Tensor4View y, double (&my_func)(double), ConstTensor4View x);
 
Numeric max(const ConstTensor4View& x);
 
Numeric min(const ConstTensor4View& x);
 
// Helper function for debugging
#ifndef NDEBUG
 
Numeric debug_tensor4view_get_elem(
    Tensor4View& tv, Index b, Index p, Index r, Index c);
 
#endif
 
using ArrayOfTensor4 = Array<Tensor4>;
 
using ArrayOfArrayOfTensor4 = Array<ArrayOfTensor4>;
 
#endif  // matpackIV_h