|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r75170 - in sandbox/numpy/libs/numpy/doc: . reference
From: seefeld_at_[hidden]
Date: 2011-10-29 14:20:25
Author: stefan
Date: 2011-10-29 14:20:25 EDT (Sat, 29 Oct 2011)
New Revision: 75170
URL: http://svn.boost.org/trac/boost/changeset/75170
Log:
Remove implementation details from documentation.
Text files modified:
sandbox/numpy/libs/numpy/doc/conf.py | 2
sandbox/numpy/libs/numpy/doc/reference/dtype.rst | 13 +++----
sandbox/numpy/libs/numpy/doc/reference/multi_iter.rst | 8 -----
sandbox/numpy/libs/numpy/doc/reference/ndarray.rst | 61 +++++++++++++--------------------------
4 files changed, 28 insertions(+), 56 deletions(-)
Modified: sandbox/numpy/libs/numpy/doc/conf.py
==============================================================================
--- sandbox/numpy/libs/numpy/doc/conf.py (original)
+++ sandbox/numpy/libs/numpy/doc/conf.py 2011-10-29 14:20:25 EDT (Sat, 29 Oct 2011)
@@ -112,7 +112,7 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
-html_logo = 'boost.png'
+html_logo = '_static/boost.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
Modified: sandbox/numpy/libs/numpy/doc/reference/dtype.rst
==============================================================================
--- sandbox/numpy/libs/numpy/doc/reference/dtype.rst (original)
+++ sandbox/numpy/libs/numpy/doc/reference/dtype.rst 2011-10-29 14:20:25 EDT (Sat, 29 Oct 2011)
@@ -27,14 +27,13 @@
// Convert an arbitrary Python object to a data-type descriptor object.
template <typename T>
- explicit dtype(T arg, bool align=false) : python::object(convert(arg, align)) {}
+ explicit dtype(T arg, bool align=false);
- template <typename T> static dtype get_builtin(); // Get the built-in numpy dtype associated with the given scalar template type.
-
- int get_itemsize() const; // Return the size of the data type in bytes.
-
- BOOST_PYTHON_FORWARD_OBJECT_CONSTRUCTORS(dtype, python::object);
+ // Get the built-in numpy dtype associated with the given scalar template type.
+ template <typename T> static dtype get_builtin();
+ // Return the size of the data type in bytes.
+ int get_itemsize() const;
};
}
@@ -45,7 +44,7 @@
::
template <typename T>
- explicit dtype(T arg, bool align=false) : python::object(convert(arg, align)) {}
+ explicit dtype(T arg, bool align=false)
:Requirements: The typename supplied, ``T`` must be either :
* a built-in C++ typename convertible to object
Modified: sandbox/numpy/libs/numpy/doc/reference/multi_iter.rst
==============================================================================
--- sandbox/numpy/libs/numpy/doc/reference/multi_iter.rst (original)
+++ sandbox/numpy/libs/numpy/doc/reference/multi_iter.rst 2011-10-29 14:20:25 EDT (Sat, 29 Oct 2011)
@@ -21,19 +21,11 @@
class multi_iter : public python::object
{
public:
-
- BOOST_PYTHON_FORWARD_OBJECT_CONSTRUCTORS(multi_iter, python::object);
-
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;
};
Modified: sandbox/numpy/libs/numpy/doc/reference/ndarray.rst
==============================================================================
--- sandbox/numpy/libs/numpy/doc/reference/ndarray.rst (original)
+++ sandbox/numpy/libs/numpy/doc/reference/ndarray.rst 2011-10-29 14:20:25 EDT (Sat, 29 Oct 2011)
@@ -36,29 +36,17 @@
UPDATE_ALL=0x1|0x2|0x4, VARRAY=0x1|0x2|0x8, ALL=0x1|0x2|0x4|0x8
};
- BOOST_PYTHON_FORWARD_OBJECT_CONSTRUCTORS(ndarray, object);
-
ndarray view(dtype const & dt) const;
-
ndarray copy() const;
-
- int const shape(int n) const { return get_shape()[n]; }
-
- int const strides(int n) const { return get_strides()[n]; }
-
- char * get_data() const { return get_struct()->data; }
-
+ int const shape(int n) const;
+ int const strides(int n) const;
+ char * get_data() const;
dtype get_dtype() const;
-
python::object get_base() const;
-
void set_base(object const & base);
-
- Py_intptr_t const * get_shape() const { return get_struct()->shape; }
-
- Py_intptr_t const * get_strides() const { return get_struct()->strides; }
-
- int const get_nd() const { return get_struct()->nd; }
+ Py_intptr_t const * get_shape() const;
+ Py_intptr_t const * get_strides() const;
+ int const get_nd() const;
bitflag const get_flags() const;
@@ -81,28 +69,21 @@
ndarray array(python::object const & obj, dtype const & dt);
template <typename Container>
- inline ndarray from_data(void * data,dtype const & dt,Container shape,Container strides,python::object const & owner);
-
+ ndarray from_data(void * data,dtype const & dt,Container shape,Container strides,python::object const & owner);
template <typename Container>
- inline ndarray from_data(void const * data, dtype const & dt, Container shape, Container strides, python::object const & owner);
+ ndarray from_data(void const * data, dtype const & dt, Container shape, Container strides, python::object const & owner);
ndarray from_object(python::object const & obj, dtype const & dt,int nd_min, int nd_max, ndarray::bitflag flags=ndarray::NONE);
-
- inline ndarray from_object(python::object const & obj, dtype const & dt,int nd, ndarray::bitflag flags=ndarray::NONE);
-
- inline ndarray from_object(python::object const & obj, dtype const & dt, ndarray::bitflag flags=ndarray::NONE);
-
+ ndarray from_object(python::object const & obj, dtype const & dt,int nd, ndarray::bitflag flags=ndarray::NONE);
+ ndarray from_object(python::object const & obj, dtype const & dt, ndarray::bitflag flags=ndarray::NONE);
ndarray from_object(python::object const & obj, int nd_min, int nd_max,ndarray::bitflag flags=ndarray::NONE);
+ ndarray from_object(python::object const & obj, int nd, ndarray::bitflag flags=ndarray::NONE);
+ ndarray from_object(python::object const & obj, ndarray::bitflag flags=ndarray::NONE)
- inline ndarray from_object(python::object const & obj, int nd, ndarray::bitflag flags=ndarray::NONE);
-
- inline ndarray from_object(python::object const & obj, ndarray::bitflag flags=ndarray::NONE)
-
- inline ndarray::bitflag operator|(ndarray::bitflag a, ndarray::bitflag b) ;
-
- inline ndarray::bitflag operator&(ndarray::bitflag a, ndarray::bitflag b);
+ ndarray::bitflag operator|(ndarray::bitflag a, ndarray::bitflag b) ;
+ ndarray::bitflag operator&(ndarray::bitflag a, ndarray::bitflag b);
- } // namespace boost::numpy
+ }
constructors
@@ -274,19 +255,19 @@
::
- int const shape(int n) const { return get_shape()[n]; }
+ int const shape(int n) const;
:Returns: The size of the n-th dimension of the ndarray
::
- int const strides(int n) const { return get_strides()[n]; }
+ int const strides(int n) const;
:Returns: The stride of the nth dimension.
::
- char * get_data() const { return get_struct()->data; }
+ char * get_data() const;
:Returns: Array's raw data pointer as a char
@@ -315,21 +296,21 @@
::
- Py_intptr_t const * get_shape() const { return get_struct()->shape; }
+ Py_intptr_t const * get_shape() const;
:Returns: Shape of the array as an array of integers
::
- Py_intptr_t const * get_strides() const { return get_struct()->strides; }
+ Py_intptr_t const * get_strides() const;
:Returns: Stride of the array as an array of integers
::
- int const get_nd() const { return get_struct()->nd; }
+ int const get_nd() const;
:Returns: Number of array dimensions
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk