VectorPy.h

Go to the documentation of this file.

//                                                         //
// Copyright (c) 2003-2013 by The University of Queensland //
// Earth Systems Science Computational Centre (ESSCC)      //
// http://www.uq.edu.au/esscc                              //
//                                                         //
// Primary Business: Brisbane, Queensland, Australia       //
// Licensed under the Open Software License version 3.0    //
// http://www.opensource.org/licenses/osl-3.0.php          //
//                                                         //

#ifndef ESYS_LSMVECTORPY_H
#define ESYS_LSMVECTORPY_H

#include <boost/python.hpp>
#include <vector>
#include <iterator>

namespace esys
{
  namespace lsm
  {
    template <typename TmplElem>
    class VectorPy : public std::vector<TmplElem>
    {
    public:
      typedef std::vector<TmplElem> Inherited;
      typedef typename Inherited::const_reference const_reference;
      typedef typename Inherited::reference reference;

      class PickleSuite : public boost::python::pickle_suite
      {
      public:
        static
        boost::python::tuple
        getinitargs(VectorPy const& v);
      };

      VectorPy();

      VectorPy(const VectorPy &vec);

      VectorPy(const Inherited &vec);

      VectorPy(boost::python::object &iterable);

      void append(const_reference e);

      size_t getIndex(int i) const;

      reference getItem(int i);

      void setItem(int i, const_reference e);

      static boost::python::class_<VectorPy>
        exportVector(
          const std::string &pyClassName,
          const std::string &pyClassDocString
        );
    };
  }
}

#include "Python/esys/lsm/util/VectorPy.hpp"

#endif