pool.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 POOL

#ifndef POOL_H
#define POOL_H

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

#ifndef BLOCK_H
#include "SheafSystem/block.h"
#endif

#ifndef INDEX_ITERATOR_H
#include "SheafSystem/index_iterator.h"
#endif

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

#ifndef SINGLY_LINKED_LIST_H
#include "SheafSystem/singly_linked_list.h"
#endif

#ifndef SINGLY_LINKED_LIST_H
#include "SheafSystem/singly_linked_list.h"
#endif

namespace sheaf
{
  
class zn_to_bool;

// Forward declarations to enable friend declaration.

template <class T, int EXTENSION_FACTOR>
class pool;
template <class T, int EXTENSION_FACTOR>
  size_t deep_size(const pool<T, EXTENSION_FACTOR>& xpool, bool xinclude_shallow);


template <typename T, int EXTENSION_FACTOR=2>
class pool
{
  friend size_t deep_size<T, EXTENSION_FACTOR>
  (const pool<T,EXTENSION_FACTOR>& xpool, bool xinclude_shallow);

public:

  typedef T value_type;

  typedef T& reference_type;

  typedef const T& const_reference_type;

  typedef T* pointer_type;

  typedef const T* const_pointer_type;

  typedef pod_index_type index_type;

  typedef pod_index_type difference_type;

  typedef unsigned long int  size_type;

  bool invariant() const;

  pod_index_type index_ub() const;

  bool index_in_bounds(pod_index_type xindex) const;

  int free_ct() const;

  pod_index_type free_list() const;

  int allocated_ct() const;

  bool is_allocated(pod_index_type xindex) const;

  T& item(pod_index_type xindex);

  T & operator[](pod_index_type xindex);

  index_iterator allocated_iterator() const;

  pod_index_type allocate();

  void deallocate(pod_index_type xindex);

  void  print() const;

  void  print(std::ostream &out) const;

  pool(pod_index_type xub);

  ~pool();


private:

  int _allocated_ct;

  int _free_ct;

  pod_index_type _free_list;

  typedef block<T*> pool_type;

  pool_type _pool;

  singly_linked_list<T*> _chunk_list;

  zn_to_bool* _is_allocated;

  void extend_to(pod_index_type xub);

};

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

template <typename T, int EXTENSION_FACTOR>
size_t
deep_size(const pool<T, EXTENSION_FACTOR>& xpool, bool xinclude_shallow);
 
} // namespace sheaf

#endif // ifndef POOL_H