zfpcarray2.h

#ifndef ZFP_CARRAY2_H
#define ZFP_CARRAY2_H

#include <cstddef>
#include <cstring>
#include <iterator>
#include "zfparray.h"
#include "zfpcodec.h"
#include "zfpindex.h"
#include "zfp/cache2.h"
#include "zfp/store2.h"
#include "zfp/handle2.h"
#include "zfp/reference2.h"
#include "zfp/pointer2.h"
#include "zfp/iterator2.h"
#include "zfp/view2.h"

namespace zfp {

// compressed 2D array of scalars
template <
  typename Scalar,
  class Codec = zfp::codec::zfp2<Scalar>,
  class Index = zfp::index::hybrid4
>
class const_array2 : public array {
public:
  // types utilized by nested classes
  typedef const_array2 container_type;
  typedef Scalar value_type;
  typedef Codec codec_type;
  typedef Index index_type;
  typedef BlockStore2<value_type, codec_type, index_type> store_type;
  typedef BlockCache2<value_type, store_type> cache_type;
  typedef typename Codec::header header;

  // accessor classes
  typedef zfp::internal::dim2::const_reference<const_array2> const_reference;
  typedef zfp::internal::dim2::const_pointer<const_array2> const_pointer;
  typedef zfp::internal::dim2::const_iterator<const_array2> const_iterator;
  typedef zfp::internal::dim2::const_view<const_array2> const_view;
  typedef zfp::internal::dim2::private_const_view<const_array2> private_const_view;

  // default constructor
  const_array2() :
    array(2, Codec::type),
    cache(store)
  {}

  // constructor of nx * ny array using given configuration, at least
  // cache_size bytes of cache, and optionally initialized from flat array p
  const_array2(size_t nx, size_t ny, const zfp_config& config, const value_type* p = 0, size_t cache_size = 0) :
    array(2, Codec::type),
    store(nx, ny, config),
    cache(store, cache_size)
  {
    this->nx = nx;
    this->ny = ny;
    set(p);
  }

  // copy constructor--performs a deep copy
  const_array2(const const_array2& a) :
    cache(store)
  {
    deep_copy(a);
  }

  // virtual destructor
  virtual ~const_array2() {}

  // assignment operator--performs a deep copy
  const_array2& operator=(const const_array2& a)
  {
    if (this != &a)
      deep_copy(a);
    return *this;
  }

  // total number of elements in array
  size_t size() const { return nx * ny; }

  // array dimensions
  size_t size_x() const { return nx; }
  size_t size_y() const { return ny; }

  // resize the array (all previously stored data will be lost)
  void resize(size_t nx, size_t ny, bool clear = true)
  {
    cache.clear();
    this->nx = nx;
    this->ny = ny;
    store.resize(nx, ny, clear);
  }

  // compression mode
  zfp_mode mode() const { return store.mode(); }

  // rate in compressed bits per value (fixed-rate mode only)
  double rate() const { return store.rate(); }

  // precision in uncompressed bits per value (fixed-precision mode only)
  uint precision() const { return store.precision(); }

  // accuracy as absolute error tolerance (fixed-accuracy mode only)
  double accuracy() const { return store.accuracy(); }

  // set rate in compressed bits per value
  double set_rate(double rate)
  {
    cache.clear();
    return store.set_rate(rate, false);
  }

  // set precision in uncompressed bits per value
  uint set_precision(uint precision)
  {
    cache.clear();
    return store.set_precision(precision);
  }

  // set accuracy as absolute error tolerance
  double set_accuracy(double tolerance)
  {
    cache.clear();
    return store.set_accuracy(tolerance);
  }

  // enable reversible (lossless) mode
  void set_reversible()
  {
    cache.clear();
    store.set_reversible();
  }

  // set compression mode and parameters
  void set_config(const zfp_config& config)
  {
    cache.clear();
    store.set_config(config);
  }

