Referencia del Namespace vsm.structarr

Funciones
def	arr_add_field
def	enum_array
def	enum_matrix
def	enum_sort
def	map_strarr
def	zip_arr

Variables
list	__all__

Descripción detallada

[Documentation for structarr]

Documentación de las funciones

def vsm.structarr.arr_add_field	(		arr,
			new_field,
			vals
	)

Adds a new field to a structured array.
This is a handy function for adding new metadata to 
the original metadata array in Corpus object.

:param arr: A structured array.
:type arr: array

:param new_field: The dtype name for the values.
:type new_field: string

:param vals: A list of values. `vals` must have the same length as `arr`.
:type vals: list

:returns: new_arr : New array with the added values.

:See Also: :meth:`view_metadata`

**Examples**

>>> arr = np.array([('a', 1), ('b', 2), ('c', 3)], 
        dtype=[('field', '|S4'), ('i', '<i4')])
>>> vals = [-1, -2, -3]
>>> arr_add_field(arr, 'neg_i', vals)
array([('a', 1, -1), ('b', 2, -2), ('c', 3, -3)], 
      dtype=[('field', '|S4'), ('i', '<i4'), ('neg_i', '<i8')])

def vsm.structarr.enum_array	(		arr,
			indices = [],
			field_name = 'i'
	)

Takes an array and returns a structured array with indices
and values as dtype names.

:param arr: 1-dimensional array
:type arr: array

:param indices: List of indices. If `indices` is empty, then `indices` 
    is set to a range of indices for the length of `arr`. 
    Default is an empty list.
:type indices: list, optional

:param field_name: Name for indices in the structured array dtype. 
    Default is 'i'.
:type field_name: string, optional 

:returns: A structured array with indices and value fields.

:See Also: :meth:`zip_arr`

**Examples**

>>> arr = np.array([7,3,1,8,2])
>>> enum_array(arr)
array([(0, 7), (1, 3), (2, 1), (3, 8), (4, 2)], 
      dtype=[('i', '<i8'), ('value', '<i8')])

def vsm.structarr.enum_matrix	(		arr,
			axis = 0,
			indices = [],
			field_name = 'i'
	)

Takes a 1-dimensional or 2-dimensional array and returns a sorted
structured array with indices.

:param arr: 1-dimensional or 2-dimensional numpy array.
:type arr: array

:param axis: Array axis 0 or 1. Default is 0.
:type axis: int, optional

:param indices: List of indices. If 'indices' is empty, then `indices` 
    is set to a range of indices for the length of `arr`. 
    Default is an empty list.
:type indices: list, optional

:param field_name: Name for indices in the structured array dtype. 
    Default is 'i'.
:type field_name: string, optional

:returns: mt : A sorted structured array with indices.

:See Also: :meth:`zip_arr`

**Examples**

>>> arr = np.array([[6,3,7],[2,0,4]])
>>> enum_matrix(arr)
array([[(2, 7), (0, 6), (1, 3)],
       [(2, 4), (0, 2), (1, 0)]], 
       dtype=[('i', '<i8'), ('value', '<i8')])

def vsm.structarr.enum_sort	(		arr,
			indices = [],
			field_name = 'i',
			filter_nan = False
	)

Takes a 1-dimensional array and returns a sorted array with matching
indices from the original array.

:param arr: A structured 1-dimensional array.
:type arr: array

:param indices: List of indices. If `indices` is empty, then `indices`
    is set to a range of indices for the length of `arr`. 
    Default is an empty list.
:type indices: list, optional

:param field_name: Name for indices in the structured array dtype. 
    Default is 'i'.
:type field_name: string, optional

:param filter_nan: If `True`, Not a Number values are filtered. 
    Default is `False`.
:type filter_nan: boolean, optional

:returns: A sorted structured array.

**Examples**

>>> arr = np.array([7,3,1,8,2])
>>> enum_sort(arr)
array([(3, 8), (0, 7), (1, 3), (4, 2), (2, 1)], 
      dtype=[('i', '<i8'), ('value', '<i8')])

def vsm.structarr.map_strarr	(		arr,
			m,
			k,
			new_k = None
	)

Takes a structured array `arr`, a field name `k` and an Indexable
`m` and returns a copy of `arr` with its field `k` values mapped
according to `m`. If `new_name` is given, the field name `k` is
replaced with `new_name`.

:param arr: A structured array.
:type arr: array

:type m: iterable
:param m: An indexable array or list to retrieve the values from.
    The iterable contains values to replace the original `k` values.
:type k: string
:param k: Field name of `arr`. arr[k] are the values to be replaced. 
    arr[k] should be an array of integers.
:type new_k: string, optional
:param new_k: Field name for the new values. If not provided, field name
    is then set to `k`, the original field name. Default is `None`.

:returns: new_ arr : A new array with `k` values replaced by values in `m`.

**Examples**

>>> arr = np.array([(0, 1.), (1, 2.)], dtype=[('i', 'i4'), ('v', 'f4')])
>>> m = ['foo', 'bar']
>>> map_strarr(arr, m, 'i', 'string')
array([('foo', 1.0), ('bar', 2.0)], 
      dtype=[('string', '|S3'), ('v', '<f4')])

def vsm.structarr.zip_arr	(		arr_1,
			arr_2,
			field_names = ['arr_1',
			arr_2
	)

Takes two arrays with same shape and returns a zipped structured array.

:param arr_1: 1-dimensional array.        
:type arr_1: array

:param arr_2: 1-dimensional array.
:type arr_2: array

:param field_names: List of numpy dtype names.
:type field_names: list, optional

:returns: new_arr : Zipped array of `arr_1` and `arr_2`.

**Examples**

>>> a1 = np.array([[2,4], [6,8]])
>>> a2 = np.array([[1,3],[5,7]])
>>> zip_arr(a1, a2, field_names=['even', 'odd'])
array([[(2, 1), (4, 3)],
       [(6, 5), (8, 7)]], 
       dtype=[('even', '<i8'), ('odd', '<i8')])

Documentación de las variables

list vsm.structarr.__all__

Valor inicial:

= ['arr_add_field', 'enum_array', 'enum_matrix', 
           'enum_sort', 'map_strarr', 'zip_arr']