1multi_iter 2========== 3 4.. contents :: Table of Contents 5 6A ``multi_iter`` is a Python object, intended to be used as an iterator It should generally only be used in loops. 7 8 ``<boost/python/numpy/ufunc.hpp>`` contains the class definitions for ``multi_iter`` 9 10 11synopsis 12-------- 13 14:: 15 16 namespace boost 17 { 18 namespace python 19 { 20 namespace numpy 21 { 22 23 class multi_iter : public object 24 { 25 public: 26 void next(); 27 bool not_done() const; 28 char * get_data(int n) const; 29 int const get_nd() const; 30 Py_intptr_t const * get_shape() const; 31 Py_intptr_t const shape(int n) const; 32 }; 33 34 35 multi_iter make_multi_iter(object const & a1); 36 multi_iter make_multi_iter(object const & a1, object const & a2); 37 multi_iter make_multi_iter(object const & a1, object const & a2, object const & a3); 38 39 } 40 } 41 } 42 43 44constructors 45------------ 46 47:: 48 49 multi_iter make_multi_iter(object const & a1); 50 multi_iter make_multi_iter(object const & a1, object const & a2); 51 multi_iter make_multi_iter(object const & a1, object const & a2, object const & a3); 52 53:Returns: A Python iterator object broadcasting over one, two or three sequences as supplied 54 55accessors 56--------- 57 58:: 59 60 void next(); 61 62:Effects: Increments the iterator 63 64:: 65 66 bool not_done() const; 67 68:Returns: boolean value indicating whether the iterator is at its end 69 70:: 71 72 char * get_data(int n) const; 73 74:Returns: a pointer to the element of the nth broadcasted array. 75 76:: 77 78 int const get_nd() const; 79 80:Returns: the number of dimensions of the broadcasted array expression 81 82:: 83 84 Py_intptr_t const * get_shape() const; 85 86:Returns: the shape of the broadcasted array expression as an array of integers. 87 88:: 89 90 Py_intptr_t const shape(int n) const; 91 92:Returns: the shape of the broadcasted array expression in the nth dimension. 93 94 95