// Copyright Jim Bosch 2010-2012.
|
// Copyright Stefan Seefeld 2016.
|
// Distributed under the Boost Software License, Version 1.0.
|
// (See accompanying file LICENSE_1_0.txt or copy at
|
// http://www.boost.org/LICENSE_1_0.txt)
|
|
#ifndef boost_python_numpy_scalars_hpp_
|
#define boost_python_numpy_scalars_hpp_
|
|
/**
|
* @brief Object managers for array scalars (currently only numpy.void is implemented).
|
*/
|
|
#include <boost/python.hpp>
|
#include <boost/python/numpy/numpy_object_mgr_traits.hpp>
|
#include <boost/python/numpy/dtype.hpp>
|
|
namespace boost { namespace python { namespace numpy {
|
|
/**
|
* @brief A boost.python "object manager" (subclass of object) for numpy.void.
|
*
|
* @todo This could have a lot more functionality.
|
*/
|
class BOOST_NUMPY_DECL void_ : public object
|
{
|
static python::detail::new_reference convert(object_cref arg, bool align);
|
public:
|
|
/**
|
* @brief Construct a new array scalar with the given size and void dtype.
|
*
|
* Data is initialized to zero. One can create a standalone scalar object
|
* with a certain dtype "dt" with:
|
* @code
|
* void_ scalar = void_(dt.get_itemsize()).view(dt);
|
* @endcode
|
*/
|
explicit void_(Py_ssize_t size);
|
|
BOOST_PYTHON_FORWARD_OBJECT_CONSTRUCTORS(void_, object);
|
|
/// @brief Return a view of the scalar with the given dtype.
|
void_ view(dtype const & dt) const;
|
|
/// @brief Copy the scalar (deep for all non-object fields).
|
void_ copy() const;
|
|
};
|
|
} // namespace boost::python::numpy
|
|
namespace converter
|
{
|
NUMPY_OBJECT_MANAGER_TRAITS(numpy::void_);
|
}}} // namespace boost::python::converter
|
|
#endif
|
