File: multi_iter.rst

package info (click to toggle)
boost1.74 1.74.0%2Bds1-21
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 463,588 kB
  • sloc: cpp: 3,338,117; xml: 131,293; python: 33,088; ansic: 14,292; asm: 4,038; sh: 3,353; makefile: 1,193; perl: 1,036; yacc: 478; php: 212; ruby: 102; lisp: 24; sql: 13; csh: 6
file content (94 lines) | stat: -rw-r--r-- 1,797 bytes parent folder | download | duplicates (9)
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
multi_iter
==========

.. contents :: Table of Contents

A ``multi_iter`` is a Python object, intended to be used as an iterator  It should generally only be used in loops.

 ``<boost/python/numpy/ufunc.hpp>`` contains the class definitions for ``multi_iter``


synopsis
--------

::

  namespace boost 
  {
  namespace python
  {
  namespace numpy 
  {

  class multi_iter : public object 
  {
  public:
    void next();
    bool not_done() const;
    char * get_data(int n) const;
    int const get_nd() const;
    Py_intptr_t const * get_shape() const;
    Py_intptr_t const shape(int n) const;
  };


  multi_iter make_multi_iter(object const & a1);
  multi_iter make_multi_iter(object const & a1, object const & a2);
  multi_iter make_multi_iter(object const & a1, object const & a2, object const & a3);

  }
  }
  }


constructors
------------

::

  multi_iter make_multi_iter(object const & a1);
  multi_iter make_multi_iter(object const & a1, object const & a2);
  multi_iter make_multi_iter(object const & a1, object const & a2, object const & a3);

:Returns: A Python iterator object broadcasting over one, two or three sequences as supplied

accessors
---------

::

  void next();

:Effects: Increments the iterator

::

  bool not_done() const;

:Returns: boolean value indicating whether the iterator is at its end

::

  char * get_data(int n) const;

:Returns: a pointer to the element of the nth broadcasted array.

::

  int const get_nd() const;

:Returns: the number of dimensions of the broadcasted array expression

::

  Py_intptr_t const * get_shape() const;

:Returns: the shape of the broadcasted array expression as an array of integers.

::

  Py_intptr_t const shape(int n) const;

:Returns: the shape of the broadcasted array expression in the nth dimension.