Routines

In this chapter routine docstrings are presented, grouped by functionality. Many docstrings contain example code, which demonstrates basic usage of the routine. The examples assume that NumPy is imported with:

>>> import numpy as np

A convenient way to execute examples is the %doctest_mode mode of IPython, which allows for pasting of multi-line examples and preserves indentation.

• Array creation routines
  • Ones and zeros
  • From existing data
  • Creating record arrays (numpy.rec)
  • Creating character arrays (numpy.char)
  • Numerical ranges
  • Building matrices
  • The Matrix class
• Array manipulation routines
  • Basic operations
  • Changing array shape
  • Transpose-like operations
  • Changing number of dimensions
  • Changing kind of array
  • Joining arrays
  • Splitting arrays
  • Tiling arrays
  • Adding and removing elements
  • Rearranging elements
• Binary operations
  • Elementwise bit operations
  • Bit packing
  • Output formatting
• String operations
  • String operations
  • Comparison
  • String information
  • Convenience class
• C-Types Foreign Function Interface (numpy.ctypeslib)
• Datetime Support Functions
  • Business Day Functions
• Data type routines
  • numpy.can_cast
  • numpy.promote_types
  • numpy.min_scalar_type
  • numpy.result_type
  • numpy.common_type
  • numpy.obj2sctype
  • Creating data types
  • Data type information
  • Data type testing
  • Miscellaneous
• Optionally Scipy-accelerated routines (numpy.dual)
  • Linear algebra
  • FFT
  • Other
• Mathematical functions with automatic domain (numpy.emath)
• Floating point error handling
  • Setting and getting error handling
  • Internal functions
• Discrete Fourier Transform (numpy.fft)
  • Standard FFTs
  • Real FFTs
  • Hermitian FFTs
  • Helper routines
  • Background information
  • Implementation details
  • Real and Hermitian transforms
  • Higher dimensions
  • References
  • Examples
• Financial functions
  • Simple financial functions
• Functional programming
  • numpy.apply_along_axis
  • numpy.apply_over_axes
  • numpy.vectorize
  • numpy.frompyfunc
  • numpy.piecewise
• Numpy-specific help functions
  • Finding help
  • Reading help
• Indexing routines
  • Generating index arrays
  • Indexing-like operations
  • Inserting data into arrays
  • Iterating over arrays
• Input and output
  • NPZ files
  • Text files
  • Raw binary files
  • String formatting
  • Memory mapping files
  • Text formatting options
  • Base-n representations
  • Data sources
• Linear algebra (numpy.linalg)
  • Matrix and vector products
  • Decompositions
  • Matrix eigenvalues
  • Norms and other numbers
  • Solving equations and inverting matrices
  • Exceptions
  • Linear algebra on several matrices at once
• Logic functions
  • Truth value testing
  • Array contents
  • Array type testing
  • Logical operations
  • Comparison
• Masked array operations
  • Constants
  • Creation
  • Inspecting the array
  • Manipulating a MaskedArray
  • Operations on masks
  • Conversion operations
  • Masked arrays arithmetics
• Mathematical functions
  • Trigonometric functions
  • Hyperbolic functions
  • Rounding
  • Sums, products, differences
  • Exponents and logarithms
  • Other special functions
  • Floating point routines
  • Arithmetic operations
  • Handling complex numbers
  • Miscellaneous
• Matrix library (numpy.matlib)
  • numpy.matlib.empty
  • numpy.matlib.zeros
  • numpy.matlib.ones
  • numpy.matlib.eye
  • numpy.matlib.identity
  • numpy.matlib.repmat
  • numpy.matlib.rand
  • numpy.matlib.randn
• Numarray compatibility (numpy.numarray)
• Old Numeric compatibility (numpy.oldnumeric)
• Miscellaneous routines
  • Buffer objects
  • Performance tuning
• Padding Arrays
  • numpy.pad
• Polynomials
  • Transition notice
• Random sampling (numpy.random)
  • Simple random data
  • Permutations
  • Distributions
  • Random generator
• Set routines
  • Making proper sets
  • Boolean operations
• Sorting, searching, and counting
  • Sorting
  • Searching
  • Counting
• Statistics
  • Order statistics
  • Averages and variances
  • Correlating
  • Histograms
• Test Support (numpy.testing)
• Asserts
  • numpy.testing.assert_almost_equal
  • numpy.testing.assert_approx_equal
  • numpy.testing.assert_array_almost_equal
  • numpy.testing.assert_allclose
  • numpy.testing.assert_array_almost_equal_nulp
  • numpy.testing.assert_array_max_ulp
  • numpy.testing.assert_array_equal
  • numpy.testing.assert_array_less
  • numpy.testing.assert_equal
  • numpy.testing.assert_raises
  • numpy.testing.assert_warns
  • numpy.testing.assert_string_equal
  • Decorators
  • Test Running
• Window functions
  • Various windows