Array3dBoxConstRef.h

// -*-c++-*-
//----------------------------------------------------------------------------
//  xc utils library; general purpose classes and functions.
//
//  Copyright (C)  Luis C. Pérez Tato
//
//  XC utils 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 3 of the License, or 
//  (at your option) any later version.
//
//  This software 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, see <http://www.gnu.org/licenses/>.
//----------------------------------------------------------------------------
//Array3dBoxConstRef.h 

#ifndef ARRAY3DBOXCONSTREF_H
#define ARRAY3DBOXCONSTREF_H

#include "Array3dBoxRefBase.h"
#include "Array3dRange.h"


//
template <class ARRAY_3D>
class Array3dBoxConstRef: public Array3dBoxRefBase
  {
    const ARRAY_3D &ttz;
  public:
    typedef typename ARRAY_3D::const_reference const_reference;

    explicit Array3dBoxConstRef(const ARRAY_3D &t,const size_t &iLayer=1,const size_t &f= 1,const size_t &c= 1);
    Array3dBoxConstRef(const ARRAY_3D &t,const Array3dRange &rango);
    Array3dBoxConstRef(const ARRAY_3D &t,const RangoIndice &layer_range,const RangoIndice &row_range,const RangoIndice &column_range);
    Array3dBoxConstRef(const ARRAY_3D &t,const size_t &iLayer,const RangoIndice &row_range,const RangoIndice &column_range);
    Array3dBoxConstRef(const ARRAY_3D &t,const RangoIndice &layer_range,const size_t &iRow,const RangoIndice &column_range);
    Array3dBoxConstRef(const ARRAY_3D &t,const RangoIndice &layer_range,const RangoIndice &row_range,const size_t &iCol);
    Array3dBoxConstRef(const ARRAY_3D &t,const size_t &iLayer,const size_t &iRow,const RangoIndice &column_range);
    Array3dBoxConstRef(const ARRAY_3D &t,const size_t iLayer,const RangoIndice &row_range,const size_t &iCol);
    Array3dBoxConstRef(const ARRAY_3D &t,const RangoIndice &layer_range,const size_t &iRow,const size_t &iCol);
    inline virtual ~Array3dBoxConstRef(void) {}
    inline virtual const_reference operator()(size_t iLayer=1,size_t iRow=1,size_t iCol=1) const
      { return ttz(iLayer+offset_cp,iRow+offset_f,iCol+offset_c); }
  };

template<class ARRAY_3D>
Array3dBoxConstRef<ARRAY_3D>::Array3dBoxConstRef(const ARRAY_3D &t,const size_t &iLayer,const size_t &f,const size_t &c)
  : Array3dBoxRefBase(iLayer,f,c,t.getNumberOfLayers(),t.getNumberOfRows(),t.getNumberOfColumns()),ttz(t) {}

template<class ARRAY_3D>
Array3dBoxConstRef<ARRAY_3D>::Array3dBoxConstRef(const ARRAY_3D &t,const Array3dRange &rango)
  : Array3dBoxRefBase(clip(rango,t)),ttz(t) {}

template<class ARRAY_3D>
Array3dBoxConstRef<ARRAY_3D>::Array3dBoxConstRef(const ARRAY_3D &t,const RangoIndice &layer_range,const RangoIndice &row_range,const RangoIndice &column_range)
  : Array3dBoxRefBase(clip(layer_range,t.getNumberOfLayers()),clip(row_range,t.getNumberOfRows()),clip(column_range,t.getNumberOfColumns())),ttz(t) {}

template<class ARRAY_3D>
Array3dBoxConstRef<ARRAY_3D>::Array3dBoxConstRef(const ARRAY_3D &t,const size_t &iLayer,const RangoIndice &row_range,const RangoIndice &column_range)
  : Array3dBoxRefBase(iLayer,clip(row_range,t.getNumberOfRows()),clip(column_range,t.getNumberOfColumns())),ttz(t)
  {
    if(iLayer>t.getNumberOfLayers())
      std::clog << "Aviso; layer index: " << iLayer
        << " out of range in array with ranges: "
        << Array3dRange(ttz) << std::endl;
  }

