// Filename: pvector.h
// Created by:  drose (05Jun01)
//
////////////////////////////////////////////////////////////////////
//
// PANDA 3D SOFTWARE
// Copyright (c) Carnegie Mellon University.  All rights reserved.
//
// All use of this software is subject to the terms of the revised BSD
// license.  You should have received a copy of this license along
// with this source code in a file named "LICENSE."
//
////////////////////////////////////////////////////////////////////

#ifndef PVECTOR_H
#define PVECTOR_H

#include <vector>

#include "dtoolbase.h"
#include "pallocator.h"
#include "register_type.h"

#ifndef USE_STL_ALLOCATOR
// If we're not using custom allocators, just use the standard class
// definition.
#define pvector vector

#else

////////////////////////////////////////////////////////////////////
//       Class : pvector
// Description : This is our own Panda specialization on the default
//               STL vector.  Its main purpose is to call the hooks
//               for MemoryUsage to properly track STL-allocated
//               memory.
////////////////////////////////////////////////////////////////////
template<class Type>
class pvector : public vector<Type, pallocator_array<Type> > {
public:
  typedef pallocator_array<Type> allocator;
  typedef vector<Type, allocator> base_class;
  typedef TYPENAME base_class::size_type size_type;

  pvector(TypeHandle type_handle = pvector_type_handle) : base_class(allocator(type_handle)) { }
  pvector(const pvector<Type> &copy) : base_class(copy) { }
  pvector(size_type n, TypeHandle type_handle = pvector_type_handle) : base_class(n, Type(), allocator(type_handle)) { }
  pvector(size_type n, const Type &value, TypeHandle type_handle = pvector_type_handle) : base_class(n, value, allocator(type_handle)) { }
  pvector(const Type *begin, const Type *end, TypeHandle type_handle = pvector_type_handle) : base_class(begin, end, allocator(type_handle)) { }
};

#endif  // USE_STL_ALLOCATOR

#if defined(HAVE_EIGEN) && defined(_WIN32) && !defined(CPPPARSER)

#include <Eigen/StdVector>

////////////////////////////////////////////////////////////////////
//       Class : epvector
// Description : Unfortunately, on Windows, std::vector can't be used
//               for classes with explicitly alignment requirements,
//               due to a minor mistake in the template definition
//               (one of the vector methods receives a concrete
//               object, which the compiler flags as an error, even if
//               the method is never called).
//
//               As a workaround, Eigen provides their own
//               specialization of vector, using their own aligned
//               allocator.  We define that here as epvector, which is
//               meant to be a drop-in replacement for pvector for
//               classes that include a linmath object that requires
//               alignment.  Unfortunately, this means we can't use
//               the Panda allocator, so memory allocated for this
//               vector class won't be tracked as part of Panda's
//               memory tracking system.  Them's the breaks, kids.
////////////////////////////////////////////////////////////////////
template<class Type>
class epvector : public vector<Type, Eigen::aligned_allocator<Type> > {
public:
  typedef Eigen::aligned_allocator<Type> allocator;
  typedef vector<Type, allocator> base_class;
  typedef TYPENAME base_class::size_type size_type;

  epvector(TypeHandle type_handle = pvector_type_handle) : base_class(allocator()) { }
  epvector(const epvector<Type> &copy) : base_class(copy) { }
  epvector(size_type n, TypeHandle type_handle = pvector_type_handle) : base_class(n, Type(), allocator()) { }
  epvector(size_type n, const Type &value, TypeHandle type_handle = pvector_type_handle) : base_class(n, value, allocator()) { }
  epvector(const Type *begin, const Type *end, TypeHandle type_handle = pvector_type_handle) : base_class(begin, end, allocator()) { }
};

#else  // HAVE_EIGEN
#define epvector pvector
#endif  // HAVE_EIGEN

#endif