src/multiarray/conversion_utils.c File Reference

#include <Python.h>
#include "structmember.h"
#include "numpy/arrayobject.h"
#include "numpy/arrayscalars.h"
#include "numpy/ndarrayobject.h"
#include "npy_config.h"
#include "numpy/npy_3kcompat.h"
#include "common.h"
#include "arraytypes.h"
#include "conversion_utils.h"

Defines
#define	PY_SSIZE_T_CLEAN
#define	NPY_NO_DEPRECATED_API
#define	_MULTIARRAYMODULE
#define	NPY_NO_PREFIX
Functions
NPY_NO_EXPORT int	PyArray_Converter (PyObject *object, PyObject **address)
NPY_NO_EXPORT int	PyArray_OutputConverter (PyObject *object, PyArrayObject **address)
NPY_NO_EXPORT int	PyArray_IntpConverter (PyObject *obj, PyArray_Dims *seq)
NPY_NO_EXPORT int	PyArray_BufferConverter (PyObject *obj, PyArray_Chunk *buf)
NPY_NO_EXPORT int	PyArray_AxisConverter (PyObject *obj, int *axis)
NPY_NO_EXPORT int	PyArray_BoolConverter (PyObject *object, Bool *val)
NPY_NO_EXPORT int	PyArray_ByteorderConverter (PyObject *obj, char *endian)
NPY_NO_EXPORT int	PyArray_SortkindConverter (PyObject *obj, NPY_SORTKIND *sortkind)
NPY_NO_EXPORT int	PyArray_SearchsideConverter (PyObject *obj, void *addr)
NPY_NO_EXPORT int	PyArray_PyIntAsInt (PyObject *o)
NPY_NO_EXPORT npy_intp	PyArray_PyIntAsIntp (PyObject *o)
NPY_NO_EXPORT int	PyArray_IntpFromSequence (PyObject *seq, npy_intp *vals, int maxvals)
NPY_NO_EXPORT int	PyArray_TypestrConvert (int itemsize, int gentype)
NPY_NO_EXPORT PyObject *	PyArray_IntTupleFromIntp (int len, npy_intp *vals)

---

Define Documentation

#define _MULTIARRAYMODULE

#define NPY_NO_DEPRECATED_API

#define NPY_NO_PREFIX

#define PY_SSIZE_T_CLEAN

---

Function Documentation

NPY_NO_EXPORT int PyArray_AxisConverter	(	PyObject *	obj,
		int *	axis
	)

Get axis from an object (possibly None) -- a converter function,

Referenced by array_cumsum().

NPY_NO_EXPORT int PyArray_BoolConverter	(	PyObject *	object,
		Bool *	val
	)

Convert an object to true / false

NPY_NO_EXPORT int PyArray_BufferConverter	(	PyObject *	obj,
		PyArray_Chunk *	buf
	)

Get buffer chunk from object <blockquote>

this function takes a Python object which exposes the (single-segment) buffer interface and returns a pointer to the data segment

You should increment the reference count by one of buf->base if you will hang on to a reference

You only get a borrowed reference to the object. Do not free the memory... </blockquote>

Point to the base of the buffer object if present

NPY_NO_EXPORT int PyArray_ByteorderConverter	(	PyObject *	obj,
		char *	endian
	)

Convert object to endian

References PY_FAIL, PyArray_BIG, PyArray_IGNORE, PyArray_LITTLE, PyArray_NATIVE, and PyArray_SWAP.

NPY_NO_EXPORT int PyArray_Converter	(	PyObject *	object,
		PyObject **	address
	)

Useful function for conversion when used with PyArg_ParseTuple

System Message: WARNING/2 (<string>, line 1)

Title overline too short.

 Useful function for conversion when used with PyArg_ParseTuple

Useful to pass as converter function for O& processing in PyArgs_ParseTuple. <blockquote>

This conversion function can be used with the "O&" argument for PyArg_ParseTuple. It will immediately return an object of array type or will convert to a NPY_ARRAY_CARRAY any other object.

If you use PyArray_Converter, you must DECREF the array when finished as you get a new reference to it. </blockquote>

NPY_NO_EXPORT int PyArray_IntpConverter	(	PyObject *	obj,
		PyArray_Dims *	seq
	)

Get intp chunk from sequence <blockquote>

This function takes a Python sequence object and allocates and fills in an intp array with the converted values.

Remember to free the pointer seq.ptr when done using PyDimMem_FREE(seq.ptr)** </blockquote>

Check to see if it is a number

Referenced by get_decsrcref_fields_transfer_function().

NPY_NO_EXPORT int PyArray_IntpFromSequence	(	PyObject *	seq,
		npy_intp *	vals,
		int	maxvals
	)

PyArray_IntpFromSequence

Returns the number of dimensions or -1 if an error occurred. vals must be large enough to hold maxvals

Check to see if sequence is a single integer first. or, can be made into one

Check wether there was an error - if the error was an overflow, raise a ValueError instead to be more helpful

Check wether there was an error - if the error was an overflow, raise a ValueError instead to be more helpful

NPY_NO_EXPORT PyObject* PyArray_IntTupleFromIntp	(	int	len,
		npy_intp *	vals
	)

Lifted from numarray

TODO: not documented

PyArray_IntTupleFromIntp

NPY_NO_EXPORT int PyArray_OutputConverter	(	PyObject *	object,
		PyArrayObject **	address
	)

Useful to pass as converter function for O& processing in

PyArgs_ParseTuple for output arrays

Referenced by array_cumsum(), and array_stddev().

NPY_NO_EXPORT int PyArray_PyIntAsInt

(

PyObject *

o

)

Other conversion functions

Referenced by _convert_from_tuple().

NPY_NO_EXPORT npy_intp PyArray_PyIntAsIntp

(

PyObject *

o

)

References PyArray_CastToType(), PyArray_ISINTEGER, and PyArray_SIZE.

Referenced by parse_subindex().

NPY_NO_EXPORT int PyArray_SearchsideConverter	(	PyObject *	obj,
		void *	addr
	)

Convert object to searchsorted side

NPY_NO_EXPORT int PyArray_SortkindConverter	(	PyObject *	obj,
		NPY_SORTKIND *	sortkind
	)

Convert object to sort kind

References PyArray_HEAPSORT.

NPY_NO_EXPORT int PyArray_TypestrConvert	(	int	itemsize,
		int	gentype
	)

Typestr converter

raise PyErr_Warn|Ex depending on version