PythonVectorWithoutContains.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_TOOLBOXES_PYTHON_PYTHONVECTORWITHOUTCONTAINS_H_
#define _MIRA_TOOLBOXES_PYTHON_PYTHONVECTORWITHOUTCONTAINS_H_

#include <Python.h>
#include <python/UnitWrapper.h>
#include <boost/python/suite/indexing/vector_indexing_suite.hpp>

namespace mira { namespace python {


// Forward declaration
template <class Container, bool NoProxy, class DerivedPolicies>
class no_contains_vector_indexing_suite;

template <class Container, bool NoProxy>
class final_vector_derived_policies
    : public no_contains_vector_indexing_suite<Container,
        NoProxy, final_vector_derived_policies<Container, NoProxy> > {};


/* Derived boost policy to use boost::python::vector_indexing_suite for
 * datatypes that do not implement operator==
 * http://www.boost.org/doc/libs/1_58_0/libs/python/doc/v2/indexing.html#DerivedPolicies
 */
template<
    class Container,
    bool NoProxy = false,
    class DerivedPolicies = final_vector_derived_policies<Container, NoProxy>
>
class no_contains_vector_indexing_suite :
    public boost::python::vector_indexing_suite<Container, NoProxy, DerivedPolicies> {

private:

    typedef boost::python::vector_indexing_suite<Container, NoProxy, DerivedPolicies> Base;

public:

    static bool
    contains(Container& container, typename Base::key_type const& key)
    {
        PyErr_SetString(PyExc_NotImplementedError, "contains is not supported by this type");
        boost::python::throw_error_already_set();
        return false;
    }
};


template<typename Type, typename Allocator = typename std::vector<Type>::allocator_type>
struct VectorWithoutContains
{
    static void expose(const std::string& name)
    {
        using namespace boost::python;
        typedef std::vector<Type, Allocator> VectorType;

        class_<VectorType>(name.c_str())
            .def(no_contains_vector_indexing_suite<VectorType>())
            MIRA_PYTHONCONNECTOR_NAMED_TYPE_FOOTER(VectorType, name.c_str())
        ;
    }
};


}} // namespace mira::python



#endif /* _MIRA_TOOLBOXES_PYTHON_PYTHONVECTORWITHOUTCONTAINS_H_ */