diff options
author | David Cournapeau <cournape@gmail.com> | 2009-02-20 16:37:01 +0000 |
---|---|---|
committer | David Cournapeau <cournape@gmail.com> | 2009-02-20 16:37:01 +0000 |
commit | da364a18e447c334dfa2ca5083b08e1b6a7c0d10 (patch) | |
tree | 7783575e8fe37f8e13ddfc050e9c9d94529bca8e /numpy/add_newdocs.py | |
parent | 745cfe4c60a59c01a8c2fd6ef68a8ca87f2180f5 (diff) | |
parent | a271ac2e41aacab2903864cf371c4ba94cf4ec3f (diff) | |
download | numpy-da364a18e447c334dfa2ca5083b08e1b6a7c0d10.tar.gz |
Merged revisions 6185-6187,6191-6221,6235-6238,6240-6241,6244,6250-6251,6253,6256,6258,6260-6261,6263,6265-6266,6268,6271,6283-6286,6291-6316,6320-6352,6354,6356,6358-6368,6370-6373,6398-6400,6410,6421-6424 via svnmerge from
http://svn.scipy.org/svn/numpy/trunk
................
r6185 | cdavid | 2008-12-22 01:19:14 +0900 (Mon, 22 Dec 2008) | 1 line
Add doc sources so that sdist tarball contains them.
................
r6186 | pierregm | 2008-12-22 19:01:51 +0900 (Mon, 22 Dec 2008) | 4 lines
testutils:
assert_array_compare : make sure that the comparison is performed on ndarrays, and make sure we use the np version of the comparison function.
core:
* Try not to touch the data in unary/binary ufuncs, (including inplace)
................
r6187 | pearu | 2008-12-22 19:05:00 +0900 (Mon, 22 Dec 2008) | 1 line
Fix a bug.
................
r6191 | cdavid | 2008-12-23 13:10:59 +0900 (Tue, 23 Dec 2008) | 1 line
Fix typos in the comments for manifest.
................
r6192 | cdavid | 2008-12-23 13:11:12 +0900 (Tue, 23 Dec 2008) | 1 line
Use msvcrt values if available for manifest generation: only there starting from python 2.6.1.
................
r6193 | pearu | 2008-12-23 18:02:15 +0900 (Tue, 23 Dec 2008) | 1 line
Fix issue 964: f2py python 2.6, 2.6.1 support.
................
r6194 | pierregm | 2008-12-24 08:43:43 +0900 (Wed, 24 Dec 2008) | 12 lines
testutils:
* assert_equal : use assert_equal_array on records
* assert_array_compare : prevent the common mask to be back-propagated to the initial input arrays.
* assert_equal_array : use operator.__eq__ instead of ma.equal
* assert_equal_less: use operator.__less__ instead of ma.less
core:
* Fixed _check_fill_value for nested flexible types
* Add a ndtype option to _make_mask_descr
* Fixed mask_or for nested flexible types
* Fixed the printing of masked arrays w/ flexible types.
................
r6195 | cdavid | 2008-12-26 21:16:45 +0900 (Fri, 26 Dec 2008) | 1 line
Update to handle numscons 0.10.0 and above.
................
r6196 | cdavid | 2008-12-26 21:36:19 +0900 (Fri, 26 Dec 2008) | 1 line
Do not import msvcrt globally in mingw32compiler module, since the module is imported on all platforms.
................
r6197 | cdavid | 2008-12-26 23:39:55 +0900 (Fri, 26 Dec 2008) | 1 line
Do not test for functions already tested by python configure script.
................
r6198 | cdavid | 2008-12-27 14:56:58 +0900 (Sat, 27 Dec 2008) | 1 line
BUG: Add a runtime check about endianness, to detect bug 4728 in python on Mac OS X.
................
r6199 | cdavid | 2008-12-27 19:06:25 +0900 (Sat, 27 Dec 2008) | 1 line
Fix some typo/syntax errors when converting dict access to a function in manifest generation.
................
r6200 | cdavid | 2008-12-27 19:15:30 +0900 (Sat, 27 Dec 2008) | 1 line
BUG (#970): fix a python 2.6 bug in distutils which caused an unhelpful Error:None message when trying to build with no VS installed and without the -c mingw32 option.
................
r6201 | cdavid | 2008-12-27 19:30:49 +0900 (Sat, 27 Dec 2008) | 1 line
Improve the error message when initializing compiler failed.
................
r6202 | cdavid | 2008-12-27 19:32:05 +0900 (Sat, 27 Dec 2008) | 1 line
Try to initialize the msvc compiler before the general code to detect the error early.
................
r6203 | cdavid | 2008-12-27 19:43:41 +0900 (Sat, 27 Dec 2008) | 1 line
BUG (#970): this commit should fix the actual bug, which albeeit linked to commir r6200, was caused in anoter code path.
................
r6204 | cdavid | 2008-12-27 19:57:05 +0900 (Sat, 27 Dec 2008) | 1 line
Fix manifest generation.
................
r6205 | cdavid | 2008-12-27 20:46:08 +0900 (Sat, 27 Dec 2008) | 1 line
BUG (#827): close temp file before reopning them on windows, and make sure they are not automatically deleted on close either (2.6and higher specific).
................
r6206 | cdavid | 2008-12-27 21:18:47 +0900 (Sat, 27 Dec 2008) | 1 line
Do not define the union for runtime endianness detection if we don't check endianness.
................
r6207 | cdavid | 2008-12-27 22:48:52 +0900 (Sat, 27 Dec 2008) | 1 line
Start working on formatting failure on 2.6: copy how python does complex formatting.
................
r6208 | cdavid | 2008-12-27 23:44:11 +0900 (Sat, 27 Dec 2008) | 1 line
Fix formatting for purely imaginary complex numbers.
................
r6209 | cdavid | 2008-12-27 23:53:15 +0900 (Sat, 27 Dec 2008) | 1 line
More work on formatting float.
................
r6210 | cdavid | 2008-12-27 23:59:41 +0900 (Sat, 27 Dec 2008) | 1 line
Finish formatting fixes for float scalar arrays.
................
r6211 | cdavid | 2008-12-28 00:12:20 +0900 (Sun, 28 Dec 2008) | 1 line
Include umath_funcs_c99 in multiarray so that we can use isinf and co macros.
................
r6212 | cdavid | 2008-12-28 01:15:04 +0900 (Sun, 28 Dec 2008) | 1 line
Include config.h before our C99 math compat layer.
................
r6213 | cdavid | 2008-12-28 01:15:41 +0900 (Sun, 28 Dec 2008) | 1 line
Fix formatting.
................
r6214 | cdavid | 2008-12-28 01:16:18 +0900 (Sun, 28 Dec 2008) | 1 line
Do not define FMTR and FMTI macros, as those are already defined on some platforms.
................
r6215 | cdavid | 2008-12-28 01:16:52 +0900 (Sun, 28 Dec 2008) | 1 line
More formatting fixes.
................
r6216 | cdavid | 2008-12-28 01:17:27 +0900 (Sun, 28 Dec 2008) | 1 line
Remove undef of removed macro.
................
r6217 | cdavid | 2008-12-28 01:33:40 +0900 (Sun, 28 Dec 2008) | 1 line
Do not use PyOS_ascii_formatd, as it does not handle long double correctly.
................
r6218 | cdavid | 2008-12-28 02:19:40 +0900 (Sun, 28 Dec 2008) | 1 line
Try ugly hack to circumvent long double brokenness with mingw.
................
r6219 | cdavid | 2008-12-28 02:25:50 +0900 (Sun, 28 Dec 2008) | 1 line
Use ugly hack for mingw long double pb with complex format function as well.
................
r6220 | cdavid | 2008-12-28 12:18:20 +0900 (Sun, 28 Dec 2008) | 1 line
Revert formatting changes: ascii_formatd only works for double, so we can't use it as it is for our formatting needs.
................
r6221 | cdavid | 2008-12-28 15:44:06 +0900 (Sun, 28 Dec 2008) | 1 line
Do not add doc sources through add_data_dir: it will put the docs alongside numpy, as a separate package, which is not what we want. Use the manifest instead, since that's the only way I know of to include something in sdist-generated tarballs.
................
r6235 | cdavid | 2008-12-29 16:57:52 +0900 (Mon, 29 Dec 2008) | 13 lines
Merged revisions 6233-6234 via svnmerge from
http://svn.scipy.org/svn/numpy/branches/fix_float_format
........
r6233 | cdavid | 2008-12-29 12:49:09 +0900 (Mon, 29 Dec 2008) | 1 line
Use parametric tests for format tests so that it is clearer which type is failing.
........
r6234 | cdavid | 2008-12-29 12:49:27 +0900 (Mon, 29 Dec 2008) | 1 line
Fix formatting tests: cfloat and cdouble as well as np.float and np.double are the same; make sure we test 4 bytes float.
........
................
r6236 | cdavid | 2008-12-29 17:02:15 +0900 (Mon, 29 Dec 2008) | 1 line
Add nan/inf tests for formatting.
................
r6237 | cdavid | 2008-12-29 17:26:04 +0900 (Mon, 29 Dec 2008) | 1 line
Add test for real float types locale independance.
................
r6238 | cdavid | 2008-12-29 17:35:06 +0900 (Mon, 29 Dec 2008) | 1 line
Clearer error messages for formatting failures.
................
r6240 | cdavid | 2008-12-30 12:48:11 +0900 (Tue, 30 Dec 2008) | 1 line
Add tests for print of float types.
................
r6241 | cdavid | 2008-12-30 12:56:54 +0900 (Tue, 30 Dec 2008) | 1 line
Add print tests for complex types.
................
r6244 | cdavid | 2008-12-30 13:20:48 +0900 (Tue, 30 Dec 2008) | 1 line
Fix test for print: forgot to make sure the value is a float before comparing it.
................
r6250 | cdavid | 2008-12-30 14:02:28 +0900 (Tue, 30 Dec 2008) | 17 lines
Merged revisions 6247-6249 via svnmerge from
http://svn.scipy.org/svn/numpy/branches/fix_float_format
........
r6247 | cdavid | 2008-12-30 13:41:37 +0900 (Tue, 30 Dec 2008) | 1 line
Handle 1e10 specially, as it is the limit where exp notation is shorter than decimal for single precision, but not for double (python native one).
........
r6248 | cdavid | 2008-12-30 13:47:38 +0900 (Tue, 30 Dec 2008) | 1 line
Refactor a bit redirected output print test.
........
r6249 | cdavid | 2008-12-30 13:49:31 +0900 (Tue, 30 Dec 2008) | 1 line
Fix test for single precision print.
........
................
r6251 | cdavid | 2008-12-30 14:12:50 +0900 (Tue, 30 Dec 2008) | 1 line
Use np.inf instead of float('inf'), as the later does not work on windows for python < 2.6.
................
r6253 | cdavid | 2008-12-30 14:15:09 +0900 (Tue, 30 Dec 2008) | 1 line
Fix typo in test.
................
r6256 | cdavid | 2008-12-30 14:34:22 +0900 (Tue, 30 Dec 2008) | 1 line
Special case float tests on windows: python 2.5 and below have >=3 digits in the exp.
................
r6258 | cdavid | 2008-12-30 14:42:03 +0900 (Tue, 30 Dec 2008) | 1 line
Hardcode reference for inf/nan-involved values.
................
r6260 | cdavid | 2008-12-30 14:50:18 +0900 (Tue, 30 Dec 2008) | 1 line
Fix more formatting tests on win32.
................
r6261 | cdavid | 2008-12-30 14:52:16 +0900 (Tue, 30 Dec 2008) | 1 line
Fix some more redirected output print tests.
................
r6263 | cdavid | 2008-12-30 15:01:31 +0900 (Tue, 30 Dec 2008) | 1 line
More fixes for print tests.
................
r6265 | cdavid | 2008-12-30 15:03:56 +0900 (Tue, 30 Dec 2008) | 1 line
Fix typo.
................
r6266 | cdavid | 2008-12-30 15:08:06 +0900 (Tue, 30 Dec 2008) | 1 line
Fix typo.
................
r6268 | cdavid | 2008-12-30 15:12:26 +0900 (Tue, 30 Dec 2008) | 1 line
complex scalar arrays cannot be created from real/imag args: wrap init values in a complex.
................
r6271 | cdavid | 2008-12-30 15:32:03 +0900 (Tue, 30 Dec 2008) | 1 line
Do not use dict for reference: hashing on scalar arrays does not work as I expected.
................
r6283 | ptvirtan | 2008-12-31 10:14:47 +0900 (Wed, 31 Dec 2008) | 1 line
Fix #951: make tests to clean temp files properly
................
r6284 | jarrod.millman | 2009-01-01 08:25:03 +0900 (Thu, 01 Jan 2009) | 2 lines
ran reindent
................
r6285 | alan.mcintyre | 2009-01-01 08:46:34 +0900 (Thu, 01 Jan 2009) | 15 lines
Remove the following deprecated items from numpy.testing:
- ParametricTestCase
- The following arguments from numpy.testing.Tester.test(): level,
verbosity,
all, sys_argv, testcase_pattern
- Path manipulation functions: set_package_path, set_local_path,
restore_path
- NumpyTestCase, NumpyTest
Also separated testing parameter setup from NoseTester.test into
NoseTester.prepare_test_args for use in a utility script for valgrind
testing (see NumPy ticket #784).
................
r6286 | jarrod.millman | 2009-01-01 16:56:53 +0900 (Thu, 01 Jan 2009) | 2 lines
add default include dir for Fedora/Red Hat (see SciPy ticket 817)
................
r6291 | cdavid | 2009-01-04 19:57:39 +0900 (Sun, 04 Jan 2009) | 1 line
Do not import md5 on python >= 2.6; use hashlib instead.
................
r6292 | cdavid | 2009-01-04 20:08:16 +0900 (Sun, 04 Jan 2009) | 1 line
Do not use popen* but subprocess.Popen instead.
................
r6293 | cdavid | 2009-01-04 21:03:29 +0900 (Sun, 04 Jan 2009) | 1 line
Revert md5 change: hashlib.md5 is not a drop-in replacement for md5.
................
r6294 | pierregm | 2009-01-05 05:16:00 +0900 (Mon, 05 Jan 2009) | 2 lines
* adapted default_fill_value for flexible datatype
* fixed max/minimum_fill_value for flexible datatype
................
r6295 | stefan | 2009-01-06 06:51:18 +0900 (Tue, 06 Jan 2009) | 1 line
Credit more developers.
................
r6296 | pierregm | 2009-01-06 07:52:21 +0900 (Tue, 06 Jan 2009) | 1 line
*moved the printing templates out of MaskedArray.__repr__
................
r6297 | stefan | 2009-01-06 19:09:00 +0900 (Tue, 06 Jan 2009) | 1 line
Use new-style classes with multiple-inheritance to address bug in IronPython.
................
r6298 | pierregm | 2009-01-07 05:35:37 +0900 (Wed, 07 Jan 2009) | 1 line
* Bugfix #961
................
r6299 | pierregm | 2009-01-08 03:14:12 +0900 (Thu, 08 Jan 2009) | 1 line
* Fixed iadd/isub/imul when the base array has no mask but the other array does
................
r6300 | pierregm | 2009-01-08 07:34:51 +0900 (Thu, 08 Jan 2009) | 3 lines
* Renamed `torecords` to `toflex`, keeping `torecords` as an alias
* Introduced `fromflex`, to reconstruct a masked_array from the output of `toflex` (can?\226?\128?\153t `use fromrecords` as it would clash with `numpy.ma.mrecords.fromrecords`)
* Fixed a bug in MaskedBinaryOperation (#979) (wrong array broadcasting)
................
r6301 | cdavid | 2009-01-08 18:19:00 +0900 (Thu, 08 Jan 2009) | 1 line
Avoid putting things into stderr when errors occurs in f2py wrappers; put all the info in the python error string instead.
................
r6302 | cdavid | 2009-01-09 00:11:32 +0900 (Fri, 09 Jan 2009) | 1 line
Fix python 2.4 issue.
................
r6303 | chanley | 2009-01-09 01:30:01 +0900 (Fri, 09 Jan 2009) | 1 line
Fix test_print.py function _test_locale_independance() since str(1.2) does not use the LC_NUMERIC locale to convert numbers. Fix from Mark Sienkiewicz.
................
r6304 | cdavid | 2009-01-09 04:22:21 +0900 (Fri, 09 Jan 2009) | 1 line
Revert buggy test fix for locale independecce.
................
r6305 | pierregm | 2009-01-09 05:02:29 +0900 (Fri, 09 Jan 2009) | 2 lines
* Add __eq__ and __ne__ for support of flexible arrays.
* Fixed .filled for nested structures
................
r6306 | pierregm | 2009-01-09 06:51:04 +0900 (Fri, 09 Jan 2009) | 1 line
* Remove a debugging print statement.
................
r6307 | jarrod.millman | 2009-01-09 11:14:35 +0900 (Fri, 09 Jan 2009) | 2 lines
Updated license file
................
r6308 | cdavid | 2009-01-09 14:26:58 +0900 (Fri, 09 Jan 2009) | 1 line
Tag formatting unit tests as known failures.
................
r6309 | jarrod.millman | 2009-01-09 17:59:29 +0900 (Fri, 09 Jan 2009) | 2 lines
should be more reliable way to determine what bit platform
................
r6310 | jarrod.millman | 2009-01-09 18:14:17 +0900 (Fri, 09 Jan 2009) | 2 lines
better default library paths for 64bit arch
................
r6311 | jarrod.millman | 2009-01-09 18:57:15 +0900 (Fri, 09 Jan 2009) | 2 lines
simplification suggested by stefan
................
r6312 | jarrod.millman | 2009-01-09 19:02:09 +0900 (Fri, 09 Jan 2009) | 2 lines
switch the order [lib,lib64] --> [lib64,lib]
................
r6313 | jarrod.millman | 2009-01-09 19:18:29 +0900 (Fri, 09 Jan 2009) | 2 lines
removed unneeded import
................
r6314 | jarrod.millman | 2009-01-10 04:37:16 +0900 (Sat, 10 Jan 2009) | 2 lines
can't use append an int to a string
................
r6315 | pierregm | 2009-01-10 05:18:12 +0900 (Sat, 10 Jan 2009) | 2 lines
* Added flatten_structured_arrays
* Fixed _get_recordarray for nested structures
................
r6316 | pierregm | 2009-01-10 10:53:05 +0900 (Sat, 10 Jan 2009) | 1 line
* Add flatten_structured_array to the namespace
................
r6320 | pierregm | 2009-01-14 06:01:58 +0900 (Wed, 14 Jan 2009) | 9 lines
numpy.ma.core:
* introduced baseclass, sharedmask and hardmask as readonly properties of MaskedArray
* docstrings update
numpy.ma.extras:
* docstring updates
docs/reference
* introduced maskedarray, maskedarray.baseclass, maskedarray.generic
................
r6321 | stefan | 2009-01-14 16:14:27 +0900 (Wed, 14 Jan 2009) | 2 lines
Docstring: remove old floating point arithmetic, parallel
execution and postponed import references.
................
r6322 | stefan | 2009-01-14 16:55:16 +0900 (Wed, 14 Jan 2009) | 1 line
Fix printing of limits.
................
r6323 | stefan | 2009-01-14 16:56:10 +0900 (Wed, 14 Jan 2009) | 1 line
Fix finfo to work on all instances, not just NumPy scalars.
................
r6324 | pierregm | 2009-01-17 09:15:15 +0900 (Sat, 17 Jan 2009) | 1 line
* fixed _arraymethod.__call__ for structured arrays
................
r6325 | ptvirtan | 2009-01-18 06:24:13 +0900 (Sun, 18 Jan 2009) | 3 lines
Make `trapz` accept 1-D `x` parameter for n-d `y`, even if axis != -1.
Additional tests included.
................
r6326 | pierregm | 2009-01-19 17:53:53 +0900 (Mon, 19 Jan 2009) | 3 lines
* renamed FlatIter to MaskedIterator
* added __getitem__ to MaskedIterator
................
r6327 | pierregm | 2009-01-19 18:01:24 +0900 (Mon, 19 Jan 2009) | 2 lines
* replace np.asarray by np.asanyarray in unique1d
................
r6328 | pierregm | 2009-01-19 18:04:20 +0900 (Mon, 19 Jan 2009) | 2 lines
* add intersect1d, intersect1d_nu, setdiff1d, setmember1d, setxor1d, unique1d, union1d
* use np.atleast1d instead of ma.atleast1d
................
r6329 | pierregm | 2009-01-20 06:22:52 +0900 (Tue, 20 Jan 2009) | 3 lines
* lib : introduced _iotools
* lib.io : introduced genfromtxt, ndfromtxt, mafromtxt, recfromtxt, recfromcsv.
................
r6330 | pierregm | 2009-01-22 14:37:36 +0900 (Thu, 22 Jan 2009) | 1 line
* genfromtxt : if names is True, accept a line starting with a comment character as header.
................
r6331 | pierregm | 2009-01-22 14:40:25 +0900 (Thu, 22 Jan 2009) | 1 line
* added recfunctions, a collection of utilities to manipulate structured arrays.
................
r6332 | pierregm | 2009-01-23 03:21:32 +0900 (Fri, 23 Jan 2009) | 2 lines
* fixed a machine-dependent issue on default int ('<i4' on OS X, '<i8' on linux) ?
* fixed an machine-dependent issue on argsort ?
................
r6333 | cdavid | 2009-01-24 17:02:14 +0900 (Sat, 24 Jan 2009) | 1 line
Fix compilation error on 2.4.
................
r6334 | pierregm | 2009-01-27 06:04:26 +0900 (Tue, 27 Jan 2009) | 7 lines
* _iotools.StringConverter :
- add a _checked attribute to indicate whether the converter has been upgraded or not.
- switched the default value for bool to False
* io.genfromtxt:
- fixed for the case where a whole column is masked: switch to bool or the common dtype (if needed)
................
r6335 | pierregm | 2009-01-27 11:46:26 +0900 (Tue, 27 Jan 2009) | 1 line
* prevent MaskedBinaryOperation and DomainedBinaryOperation to shrink the mask of the output when at least one of the inputs has a mask full of False
................
r6336 | matthew.brett@gmail.com | 2009-01-30 09:26:44 +0900 (Fri, 30 Jan 2009) | 1 line
New docstrings for byteorder and newbyteorder()
................
r6337 | pierregm | 2009-02-02 14:20:17 +0900 (Mon, 02 Feb 2009) | 2 lines
* Added a 'autoconvert' option to stack_arrays.
* Fixed 'stack_arrays' to work with fields with titles.
................
r6338 | pierregm | 2009-02-04 02:11:44 +0900 (Wed, 04 Feb 2009) | 1 line
* Make sure that StringConverter.update sets the type to object if it can't define it.
................
r6339 | pierregm | 2009-02-05 05:52:36 +0900 (Thu, 05 Feb 2009) | 2 lines
* test__iotools : prevent test_upgrademapper if dateutil is not installed
* MaskedArray.__rmul__ : switch to multiply(self, other)
................
r6340 | pierregm | 2009-02-05 06:53:05 +0900 (Thu, 05 Feb 2009) | 1 line
test_upgrademapper : got rid of the dateutil import
................
r6341 | pierregm | 2009-02-05 13:31:51 +0900 (Thu, 05 Feb 2009) | 2 lines
* genfromtxt : Fixed when a dtype involving objects is explicitly given. Raise a NotImplementedError if the dtype is nested.
* _iotools : make sure StringConverter gets properly initiated when a function returning a np.object is used as input parameter.
................
r6342 | alan.mcintyre | 2009-02-06 05:11:40 +0900 (Fri, 06 Feb 2009) | 6 lines
Issue #957:
- Fix problems with test decorators when used on test generators.
- The skip/fail arguments for skipif and knownfailureif can now be
either a bool or a callable that returns a bool.
- Added tests for the test decorators.
................
r6343 | ptvirtan | 2009-02-06 09:27:08 +0900 (Fri, 06 Feb 2009) | 1 line
doc/numpydoc: work better together with Sphinx's config option
................
r6344 | ptvirtan | 2009-02-06 09:51:41 +0900 (Fri, 06 Feb 2009) | 1 line
doc: Move maskedarray docs upward in TOC
................
r6345 | oliphant | 2009-02-06 15:25:50 +0900 (Fri, 06 Feb 2009) | 1 line
Avoid re-creating the sequence when there is only one field in the regular expression.
................
r6346 | oliphant | 2009-02-06 15:31:11 +0900 (Fri, 06 Feb 2009) | 1 line
Removed an unneccessary return statement in a unit test.
................
r6347 | pearu | 2009-02-06 23:36:58 +0900 (Fri, 06 Feb 2009) | 1 line
Fix a bug: python system_info.py failed because _pkg_config_info defined section to be None.
................
r6348 | pearu | 2009-02-06 23:38:57 +0900 (Fri, 06 Feb 2009) | 1 line
Fix another bug, see last commit.
................
r6349 | pierregm | 2009-02-07 18:19:12 +0900 (Sat, 07 Feb 2009) | 2 lines
MaskedArray.resize : systematically raise a TypeError exception, as a masked array never owns its data
MaskedIterator : fixed to allow .flat on masked matrices
................
r6350 | pierregm | 2009-02-08 03:51:31 +0900 (Sun, 08 Feb 2009) | 1 line
................
r6351 | ptvirtan | 2009-02-10 05:18:08 +0900 (Tue, 10 Feb 2009) | 1 line
Fix #955: fix errobj leak in scalarmath floating point error handling
................
r6352 | pierregm | 2009-02-10 09:42:40 +0900 (Tue, 10 Feb 2009) | 1 line
* prevent modifications to the mask to be back-propagated w/ __array_wrap__
................
r6354 | cdavid | 2009-02-10 19:44:01 +0900 (Tue, 10 Feb 2009) | 1 line
Fix hyphen (patch from debian package).
................
r6356 | pierregm | 2009-02-11 10:51:28 +0900 (Wed, 11 Feb 2009) | 1 line
* MaskedArray.__array_wrap__ : forces the domain (if any) to a ndarray (fill with True)
................
r6358 | oliphant | 2009-02-12 13:22:03 +0900 (Thu, 12 Feb 2009) | 1 line
Add multiple-field access by making a copy of the array and filling with the selected fields.
................
r6359 | stefan | 2009-02-12 14:44:07 +0900 (Thu, 12 Feb 2009) | 2 lines
Trust user's specification of MACOSX_DEPLOYMENT_TARGET [patch by Brian
Granger].
................
r6360 | cdavid | 2009-02-14 23:54:26 +0900 (Sat, 14 Feb 2009) | 1 line
Merge fix_float_format branch into the trunk.
................
r6361 | cdavid | 2009-02-15 00:02:39 +0900 (Sun, 15 Feb 2009) | 1 line
Fix typo in multiarray tests.
................
r6362 | cdavid | 2009-02-15 00:03:22 +0900 (Sun, 15 Feb 2009) | 1 line
Remove leftover in TestIO.
................
r6363 | cdavid | 2009-02-15 02:03:51 +0900 (Sun, 15 Feb 2009) | 1 line
Include C99 math compatbility layer in multiarray - isnan and co needed by numpyos.c
................
r6364 | ptvirtan | 2009-02-15 07:09:26 +0900 (Sun, 15 Feb 2009) | 1 line
More add_newdocs entries, and make add_newdoc capable of adding docs also to normal Python objects.
................
r6365 | ptvirtan | 2009-02-15 07:10:24 +0900 (Sun, 15 Feb 2009) | 1 line
Move (un)packbits docstrings to add_newdocs.py. Fix typos.
................
r6366 | ptvirtan | 2009-02-15 07:11:19 +0900 (Sun, 15 Feb 2009) | 1 line
Document constants in numpy.doc.constants
................
r6367 | ptvirtan | 2009-02-15 07:38:32 +0900 (Sun, 15 Feb 2009) | 1 line
Move numpy.lib __doc__ back to info.py; was moved to __init__.py by mistake.
................
r6368 | pierregm | 2009-02-15 07:42:29 +0900 (Sun, 15 Feb 2009) | 1 line
* genfromtxt : fixed case when using explicit converters and explicit dtype.
................
r6370 | ptvirtan | 2009-02-16 00:44:47 +0900 (Mon, 16 Feb 2009) | 1 line
sphinxext: clean up plot directive, and merge some features from matplotlib
................
r6371 | charris | 2009-02-18 06:19:10 +0900 (Wed, 18 Feb 2009) | 2 lines
Coding style cleanups.
................
r6372 | cdavid | 2009-02-18 14:06:57 +0900 (Wed, 18 Feb 2009) | 1 line
Fix some const issues in NumPyOs_ascii_strtod.
................
r6373 | charris | 2009-02-18 14:36:35 +0900 (Wed, 18 Feb 2009) | 1 line
Coding style cleanups.
................
r6398 | charris | 2009-02-19 05:54:52 +0900 (Thu, 19 Feb 2009) | 2 lines
Coding style cleanups.
................
r6399 | charris | 2009-02-19 09:45:14 +0900 (Thu, 19 Feb 2009) | 2 lines
Coding style cleanups.
................
r6400 | charris | 2009-02-19 13:58:23 +0900 (Thu, 19 Feb 2009) | 1 line
Coding style cleanups.
................
r6410 | cdavid | 2009-02-19 19:05:28 +0900 (Thu, 19 Feb 2009) | 1 line
Tag known failure on win32.
................
r6421 | stefan | 2009-02-20 04:28:08 +0900 (Fri, 20 Feb 2009) | 1 line
Fix tests using strptime to be Python 2.4 compatible.
................
r6422 | charris | 2009-02-20 08:25:01 +0900 (Fri, 20 Feb 2009) | 2 lines
Coding style cleanups.
................
r6423 | charris | 2009-02-20 12:40:53 +0900 (Fri, 20 Feb 2009) | 1 line
Coding style cleanups.
................
r6424 | cdavid | 2009-02-20 22:30:20 +0900 (Fri, 20 Feb 2009) | 1 line
Unhelpful message for compaq fortran compiler.
................
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r-- | numpy/add_newdocs.py | 978 |
1 files changed, 836 insertions, 142 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index cff9e5e03..68224485c 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -8,140 +8,6 @@ from lib import add_newdoc -add_newdoc('numpy.core', 'dtype', -"""Create a data type. - -A numpy array is homogeneous, and contains elements described by a -dtype. A dtype can be constructed from different combinations of -fundamental numeric types, as illustrated below. - -Examples --------- - -Using array-scalar type: ->>> np.dtype(np.int16) -dtype('int16') - -Record, one field name 'f1', containing int16: ->>> np.dtype([('f1', np.int16)]) -dtype([('f1', '<i2')]) - -Record, one field named 'f1', in itself containing a record with one field: ->>> np.dtype([('f1', [('f1', np.int16)])]) -dtype([('f1', [('f1', '<i2')])]) - -Record, two fields: the first field contains an unsigned int, the -second an int32: ->>> np.dtype([('f1', np.uint), ('f2', np.int32)]) -dtype([('f1', '<u4'), ('f2', '<i4')]) - -Using array-protocol type strings: ->>> np.dtype([('a','f8'),('b','S10')]) -dtype([('a', '<f8'), ('b', '|S10')]) - -Using comma-separated field formats. The shape is (2,3): ->>> np.dtype("i4, (2,3)f8") -dtype([('f0', '<i4'), ('f1', '<f8', (2, 3))]) - -Using tuples. ``int`` is a fixed type, 3 the field's shape. ``void`` -is a flexible type, here of size 10: ->>> np.dtype([('hello',(np.int,3)),('world',np.void,10)]) -dtype([('hello', '<i4', 3), ('world', '|V10')]) - -Subdivide ``int16`` into 2 ``int8``'s, called x and y. 0 and 1 are -the offsets in bytes: ->>> np.dtype((np.int16, {'x':(np.int8,0), 'y':(np.int8,1)})) -dtype(('<i2', [('x', '|i1'), ('y', '|i1')])) - -Using dictionaries. Two fields named 'gender' and 'age': ->>> np.dtype({'names':['gender','age'], 'formats':['S1',np.uint8]}) -dtype([('gender', '|S1'), ('age', '|u1')]) - -Offsets in bytes, here 0 and 25: ->>> np.dtype({'surname':('S25',0),'age':(np.uint8,25)}) -dtype([('surname', '|S25'), ('age', '|u1')]) - -""") - -add_newdoc('numpy.core', 'dtype', - """ - dtype(obj, align=False, copy=False) - - Create a data type object. - - A numpy array is homogeneous, and contains elements described by a - dtype object. A dtype object can be constructed from different - combinations of fundamental numeric types. - - Parameters - ---------- - obj - Object to be converted to a data type object. - align : bool, optional - Add padding to the fields to match what a C compiler would output - for a similar C-struct. Can be ``True`` only if `obj` is a dictionary - or a comma-separated string. - copy : bool, optional - Make a new copy of the data-type object. If ``False``, the result - may just be a reference to a built-in data-type object. - - Examples - -------- - Using array-scalar type: - - >>> np.dtype(np.int16) - dtype('int16') - - Record, one field name 'f1', containing int16: - - >>> np.dtype([('f1', np.int16)]) - dtype([('f1', '<i2')]) - - Record, one field named 'f1', in itself containing a record with one field: - - >>> np.dtype([('f1', [('f1', np.int16)])]) - dtype([('f1', [('f1', '<i2')])]) - - Record, two fields: the first field contains an unsigned int, the - second an int32: - - >>> np.dtype([('f1', np.uint), ('f2', np.int32)]) - dtype([('f1', '<u4'), ('f2', '<i4')]) - - Using array-protocol type strings: - - >>> np.dtype([('a','f8'),('b','S10')]) - dtype([('a', '<f8'), ('b', '|S10')]) - - Using comma-separated field formats. The shape is (2,3): - - >>> np.dtype("i4, (2,3)f8") - dtype([('f0', '<i4'), ('f1', '<f8', (2, 3))]) - - Using tuples. ``int`` is a fixed type, 3 the field's shape. ``void`` - is a flexible type, here of size 10: - - >>> np.dtype([('hello',(np.int,3)),('world',np.void,10)]) - dtype([('hello', '<i4', 3), ('world', '|V10')]) - - Subdivide ``int16`` into 2 ``int8``'s, called x and y. 0 and 1 are - the offsets in bytes: - - >>> np.dtype((np.int16, {'x':(np.int8,0), 'y':(np.int8,1)})) - dtype(('<i2', [('x', '|i1'), ('y', '|i1')])) - - Using dictionaries. Two fields named 'gender' and 'age': - - >>> np.dtype({'names':['gender','age'], 'formats':['S1',np.uint8]}) - dtype([('gender', '|S1'), ('age', '|u1')]) - - Offsets in bytes, here 0 and 25: - - >>> np.dtype({'surname':('S25',0),'age':(np.uint8,25)}) - dtype([('surname', '|S25'), ('age', '|u1')]) - - """) - ############################################################################### # # flatiter @@ -150,7 +16,12 @@ add_newdoc('numpy.core', 'dtype', # ############################################################################### -# attributes +add_newdoc('numpy.core', 'flatiter', + """ + """) + +# flatiter attributes + add_newdoc('numpy.core', 'flatiter', ('base', """documentation needed @@ -170,9 +41,8 @@ add_newdoc('numpy.core', 'flatiter', ('index', """)) +# flatiter functions - -# functions add_newdoc('numpy.core', 'flatiter', ('__array__', """__array__(type=None) Get array from iterator @@ -191,37 +61,37 @@ add_newdoc('numpy.core', 'flatiter', ('copy', # ############################################################################### +add_newdoc('numpy.core', 'broadcast', + """ + """) + # attributes + add_newdoc('numpy.core', 'broadcast', ('index', """current index in broadcasted result """)) - add_newdoc('numpy.core', 'broadcast', ('iters', """tuple of individual iterators """)) - add_newdoc('numpy.core', 'broadcast', ('nd', """number of dimensions of broadcasted result """)) - add_newdoc('numpy.core', 'broadcast', ('numiter', """number of iterators """)) - add_newdoc('numpy.core', 'broadcast', ('shape', """shape of broadcasted result """)) - add_newdoc('numpy.core', 'broadcast', ('size', """total size of broadcasted result @@ -1997,6 +1867,32 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('newbyteorder', Equivalent to a.view(a.dtype.newbytorder(byteorder)) + Return array with dtype changed to interpret array data as + specified byte order. + + Changes are also made in all fields and sub-arrays of the array + data type. + + Parameters + ---------- + new_order : string, optional + Byte order to force; a value from the byte order + specifications below. The default value ('S') results in + swapping the current byte order. + `new_order` codes can be any of: + * {'<', 'L'} - little endian + * {'>', 'B'} - big endian + * {'=', 'N'} - native order + * 'S' - swap dtype from current to opposite endian + * {'|', 'I'} - ignore (no change to byte order) + The code does a case-insensitive check on the first letter of + `new_order` for these alternatives. For example, any of '>' + or 'B' or 'b' or 'brian' are valid to specify big-endian. + + Returns + ------- + new_arr : array + array with the given change to the dtype byte order. """)) @@ -2555,6 +2451,25 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('view', """)) + +############################################################################## +# +# umath functions +# +############################################################################## + +add_newdoc('numpy.core.umath', 'frexp', + """ + """) + +add_newdoc('numpy.core.umath', 'frompyfunc', + """ + """) + +add_newdoc('numpy.core.umath', 'ldexp', + """ + """) + add_newdoc('numpy.core.umath','geterrobj', """geterrobj() @@ -2584,6 +2499,102 @@ add_newdoc('numpy.core.umath', 'seterrobj', """) + +############################################################################## +# +# lib._compiled_base functions +# +############################################################################## + +add_newdoc('numpy.lib._compiled_base', 'digitize', + """ + digitize(x,bins) + + Return the index of the bin to which each value of x belongs. + + Each index i returned is such that bins[i-1] <= x < bins[i] if + bins is monotonically increasing, or bins [i-1] > x >= bins[i] if + bins is monotonically decreasing. + + Beyond the bounds of the bins 0 or len(bins) is returned as appropriate. + """) + +add_newdoc('numpy.lib._compiled_base', 'bincount', + """ + bincount(x,weights=None) + + Return the number of occurrences of each value in x. + + x must be a list of non-negative integers. The output, b[i], + represents the number of times that i is found in x. If weights + is specified, every occurrence of i at a position p contributes + weights[p] instead of 1. + + See also: histogram, digitize, unique. + """) + +add_newdoc('numpy.lib._compiled_base', 'add_docstring', + """ + docstring(obj, docstring) + + Add a docstring to a built-in obj if possible. + If the obj already has a docstring raise a RuntimeError + If this routine does not know how to add a docstring to the object + raise a TypeError + """) + +add_newdoc('numpy.lib._compiled_base', 'packbits', + """ + out = numpy.packbits(myarray, axis=None) + + myarray : an integer type array whose elements should be packed to bits + + This routine packs the elements of a binary-valued dataset into a + NumPy array of type uint8 ('B') whose bits correspond to + the logical (0 or nonzero) value of the input elements. + The dimension over-which bit-packing is done is given by axis. + The shape of the output has the same number of dimensions as the input + (unless axis is None, in which case the output is 1-d). + + Example: + >>> a = array([[[1,0,1], + ... [0,1,0]], + ... [[1,1,0], + ... [0,0,1]]]) + >>> b = numpy.packbits(a,axis=-1) + >>> b + array([[[160],[64]],[[192],[32]]], dtype=uint8) + + Note that 160 = 128 + 32 + 192 = 128 + 64 + """) + +add_newdoc('numpy.lib._compiled_base', 'unpackbits', + """ + out = numpy.unpackbits(myarray, axis=None) + + myarray - array of uint8 type where each element represents a bit-field + that should be unpacked into a boolean output array + + The shape of the output array is either 1-d (if axis is None) or + the same shape as the input array with unpacking done along the + axis specified. + """) + + +############################################################################## +# +# Documentation for ufunc attributes and methods +# +############################################################################## + + +############################################################################## +# +# ufunc object +# +############################################################################## + add_newdoc('numpy.core', 'ufunc', """ Functions that operate element by element on whole arrays. @@ -2636,6 +2647,12 @@ add_newdoc('numpy.core', 'ufunc', """) +############################################################################## +# +# ufunc methods +# +############################################################################## + add_newdoc('numpy.core', 'ufunc', ('reduce', """ reduce(array, axis=0, dtype=None, out=None) @@ -2815,3 +2832,680 @@ add_newdoc('numpy.core', 'ufunc', ('outer', [12, 15, 18]]) """)) + + +############################################################################## +# +# Documentation for dtype attributes and methods +# +############################################################################## + +############################################################################## +# +# dtype object +# +############################################################################## + +add_newdoc('numpy.core.multiarray', 'dtype', + """ + dtype(obj, align=False, copy=False) + + Create a data type object. + + A numpy array is homogeneous, and contains elements described by a + dtype object. A dtype object can be constructed from different + combinations of fundamental numeric types. + + Parameters + ---------- + obj + Object to be converted to a data type object. + align : bool, optional + Add padding to the fields to match what a C compiler would output + for a similar C-struct. Can be ``True`` only if `obj` is a dictionary + or a comma-separated string. + copy : bool, optional + Make a new copy of the data-type object. If ``False``, the result + may just be a reference to a built-in data-type object. + + Examples + -------- + Using array-scalar type: + + >>> np.dtype(np.int16) + dtype('int16') + + Record, one field name 'f1', containing int16: + + >>> np.dtype([('f1', np.int16)]) + dtype([('f1', '<i2')]) + + Record, one field named 'f1', in itself containing a record with one field: + + >>> np.dtype([('f1', [('f1', np.int16)])]) + dtype([('f1', [('f1', '<i2')])]) + + Record, two fields: the first field contains an unsigned int, the + second an int32: + + >>> np.dtype([('f1', np.uint), ('f2', np.int32)]) + dtype([('f1', '<u4'), ('f2', '<i4')]) + + Using array-protocol type strings: + + >>> np.dtype([('a','f8'),('b','S10')]) + dtype([('a', '<f8'), ('b', '|S10')]) + + Using comma-separated field formats. The shape is (2,3): + + >>> np.dtype("i4, (2,3)f8") + dtype([('f0', '<i4'), ('f1', '<f8', (2, 3))]) + + Using tuples. ``int`` is a fixed type, 3 the field's shape. ``void`` + is a flexible type, here of size 10: + + >>> np.dtype([('hello',(np.int,3)),('world',np.void,10)]) + dtype([('hello', '<i4', 3), ('world', '|V10')]) + + Subdivide ``int16`` into 2 ``int8``'s, called x and y. 0 and 1 are + the offsets in bytes: + + >>> np.dtype((np.int16, {'x':(np.int8,0), 'y':(np.int8,1)})) + dtype(('<i2', [('x', '|i1'), ('y', '|i1')])) + + Using dictionaries. Two fields named 'gender' and 'age': + + >>> np.dtype({'names':['gender','age'], 'formats':['S1',np.uint8]}) + dtype([('gender', '|S1'), ('age', '|u1')]) + + Offsets in bytes, here 0 and 25: + + >>> np.dtype({'surname':('S25',0),'age':(np.uint8,25)}) + dtype([('surname', '|S25'), ('age', '|u1')]) + + """) + +############################################################################## +# +# dtype attributes +# +############################################################################## + +add_newdoc('numpy.core.multiarray', 'dtype', ('alignment', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('byteorder', + ''' + dt.byteorder + + String giving byteorder of dtype + + One of: + * '=' - native byteorder + * '<' - little endian + * '>' - big endian + * '|' - endian not relevant + + Examples + -------- + >>> dt = np.dtype('i2') + >>> dt.byteorder + '=' + >>> # endian is not relevant for 8 bit numbers + >>> np.dtype('i1').byteorder + '|' + >>> # or ASCII strings + >>> np.dtype('S2').byteorder + '|' + >>> # Even if specific code is given, and it is native + >>> # '=' is the byteorder + >>> import sys + >>> sys_is_le = sys.byteorder == 'little' + >>> native_code = sys_is_le and '<' or '>' + >>> swapped_code = sys_is_le and '>' or '<' + >>> dt = np.dtype(native_code + 'i2') + >>> dt.byteorder + '=' + >>> # Swapped code shows up as itself + >>> dt = np.dtype(swapped_code + 'i2') + >>> dt.byteorder == swapped_code + True + ''')) + +add_newdoc('numpy.core.multiarray', 'dtype', ('char', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('descr', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('fields', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('flags', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('hasobject', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('isbuiltin', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('isnative', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('itemsize', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('kind', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('name', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('names', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('num', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('shape', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('str', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('subdtype', + """ + """)) + +add_newdoc('numpy.core.multiarray', 'dtype', ('type', + """ + """)) + +############################################################################## +# +# dtype methods +# +############################################################################## + +add_newdoc('numpy.core.multiarray', 'dtype', ('newbyteorder', + ''' + newbyteorder(new_order='S') + + Return a new dtype with a different byte order. + + Changes are also made in all fields and sub-arrays of the data type. + + Parameters + ---------- + new_order : string, optional + Byte order to force; a value from the byte order + specifications below. The default value ('S') results in + swapping the current byte order. + `new_order` codes can be any of: + * {'<', 'L'} - little endian + * {'>', 'B'} - big endian + * {'=', 'N'} - native order + * 'S' - swap dtype from current to opposite endian + * {'|', 'I'} - ignore (no change to byte order) + The code does a case-insensitive check on the first letter of + `new_order` for these alternatives. For example, any of '>' + or 'B' or 'b' or 'brian' are valid to specify big-endian. + + Returns + ------- + new_dtype : dtype + New dtype object with the given change to the byte order. + + Examples + -------- + >>> import sys + >>> sys_is_le = sys.byteorder == 'little' + >>> native_code = sys_is_le and '<' or '>' + >>> swapped_code = sys_is_le and '>' or '<' + >>> native_dt = np.dtype(native_code+'i2') + >>> swapped_dt = np.dtype(swapped_code+'i2') + >>> native_dt.newbyteorder('S') == swapped_dt + True + >>> native_dt.newbyteorder() == swapped_dt + True + >>> native_dt == swapped_dt.newbyteorder('S') + True + >>> native_dt == swapped_dt.newbyteorder('=') + True + >>> native_dt == swapped_dt.newbyteorder('N') + True + >>> native_dt == native_dt.newbyteorder('|') + True + >>> np.dtype('<i2') == native_dt.newbyteorder('<') + True + >>> np.dtype('<i2') == native_dt.newbyteorder('L') + True + >>> np.dtype('>i2') == native_dt.newbyteorder('>') + True + >>> np.dtype('>i2') == native_dt.newbyteorder('B') + True + ''')) + + +############################################################################## +# +# nd_grid instances +# +############################################################################## + +add_newdoc('numpy.lib.index_tricks', 'mgrid', + """ + Construct a multi-dimensional filled "meshgrid". + + Returns a mesh-grid when indexed. The dimension and number of the + output arrays are equal to the number of indexing dimensions. If + the step length is not a complex number, then the stop is not + inclusive. + + However, if the step length is a **complex number** (e.g. 5j), + then the integer part of its magnitude is interpreted as + specifying the number of points to create between the start and + stop values, where the stop value **is inclusive**. + + See also + -------- + ogrid + + Examples + -------- + >>> np.mgrid[0:5,0:5] + array([[[0, 0, 0, 0, 0], + [1, 1, 1, 1, 1], + [2, 2, 2, 2, 2], + [3, 3, 3, 3, 3], + [4, 4, 4, 4, 4]], + <BLANKLINE> + [[0, 1, 2, 3, 4], + [0, 1, 2, 3, 4], + [0, 1, 2, 3, 4], + [0, 1, 2, 3, 4], + [0, 1, 2, 3, 4]]]) + >>> np.mgrid[-1:1:5j] + array([-1. , -0.5, 0. , 0.5, 1. ]) + """) + +add_newdoc('numpy.lib.index_tricks', 'ogrid', + """ + Construct a multi-dimensional open "meshgrid". + + Returns an 'open' mesh-grid when indexed. The dimension and + number of the output arrays are equal to the number of indexing + dimensions. If the step length is not a complex number, then the + stop is not inclusive. + + The returned mesh-grid is open (or not fleshed out), so that only + one-dimension of each returned argument is greater than 1 + + If the step length is a **complex number** (e.g. 5j), then the + integer part of its magnitude is interpreted as specifying the + number of points to create between the start and stop values, + where the stop value **is inclusive**. + + See also + -------- + mgrid + + Examples + -------- + >>> np.ogrid[0:5,0:5] + [array([[0], + [1], + [2], + [3], + [4]]), array([[0, 1, 2, 3, 4]])] + """) + + +############################################################################## +# +# Documentation for `generic` attributes and methods +# +############################################################################## + +add_newdoc('numpy.core.numerictypes', 'generic', + """ + """) + +# Attributes + +add_newdoc('numpy.core.numerictypes', 'generic', ('T', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('base', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('data', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('dtype', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('flags', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('flat', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('imag', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('itemsize', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('nbytes', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('ndim', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('real', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('shape', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('size', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('strides', + """ + """)) + +# Methods + +add_newdoc('numpy.core.numerictypes', 'generic', ('all', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('any', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('argmax', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('argmin', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('argsort', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('astype', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('byteswap', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('choose', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('clip', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('compress', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('conjugate', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('copy', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('cumprod', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('cumsum', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('diagonal', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('dump', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('dumps', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('fill', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('flatten', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('getfield', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('item', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('itemset', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('max', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('mean', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('min', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('newbyteorder', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('nonzero', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('prod', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('ptp', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('put', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('ravel', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('repeat', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('reshape', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('resize', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('round', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('searchsorted', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('setfield', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('setflags', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('sort', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('squeeze', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('std', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('sum', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('swapaxes', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('take', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('tofile', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('tolist', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('tostring', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('trace', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('transpose', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('var', + """ + """)) + +add_newdoc('numpy.core.numerictypes', 'generic', ('view', + """ + """)) + + +############################################################################## +# +# Documentation for other scalar classes +# +############################################################################## + +add_newdoc('numpy.core.numerictypes', 'bool_', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'complex64', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'complex128', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'complex256', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'float32', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'float64', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'float96', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'float128', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'int8', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'int16', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'int32', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'int64', + """ + """) + +add_newdoc('numpy.core.numerictypes', 'object_', + """ + """) |