Version 1.0b1 API Documentation generated by Endo 2006-08-14

Variables

• row_stack

  row_stack = vstack
  
  

Function summary

• apply_along_axis(func1d, axis, arr, args)
• apply_over_axes(func, a, axes)
• array_split(ary, indices_or_sections, axis = 0)
• atleast_1d(arys)
• atleast_2d(arys)
• atleast_3d(arys)
• column_stack(tup)
• dsplit(ary, indices_or_sections)
• dstack(tup)
• expand_dims(a, axis)
• hsplit(ary, indices_or_sections)
• hstack(tup)
• kron(a, b)
• repmat(a, m, n)
• split(ary, indices_or_sections, axis = 0)
• vsplit(ary, indices_or_sections)
• vstack(tup)

Functions

• apply_along_axis(func1d, axis, arr, args)

  Execute func1d(arr[i],*args) where func1d takes 1-D arrays and arr is an N-d array. i varies so as to apply the function along the given axis for each 1-d subarray in arr.

• apply_over_axes(func, a, axes)

  Apply a function repeatedly over multiple axes, keeping the same shape for the resulting array.

  func is called as res = func(a, axis). The result is assumed to be either the same shape as a or have one less dimension. This call is repeated for each axis in the axes sequence.

• array_split(ary, indices_or_sections, axis = 0)

  Divide an array into a list of sub-arrays.

  Description:

  Divide ary into a list of sub-arrays along the specified axis. If indices_or_sections is an integer, ary is divided into that many equally sized arrays. If it is impossible to make an equal split, each of the leading arrays in the list have one additional member. If indices_or_sections is a list of sorted integers, its entries define the indexes where ary is split.

  Arguments:

  ary -- N-D array.

  Array to be divided into sub-arrays.

  indices_or_sections -- integer or 1D array.

  If integer, defines the number of (close to) equal sized sub-arrays. If it is a 1D array of sorted indices, it defines the indexes at which ary is divided. Any empty list results in a single sub-array equal to the original array.

  axis -- integer. default=0.

  Specifies the axis along which to split ary.

  Caveats:

  Currently, the default for axis is 0. This means a 2D array is divided into multiple groups of rows. This seems like the appropriate default, but we've agreed most other functions should default to axis=-1. Perhaps we should use axis=-1 for consistency. However, we could also make the argument that NumPy works on "rows" by default. sum() sums up rows of values. split() will split data into rows. Opinions?

• atleast_1d(arys)

  Force a sequence of arrays to each be at least 1D.
  
  Description:
     Force an array to be at least 1D.  If an array is 0D, the
     array is converted to a single row of values.  Otherwise,
     the array is unaltered.
  Arguments:
     *arys -- arrays to be converted to 1 or more dimensional array.
  Returns:
     input array converted to at least 1D array.
  

• atleast_2d(arys)

  Force a sequence of arrays to each be at least 2D.

  Description:

  Force an array to each be at least 2D. If the array is 0D or 1D, the array is converted to a single row of values. Otherwise, the array is unaltered.

  Arguments:

  arys -- arrays to be converted to 2 or more dimensional array.

  Returns:

  input array converted to at least 2D array.

• atleast_3d(arys)

  Force a sequence of arrays to each be at least 3D.

  Description:

  Force an array each be at least 3D. If the array is 0D or 1D, the array is converted to a single 1xNx1 array of values where N is the orginal length of the array. If the array is 2D, the array is converted to a single MxNx1 array of values where MxN is the orginal shape of the array. Otherwise, the array is unaltered.

  Arguments:

  arys -- arrays to be converted to 3 or more dimensional array.

  Returns:

  input array converted to at least 3D array.

• column_stack(tup)

  Stack 1D arrays as columns into a 2D array

  Description:

  Take a sequence of 1D arrays and stack them as columns to make a single 2D array. All arrays in the sequence must have the same length.

  Arguments:

  tup -- sequence of 1D arrays. All arrays must have the same

  length.

  Examples:

  >>> import numpy
  >>> a = array((1,2,3))
  >>> b = array((2,3,4))
  >>> numpy.column_stack((a,b))
  array([[1, 2],
         [2, 3],
         [3, 4]])
  

