auto_block.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class auto_block.

#ifndef AUTO_BLOCK_H
#define AUTO_BLOCK_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef POD_TYPES_H
#include "SheafSystem/pod_types.h"
#endif

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

namespace sheaf
{
  
template <typename T>
class un_block_initialization_policy
{
public:

  static void initialize(T* xbegin, T* xend);

  static void initialize(T& xvalue);
};

template <typename T>
class invalid_block_initialization_policy
{
public:
  static void initialize(T* xbegin, T* xend);

  static void initialize(T& xvalue);
};

// Specialization for float

template <>
class invalid_block_initialization_policy<float>
{
public:
  static float invalid();
  static void initialize(float* xbegin, float* xend);
  static void initialize(float& xvalue);
};

// Specialization for double

template <>
class invalid_block_initialization_policy<double>
{
public:
  static double invalid();
  static void initialize(double* xbegin, double* xend);
  static void initialize(double& xvalue);
};


template <typename T>
class zero_block_initialization_policy
{
public:
  static void initialize(T* xbegin, T* xend);

  static void initialize(T& xvalue);
};


template <typename T, typename S = un_block_initialization_policy<T> >
class SHEAF_DLL_SPEC auto_block
{

public:

  typedef T value_type;

  typedef S initialization_policy;

  typedef T& reference_type;

  typedef const T& const_reference_type;

  typedef T* pointer_type;

  typedef const T* const_pointer_type;

  typedef typename sheaf::pod_index_type index_type;

  typedef signed long int  difference_type;

  typedef unsigned long int size_type;

  pointer_type base() const;

  size_type ct() const;

  bool invariant() const;

  reference_type item(index_type xindex) const;

  reference_type operator [] (index_type xindex) const;

  index_type ub() const;

  auto_block(index_type xub = 0);

  auto_block(index_type xub, size_type xct, const T *xitems);

  auto_block(const auto_block& xother);

  auto_block& operator=(const auto_block& xother);

  virtual ~auto_block();

  void force_item(index_type xindex, const_reference_type xitem);

  void reserve(index_type xub);

  void set_ct(size_type xct);

  void set_item(index_type xindex, const_reference_type xitem);

  void assign(const_reference_type xitem);

  void assign(index_type xbegin, index_type xend, const_reference_type xitem);

  reference_type back() const;

  void push_back(const_reference_type item);

  void push_back(const auto_block& xother);

  void pop_back();

  void clear();

  void initialize(index_type xindex);

  void initialize(index_type xbegin, index_type xend);



protected:

  pointer_type _base;     // start of auto_block storage

  index_type  _ub;

  size_type  _ct;

};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================

template <typename T, typename S>
bool operator==(const auto_block<T, S>& xblk1, const auto_block<T, S>& xblk2);

template <typename T, typename S>
std::ostream& operator << (std::ostream& xos, const auto_block<T, S>& xblk);

template <typename T, typename S>
size_t deep_size(const auto_block<T, S>& xp, bool xinclude_shallow = true);

template <typename T, typename S>
size_t deep_size(const auto_block<T*, S>& xp, bool xinclude_shallow = true);

} // namespace sheaf

#endif // AUTO_BLOCK_H