  // byte size of array data structure components indicated by mask
  size_t size_bytes(uint mask = ZFP_DATA_ALL) const
  {
    size_t size = 0;
    size += store.size_bytes(mask);
    size += cache.size_bytes(mask);
    if (mask & ZFP_DATA_META)
      size += sizeof(*this);
    return size;
  }

  // number of bytes of compressed data
  size_t compressed_size() const { return store.compressed_size(); }

  // pointer to compressed data for read or write access
  void* compressed_data() const
  {
    cache.flush();
    return store.compressed_data();
  }

  // cache size in number of bytes
  size_t cache_size() const { return cache.size(); }

  // set minimum cache size in bytes (array dimensions must be known)
  void set_cache_size(size_t bytes)
  {
    cache.flush();
    cache.resize(bytes);
  }

  // empty cache without compressing modified cached blocks
  void clear_cache() const { cache.clear(); }

  // decompress array and store at p
  void get(value_type* p) const
  {
    const size_t bx = store.block_size_x();
    const size_t by = store.block_size_y();
    const ptrdiff_t sx = 1;
    const ptrdiff_t sy = static_cast<ptrdiff_t>(nx);
    size_t block_index = 0;
    for (size_t j = 0; j < by; j++, p += 4 * sx * (nx - bx))
      for (size_t i = 0; i < bx; i++, p += 4)
        cache.get_block(block_index++, p, sx, sy);
  }

  // initialize array by copying and compressing data stored at p
  void set(const value_type* p, bool compact = true)
  {
    cache.clear();
    store.clear();
    const size_t bx = store.block_size_x();
    const size_t by = store.block_size_y();
    size_t block_index = 0;
    if (p) {
      // compress data stored at p
      const ptrdiff_t sx = 1;
      const ptrdiff_t sy = static_cast<ptrdiff_t>(nx);
      for (size_t j = 0; j < by; j++, p += 4 * sx * (nx - bx))
        for (size_t i = 0; i < bx; i++, p += 4)
          store.encode(block_index++, p, sx, sy);
    }
    else {
      // zero-initialize array
      const value_type block[4 * 4] = {};
      while (block_index < bx * by)
        store.encode(block_index++, block);
    }
    store.flush();
    if (compact)
      store.compact();
  }

  // (i, j) accessor
  const_reference operator()(size_t i, size_t j) const { return const_reference(const_cast<container_type*>(this), i, j); }

  // flat index accessor
  const_reference operator[](size_t index) const
  {
    size_t i, j;
    ij(i, j, index);
    return const_reference(const_cast<container_type*>(this), i, j);
  }

  // random access iterators
  const_iterator cbegin() const { return const_iterator(this, 0, 0); }
  const_iterator cend() const { return const_iterator(this, 0, ny); }
  const_iterator begin() const { return cbegin(); }
  const_iterator end() const { return cend(); }

protected:
  friend class zfp::internal::dim2::const_handle<const_array2>;
  friend class zfp::internal::dim2::const_reference<const_array2>;
  friend class zfp::internal::dim2::const_pointer<const_array2>;
  friend class zfp::internal::dim2::const_iterator<const_array2>;
  friend class zfp::internal::dim2::const_view<const_array2>;
  friend class zfp::internal::dim2::private_const_view<const_array2>;

  // perform a deep copy
  void deep_copy(const const_array2& a)
  {
    // copy base class members
    array::deep_copy(a);
    // copy persistent storage
    store.deep_copy(a.store);
    // copy cached data
    cache.deep_copy(a.cache);
  }

  // global index bounds
  size_t min_x() const { return 0; }
  size_t max_x() const { return nx; }
  size_t min_y() const { return 0; }
  size_t max_y() const { return ny; }

  // inspector
  value_type get(size_t i, size_t j) const { return cache.get(i, j); }

  // convert flat index to (i, j)
  void ij(size_t& i, size_t& j, size_t index) const
  {
    i = index % nx; index /= nx;
    j = index % ny;
  }

  store_type store; // persistent storage of compressed blocks
  cache_type cache; // cache of decompressed blocks
};

typedef const_array2<float> const_array2f;
typedef const_array2<double> const_array2d;

}

#endif