Previous
The C++ kernel		 Parent
How to create a saxpy python module		 Outline Next
The C++ module file

7.5.2 : The wrapper function

The header file saxpyWrapper.h is very simple : 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

/***************************************
	Auteur : Pierre Aubert
	Mail : aubertp7@gmail.com
	Licence : CeCILL-C
****************************************/

#ifndef __SAXPY_WRAPPER_H__
#define __SAXPY_WRAPPER_H__

#include <Python.h>
#include "structmember.h"

PyObject * saxpyWrapper(PyObject *self, PyObject *args);

#endif
You can download it here.

Now, let's write the saxpyWrapper.cpp file :

Again in this example, since we are using numpy in the module, we have to define the NO_IMPORT_ARRAY to avoid multiple definitions of the same numpy function. And we also have to specify the version of the numpy API to avoid warnings : 
1
2
3
4
5
6

#define NO_IMPORT_ARRAY
#ifndef DISABLE_COOL_ARRAY
#define PY_ARRAY_UNIQUE_SYMBOL core_ARRAY_API
#endif

#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION
Then we include appropriate files. Do not forget to include the asterics_alloc.h file to use our allocation function : 
1
2
3
4
5
6

#include <iostream>
#include <numpy/arrayobject.h>
#include <bytearrayobject.h>

#include "saxpy_intrinsics.h"
#include "saxpyWrapper.h"
To parse static parameters, we have to use the function PyArg_ParseTuple, this function works the same as the scanf function from the C standard library.

Here, we parse the output table and the two input tables with 'O' which corresponds to a PyObject type and 'f' which corresponds to a float. 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

///Do the saxpy computation
/**	@param self : parent of the function if it exist
 * 	@param args : arguments passed to the function
 * 	@return result of the saxpy product
*/
PyObject * saxpyWrapper(PyObject *self, PyObject *args){
	PyArrayObject *objTabX = NULL, *objTabY = NULL, *objTabRes = NULL;
	float scal(0.0f);
	if(!PyArg_ParseTuple(args, "OfOO", &objTabRes, &scal, &objTabX, &objTabY)){
		PyErr_SetString(PyExc_RuntimeError, "saxpyWrapper : wrong set of arguments. Expect tabRes, scal, tabX, tabY\n");
		return NULL;
	}
	if(PyArray_NDIM(objTabX) != 1 || PyArray_NDIM(objTabY) != 1 || PyArray_NDIM(objTabRes) != 1){
		PyErr_SetString(PyExc_TypeError, "saxpyWrapper : input table must be a one dimension array");
		return NULL;
	}
	if(PyArray_DIMS(objTabX)[0] != PyArray_DIMS(objTabY)[0] || PyArray_DIMS(objTabX)[0] != PyArray_DIMS(objTabRes)[0]){
		PyErr_SetString(PyExc_TypeError, "saxpyWrapper : input table must be of the same size");
		return NULL;
	}
	long unsigned int sizeElement(PyArray_DIMS(objTabX)[0]);
	
	const float * tabX = (const float*)PyArray_DATA(objTabX);
	const float * tabY = (const float*)PyArray_DATA(objTabY);
	float * tabRes = (float*)PyArray_DATA(objTabRes);
	
	saxpy(tabRes, scal, tabX, tabY, sizeElement);
	
	Py_RETURN_NONE;
}
The full saxpyWrapper.cpp file : 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

/***************************************
	Auteur : Pierre Aubert
	Mail : aubertp7@gmail.com
	Licence : CeCILL-C
****************************************/

#define NO_IMPORT_ARRAY
#ifndef DISABLE_COOL_ARRAY
#define PY_ARRAY_UNIQUE_SYMBOL core_ARRAY_API
#endif

#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION

#include <iostream>
#include <numpy/arrayobject.h>
#include <bytearrayobject.h>

#include "saxpy_intrinsics.h"
#include "saxpyWrapper.h"

///Do the saxpy computation
/**	@param self : parent of the function if it exist
 * 	@param args : arguments passed to the function
 * 	@return result of the saxpy product
*/
PyObject * saxpyWrapper(PyObject *self, PyObject *args){
	PyArrayObject *objTabX = NULL, *objTabY = NULL, *objTabRes = NULL;
	float scal(0.0f);
	if(!PyArg_ParseTuple(args, "OfOO", &objTabRes, &scal, &objTabX, &objTabY)){
		PyErr_SetString(PyExc_RuntimeError, "saxpyWrapper : wrong set of arguments. Expect tabRes, scal, tabX, tabY\n");
		return NULL;
	}
	if(PyArray_NDIM(objTabX) != 1 || PyArray_NDIM(objTabY) != 1 || PyArray_NDIM(objTabRes) != 1){
		PyErr_SetString(PyExc_TypeError, "saxpyWrapper : input table must be a one dimension array");
		return NULL;
	}
	if(PyArray_DIMS(objTabX)[0] != PyArray_DIMS(objTabY)[0] || PyArray_DIMS(objTabX)[0] != PyArray_DIMS(objTabRes)[0]){
		PyErr_SetString(PyExc_TypeError, "saxpyWrapper : input table must be of the same size");
		return NULL;
	}
	long unsigned int sizeElement(PyArray_DIMS(objTabX)[0]);
	
	const float * tabX = (const float*)PyArray_DATA(objTabX);
	const float * tabY = (const float*)PyArray_DATA(objTabY);
	float * tabRes = (float*)PyArray_DATA(objTabRes);
	
	saxpy(tabRes, scal, tabX, tabY, sizeElement);
	
	Py_RETURN_NONE;
}
You can download it here.
Previous
The C++ kernel		 Parent
How to create a saxpy python module		 Outline Next
The C++ module file