• dsplit(ary, indices_or_sections)

  Split ary into multiple sub-arrays along the 3rd axis (depth)

  Description:

  Split a single array into multiple sub arrays. The array is divided into groups along the 3rd axis. If indices_or_sections is an integer, ary is divided into that many equally sized sub arrays. If it is impossible to make the sub-arrays equally sized, the operation throws a ValueError exception. See array_split and split for other options on indices_or_sections.

  Arguments:

  ary -- N-D array.

  Array to be divided into sub-arrays.

  indices_or_sections -- integer or 1D array.

  If integer, defines the number of (close to) equal sized sub-arrays. If it is a 1D array of sorted indices, it defines the indexes at which ary is divided. Any empty list results in a single sub-array equal to the original array.

  Returns:

  sequence of sub-arrays. The returned arrays have the same number of dimensions as the input array.

  Caveats:

  See vsplit caveats.

  Related:

  dstack, split, array_split, hsplit, vsplit.

  Examples:

  >>> a = array([[[1,2,3,4],[1,2,3,4]]])
  [array([       [[1, 2],
          [1, 2]]]), array([       [[3, 4],
          [3, 4]]])]
  

• dstack(tup)

  Stack arrays in sequence depth wise (along third dimension)

  Description:

  Take a sequence of arrays and stack them along the third axis. All arrays in the sequence must have the same shape along all but the third axis. This is a simple way to stack 2D arrays (images) into a single 3D array for processing. dstack will rebuild arrays divided by dsplit.

  Arguments:

  tup -- sequence of arrays. All arrays must have the same

  shape.

  Examples:

  >>> import numpy
  >>> a = array((1,2,3))
  >>> b = array((2,3,4))
  >>> numpy.dstack((a,b))
  array([       [[1, 2],
          [2, 3],
          [3, 4]]])
  >>> a = array([[1],[2],[3]])
  >>> b = array([[2],[3],[4]])
  >>> numpy.dstack((a,b))
  array([[        [1, 2]],
         [        [2, 3]],
         [        [3, 4]]])
  

• expand_dims(a, axis)

  Expand the shape of a by including newaxis before given axis.

• hsplit(ary, indices_or_sections)

  Split ary into multiple columns of sub-arrays

  Description:

  Split a single array into multiple sub arrays. The array is divided into groups of columns. If indices_or_sections is an integer, ary is divided into that many equally sized sub arrays. If it is impossible to make the sub-arrays equally sized, the operation throws a ValueError exception. See array_split and split for other options on indices_or_sections.

  Arguments:

  ary -- N-D array.

  Array to be divided into sub-arrays.

  indices_or_sections -- integer or 1D array.

  If integer, defines the number of (close to) equal sized sub-arrays. If it is a 1D array of sorted indices, it defines the indexes at which ary is divided. Any empty list results in a single sub-array equal to the original array.

  Returns:

  sequence of sub-arrays. The returned arrays have the same number of dimensions as the input array.

  Related:

  hstack, split, array_split, vsplit, dsplit.

  Examples:

  >>> import numpy
  >>> a= array((1,2,3,4))
  >>> numpy.hsplit(a,2)
  [array([1, 2]), array([3, 4])]
  >>> a = array([[1,2,3,4],[1,2,3,4]])
  [array([[1, 2],
         [1, 2]]), array([[3, 4],
         [3, 4]])]
  

• hstack(tup)

  Stack arrays in sequence horizontally (column wise)

  Description:

  Take a sequence of arrays and stack them horizontally to make a single array. All arrays in the sequence must have the same shape along all but the second axis. hstack will rebuild arrays divided by hsplit.

  Arguments:

  tup -- sequence of arrays. All arrays must have the same

  shape.

  Examples:

  >>> import numpy
  >>> a = array((1,2,3))
  >>> b = array((2,3,4))
  >>> numpy.hstack((a,b))
  array([1, 2, 3, 2, 3, 4])
  >>> a = array([[1],[2],[3]])
  >>> b = array([[2],[3],[4]])
  >>> numpy.hstack((a,b))
  array([[1, 2],
         [2, 3],
         [3, 4]])
  