template<class ARRAY_3D>
Array3dBoxConstRef<ARRAY_3D>::Array3dBoxConstRef(const ARRAY_3D &t,const RangoIndice &layer_range,const size_t &iRow,const RangoIndice &column_range)
  : Array3dBoxRefBase(clip(layer_range,t.getNumberOfLayers()),iRow,clip(column_range,t.getNumberOfColumns())),ttz(t)
  {
    if(iRow>t.getNumberOfRows())
      std::clog << "Aviso; row index: " << iRow
        << " out of range in array with ranges: "
        << Array3dRange(ttz) << std::endl;
  }

template<class ARRAY_3D>
Array3dBoxConstRef<ARRAY_3D>::Array3dBoxConstRef(const ARRAY_3D &t,const RangoIndice &layer_range,const RangoIndice &row_range,const size_t &iCol)
  : Array3dBoxRefBase(clip(layer_range,t.getNumberOfLayers()),clip(row_range,t.getNumberOfRows()),iCol),ttz(t)
  {
    if(iCol>t.getNumberOfColumns())
      std::clog << "Aviso; column index: " << iCol
        << " out of range in array with ranges: "
        << Array3dRange(ttz) << std::endl;
  }

template<class ARRAY_3D>
Array3dBoxConstRef<ARRAY_3D>::Array3dBoxConstRef(const ARRAY_3D &t,const size_t &iLayer,const size_t &iRow,const RangoIndice &column_range)
  : Array3dBoxRefBase(iLayer,iRow,clip(column_range,t.getNumberOfColumns())),ttz(t)
  {
    if(iLayer>t.getNumberOfLayers())
      std::clog << "Aviso; layer index: " << iLayer
        << " out of range in array with ranges: "
        << Array3dRange(ttz) << std::endl;
    if(iRow>t.getNumberOfRows())
      std::clog << "Aviso; row index: " << iRow
        << " out of range in array with ranges: "
        << Array3dRange(ttz) << std::endl;
  }

template<class ARRAY_3D>
Array3dBoxConstRef<ARRAY_3D>::Array3dBoxConstRef(const ARRAY_3D &t,const size_t iLayer,const RangoIndice &row_range,const size_t &iCol)
  : Array3dBoxRefBase(iLayer,clip(row_range,t.getNumberOfRows()),iCol),ttz(t)
  {
    if(iLayer>t.getNumberOfLayers())
      std::clog << "Aviso; layer index: " << iLayer
        << " out of range in array with ranges: "
        << Array3dRange(ttz) << std::endl;
    if(iCol>t.getNumberOfColumns())
      std::clog << "Aviso; column index: " << iCol
        << " out of range in array with ranges: "
        << Array3dRange(ttz) << std::endl;
  }

template<class ARRAY_3D>
Array3dBoxConstRef<ARRAY_3D>::Array3dBoxConstRef(const ARRAY_3D &t,const RangoIndice &layer_range,const size_t &iRow,const size_t &iCol)
  : Array3dBoxRefBase(clip(layer_range,t.getNumberOfLayers()),iRow,iCol),ttz(t)
  {
    if(iRow>t.getNumberOfRows())
      std::clog << "Aviso; row index: " << iRow
        << " out of range in array with ranges: "
        << Array3dRange(ttz) << std::endl;
    if(iCol>t.getNumberOfColumns())
      std::clog << "Aviso; column index: " << iCol
        << " out of range in array with ranges: "
        << Array3dRange(ttz) << std::endl;
  }

template <class ARRAY_3D>
inline std::ostream &operator<<(std::ostream &os,const Array3dBoxConstRef<ARRAY_3D> &c)
  {
    PrintArray3d(c,os);
    return os;
  }

template <class ARRAY_3D, class TRF>
const Array3dBoxConstRef<ARRAY_3D> &transform(const Array3dBoxConstRef<ARRAY_3D> &box,const TRF &trf)
  {
    static Array3dBoxConstRef<ARRAY_3D> retval;
    retval= box;
    const size_t n_layers= box.getNumberOfLayers();
    const size_t n_rows= box.getNumberOfRows();
    const size_t n_columns= box.getNumberOfColumns();
    for(size_t k=1;k<=n_layers;k++) //For each layer.
      for(size_t i=1;i<=n_rows;i++) //For each row.
        for(size_t j=1;j<=n_columns;j++) //For each column.
          retval(i,j,k)= Transform(box(i,j,k));
    return retval;
  }


#endif