• kron(a, b)

  kronecker product of a and b
  
  Kronecker product of two matrices is block matrix
  [[ a[ 0 ,0]*b, a[ 0 ,1]*b, ... , a[ 0 ,n-1]*b  ],
   [ ...                                   ...   ],
   [ a[m-1,0]*b, a[m-1,1]*b, ... , a[m-1,n-1]*b  ]]
  

• repmat(a, m, n)

  Repeat a 0-d to 2-d array mxn times

• split(ary, indices_or_sections, axis = 0)

  Divide an array into a list of sub-arrays.

  Description:

  Divide ary into a list of sub-arrays along the specified axis. If indices_or_sections is an integer, ary is divided into that many equally sized arrays. If it is impossible to make an equal split, an error is raised. This is the only way this function differs from the array_split() function. If indices_or_sections is a list of sorted integers, its entries define the indexes where ary is split.

  Arguments:

  ary -- N-D array.

  Array to be divided into sub-arrays.

  indices_or_sections -- integer or 1D array.

  If integer, defines the number of (close to) equal sized sub-arrays. If it is a 1D array of sorted indices, it defines the indexes at which ary is divided. Any empty list results in a single sub-array equal to the original array.

  axis -- integer. default=0.

  Specifies the axis along which to split ary.

  Caveats:

  Currently, the default for axis is 0. This means a 2D array is divided into multiple groups of rows. This seems like the appropriate default, but we've agreed most other functions should default to axis=-1. Perhaps we should use axis=-1 for consistency. However, we could also make the argument that NumPy works on "rows" by default. sum() sums up rows of values. split() will split data into rows. Opinions?

• vsplit(ary, indices_or_sections)

  Split ary into multiple rows of sub-arrays

  Description:

  Split a single array into multiple sub arrays. The array is divided into groups of rows. If indices_or_sections is an integer, ary is divided into that many equally sized sub arrays. If it is impossible to make the sub-arrays equally sized, the operation throws a ValueError exception. See array_split and split for other options on indices_or_sections.

  Arguments:

  ary -- N-D array.

  Array to be divided into sub-arrays.

  indices_or_sections -- integer or 1D array.

  If integer, defines the number of (close to) equal sized sub-arrays. If it is a 1D array of sorted indices, it defines the indexes at which ary is divided. Any empty list results in a single sub-array equal to the original array.

  Returns:

  sequence of sub-arrays. The returned arrays have the same number of dimensions as the input array.

  Caveats:

  How should we handle 1D arrays here? I am currently raising an error when I encounter them. Any better approach?

  Should we reduce the returned array to their minium dimensions by getting rid of any dimensions that are 1?

  Related:

  vstack, split, array_split, hsplit, dsplit.

  Examples:

  import numpy >>> a = array([[1,2,3,4], ... [1,2,3,4]]) >>> numpy.vsplit(a) [array([ [1, 2, 3, 4]]), array([ [1, 2, 3, 4]])]

• vstack(tup)

  Stack arrays in sequence vertically (row wise)

  Description:

  Take a sequence of arrays and stack them veritcally to make a single array. All arrays in the sequence must have the same shape along all but the first axis. vstack will rebuild arrays divided by vsplit.

  Arguments:

  tup -- sequence of arrays. All arrays must have the same

  shape.

  Examples:

  >>> import numpy
  >>> a = array((1,2,3))
  >>> b = array((2,3,4))
  >>> numpy.vstack((a,b))
  array([[1, 2, 3],
         [2, 3, 4]])
  >>> a = array([[1],[2],[3]])
  >>> b = array([[2],[3],[4]])
  >>> numpy.vstack((a,b))
  array([[1],
         [2],
         [3],
         [2],
         [3],
         [4]])
  

Imported names