alias¶
Classes
|
An ndarray with a mapping of values to user-friendly names -- see example |
|
Same as |
|
An all-or-nothing array index based on equality with a specific value |
String subclass with special support for strings of the form "first|second" |
- class AliasArray(array: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], mapping: dict)¶
An ndarray with a mapping of values to user-friendly names – see example
This ndarray subclass enables comparing sub_id and hop_id arrays directly with their friendly string identifiers. The mapping parameter translates sublattice or hopping names into their number IDs.
Only the
==
and!=
operators are overloaded to handle the aliases.Examples
>>> a = AliasArray([0, 1, 0], mapping={"A": 0, "B": 1}) >>> [bool(aa) for aa in list(a == 0)] [True, False, True] >>> [bool(aa) for aa in list(a == "A")] [True, False, True] >>> [bool(aa) for aa in list(a != "A")] [False, True, False] >>> a = AliasArray([0, 1, 0, 2], mapping={"A|1": 0, "B": 1, "A|2": 2}) >>> [bool(aa) for aa in list(a == "A")] [True, False, True, True] >>> [bool(aa) for aa in list(a != "A")] [False, True, False, False] >>> import pickle >>> s = pickle.dumps(a) >>> a2 = pickle.loads(s) >>> [bool(aa) for aa in list(a2 == "A")] [True, False, True, True]
- __getitem__(key, /)¶
Return self[key].
- all(axis=None, out=None, keepdims=False, *, where=True)¶
Returns True if all elements evaluate to True.
Refer to
numpy.all
for full documentation.See also
numpy.all
equivalent function
- any(axis=None, out=None, keepdims=False, *, where=True)¶
Returns True if any of the elements of
a
evaluate to True.Refer to
numpy.any
for full documentation.See also
numpy.any
equivalent function
- argmax(axis=None, out=None, *, keepdims=False)¶
Return indices of the maximum values along the given axis.
Refer to
numpy.argmax
for full documentation.See also
numpy.argmax
equivalent function
- argmin(axis=None, out=None, *, keepdims=False)¶
Return indices of the minimum values along the given axis.
Refer to
numpy.argmin
for detailed documentation.See also
numpy.argmin
equivalent function
- argpartition(kth, axis=-1, kind='introselect', order=None)¶
Returns the indices that would partition this array.
Refer to
numpy.argpartition
for full documentation.Added in version 1.8.0.
See also
numpy.argpartition
equivalent function
- argsort(axis=-1, kind=None, order=None)¶
Returns the indices that would sort this array.
Refer to
numpy.argsort
for full documentation.See also
numpy.argsort
equivalent function
- astype(dtype, order='K', casting='unsafe', subok=True, copy=True)¶
Copy of the array, cast to a specified type.
- Parameters:
- dtypestr or dtype
Typecode or data-type to which the array is cast.
- order{‘C’, ‘F’, ‘A’, ‘K’}, optional
Controls the memory layout order of the result. ‘C’ means C order, ‘F’ means Fortran order, ‘A’ means ‘F’ order if all the arrays are Fortran contiguous, ‘C’ order otherwise, and ‘K’ means as close to the order the array elements appear in memory as possible. Default is ‘K’.
- casting{‘no’, ‘equiv’, ‘safe’, ‘same_kind’, ‘unsafe’}, optional
Controls what kind of data casting may occur. Defaults to ‘unsafe’ for backwards compatibility.
‘no’ means the data types should not be cast at all.
‘equiv’ means only byte-order changes are allowed.
‘safe’ means only casts which can preserve values are allowed.
‘same_kind’ means only safe casts or casts within a kind, like float64 to float32, are allowed.
‘unsafe’ means any data conversions may be done.
- subokbool, optional
If True, then sub-classes will be passed-through (default), otherwise the returned array will be forced to be a base-class array.
- copybool, optional
By default, astype always returns a newly allocated array. If this is set to false, and the
dtype
,order
, andsubok
requirements are satisfied, the input array is returned instead of a copy.
- Returns:
- arr_tndarray
Unless
copy
is False and the other conditions for returning the input array are satisfied (see description forcopy
input parameter),arr_t
is a new array of the same shape as the input array, with dtype, order given bydtype
,order
.
- Raises:
- ComplexWarning
When casting from complex to float or int. To avoid this, one should use
a.real.astype(t)
.
Notes
Changed in version 1.17.0: Casting between a simple data type and a structured one is possible only for “unsafe” casting. Casting to multiple fields is allowed, but casting from multiple fields is not.
Changed in version 1.9.0: Casting from numeric to string types in ‘safe’ casting mode requires that the string dtype length is long enough to store the max integer/float value converted.
Examples
>>> x = np.array([1, 2, 2.5]) >>> x array([1. , 2. , 2.5])
>>> x.astype(int) array([1, 2, 2])
- byteswap(inplace=False)¶
Swap the bytes of the array elements
Toggle between low-endian and big-endian data representation by returning a byteswapped array, optionally swapped in-place. Arrays of byte-strings are not swapped. The real and imaginary parts of a complex number are swapped individually.
- Parameters:
- inplacebool, optional
If
True
, swap bytes in-place, default isFalse
.
- Returns:
- outndarray
The byteswapped array. If
inplace
isTrue
, this is a view to self.
Examples
>>> A = np.array([1, 256, 8755], dtype=np.int16) >>> list(map(hex, A)) ['0x1', '0x100', '0x2233'] >>> A.byteswap(inplace=True) array([ 256, 1, 13090], dtype=int16) >>> list(map(hex, A)) ['0x100', '0x1', '0x3322']
Arrays of byte-strings are not swapped
>>> A = np.array([b'ceg', b'fac']) >>> A.byteswap() array([b'ceg', b'fac'], dtype='|S3')
A.view(A.dtype.newbyteorder()).byteswap()
produces an array with the same values but different representation in memory>>> A = np.array([1, 2, 3]) >>> A.view(np.uint8) array([1, 0, 0, 0, 0, 0, 0, 0, 2, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0], dtype=uint8) >>> A.view(A.dtype.newbyteorder()).byteswap(inplace=True) array([1, 2, 3]) >>> A.view(np.uint8) array([0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 2, 0, 0, 0, 0, 0, 0, 0, 3], dtype=uint8)
- choose(choices, out=None, mode='raise')¶
Use an index array to construct a new array from a set of choices.
Refer to
numpy.choose
for full documentation.See also
numpy.choose
equivalent function
- clip(min=None, max=None, out=None, **kwargs)¶
Return an array whose values are limited to
[min, max]
. One of max or min must be given.Refer to
numpy.clip
for full documentation.See also
numpy.clip
equivalent function
- compress(condition, axis=None, out=None)¶
Return selected slices of this array along given axis.
Refer to
numpy.compress
for full documentation.See also
numpy.compress
equivalent function
- conj()¶
Complex-conjugate all elements.
Refer to
numpy.conjugate
for full documentation.See also
numpy.conjugate
equivalent function
- conjugate()¶
Return the complex conjugate, element-wise.
Refer to
numpy.conjugate
for full documentation.See also
numpy.conjugate
equivalent function
- copy(order='C')¶
Return a copy of the array.
- Parameters:
- order{‘C’, ‘F’, ‘A’, ‘K’}, optional
Controls the memory layout of the copy. ‘C’ means C-order, ‘F’ means F-order, ‘A’ means ‘F’ if
a
is Fortran contiguous, ‘C’ otherwise. ‘K’ means match the layout ofa
as closely as possible. (Note that this function andnumpy.copy()
are very similar but have different default values for their order= arguments, and this function always passes sub-classes through.)
See also
numpy.copy
Similar function with different default behavior
numpy.copyto
Notes
This function is the preferred method for creating an array copy. The function
numpy.copy()
is similar, but it defaults to using order ‘K’, and will not pass sub-classes through by default.Examples
>>> x = np.array([[1,2,3],[4,5,6]], order='F')
>>> y = x.copy()
>>> x.fill(0)
>>> x array([[0, 0, 0], [0, 0, 0]])
>>> y array([[1, 2, 3], [4, 5, 6]])
>>> y.flags['C_CONTIGUOUS'] True
For arrays containing Python objects (e.g. dtype=object), the copy is a shallow one. The new array will contain the same object which may lead to surprises if that object can be modified (is mutable):
>>> a = np.array([1, 'm', [2, 3, 4]], dtype=object) >>> b = a.copy() >>> b[2][0] = 10 >>> a array([1, 'm', list([10, 3, 4])], dtype=object)
To ensure all elements within an
object
array are copied, usecopy.deepcopy
:>>> import copy >>> a = np.array([1, 'm', [2, 3, 4]], dtype=object) >>> c = copy.deepcopy(a) >>> c[2][0] = 10 >>> c array([1, 'm', list([10, 3, 4])], dtype=object) >>> a array([1, 'm', list([2, 3, 4])], dtype=object)
- cumprod(axis=None, dtype=None, out=None)¶
Return the cumulative product of the elements along the given axis.
Refer to
numpy.cumprod
for full documentation.See also
numpy.cumprod
equivalent function
- cumsum(axis=None, dtype=None, out=None)¶
Return the cumulative sum of the elements along the given axis.
Refer to
numpy.cumsum
for full documentation.See also
numpy.cumsum
equivalent function
- diagonal(offset=0, axis1=0, axis2=1)¶
Return specified diagonals. In NumPy 1.9 the returned array is a read-only view instead of a copy as in previous NumPy versions. In a future version the read-only restriction will be removed.
Refer to
numpy.diagonal()
for full documentation.See also
numpy.diagonal
equivalent function
- dump(file)¶
Dump a pickle of the array to the specified file. The array can be read back with pickle.load or numpy.load.
- Parameters:
- filestr or Path
A string naming the dump file.
Changed in version 1.17.0:
pathlib.Path
objects are now accepted.
- dumps()¶
Returns the pickle of the array as a string. pickle.loads will convert the string back to an array.
- Parameters:
- None
- fill(value)¶
Fill the array with a scalar value.
- Parameters:
- valuescalar
All elements of
a
will be assigned this value.
Examples
>>> a = np.array([1, 2]) >>> a.fill(0) >>> a array([0, 0]) >>> a = np.empty(2) >>> a.fill(1) >>> a array([1., 1.])
Fill expects a scalar value and always behaves the same as assigning to a single array element. The following is a rare example where this distinction is important:
>>> a = np.array([None, None], dtype=object) >>> a[0] = np.array(3) >>> a array([array(3), None], dtype=object) >>> a.fill(np.array(3)) >>> a array([array(3), array(3)], dtype=object)
Where other forms of assignments will unpack the array being assigned:
>>> a[...] = np.array(3) >>> a array([3, 3], dtype=object)
- flatten(order='C')¶
Return a copy of the array collapsed into one dimension.
- Parameters:
- order{‘C’, ‘F’, ‘A’, ‘K’}, optional
‘C’ means to flatten in row-major (C-style) order. ‘F’ means to flatten in column-major (Fortran- style) order. ‘A’ means to flatten in column-major order if
a
is Fortran contiguous in memory, row-major order otherwise. ‘K’ means to flattena
in the order the elements occur in memory. The default is ‘C’.
- Returns:
- yndarray
A copy of the input array, flattened to one dimension.
Examples
>>> a = np.array([[1,2], [3,4]]) >>> a.flatten() array([1, 2, 3, 4]) >>> a.flatten('F') array([1, 3, 2, 4])
- getfield(dtype, offset=0)¶
Returns a field of the given array as a certain type.
A field is a view of the array data with a given data-type. The values in the view are determined by the given type and the offset into the current array in bytes. The offset needs to be such that the view dtype fits in the array dtype; for example an array of dtype complex128 has 16-byte elements. If taking a view with a 32-bit integer (4 bytes), the offset needs to be between 0 and 12 bytes.
- Parameters:
- dtypestr or dtype
The data type of the view. The dtype size of the view can not be larger than that of the array itself.
- offsetint
Number of bytes to skip before beginning the element view.
Examples
>>> x = np.diag([1.+1.j]*2) >>> x[1, 1] = 2 + 4.j >>> x array([[1.+1.j, 0.+0.j], [0.+0.j, 2.+4.j]]) >>> x.getfield(np.float64) array([[1., 0.], [0., 2.]])
By choosing an offset of 8 bytes we can select the complex part of the array for our view:
>>> x.getfield(np.float64, offset=8) array([[1., 0.], [0., 4.]])
- item(*args)¶
Copy an element of an array to a standard Python scalar and return it.
- Parameters:
- *argsArguments (variable number and type)
none: in this case, the method only works for arrays with one element (
a.size == 1
), which element is copied into a standard Python scalar object and returned.int_type: this argument is interpreted as a flat index into the array, specifying which element to copy and return.
tuple of int_types: functions as does a single int_type argument, except that the argument is interpreted as an nd-index into the array.
- Returns:
- zStandard Python scalar object
A copy of the specified element of the array as a suitable Python scalar
Notes
When the data type of
a
is longdouble or clongdouble, item() returns a scalar array object because there is no available Python scalar that would not lose information. Void arrays return a buffer object for item(), unless fields are defined, in which case a tuple is returned.item
is very similar to a[args], except, instead of an array scalar, a standard Python scalar is returned. This can be useful for speeding up access to elements of the array and doing arithmetic on elements of the array using Python’s optimized math.Examples
>>> np.random.seed(123) >>> x = np.random.randint(9, size=(3, 3)) >>> x array([[2, 2, 6], [1, 3, 6], [1, 0, 1]]) >>> x.item(3) 1 >>> x.item(7) 0 >>> x.item((0, 1)) 2 >>> x.item((2, 2)) 1
For an array with object dtype, elements are returned as-is.
>>> a = np.array([np.int64(1)], dtype=object) >>> a.item() #return np.int64 np.int64(1)
- max(axis=None, out=None, keepdims=False, initial=<no value>, where=True)¶
Return the maximum along a given axis.
Refer to
numpy.amax
for full documentation.See also
numpy.amax
equivalent function
- mean(axis=None, dtype=None, out=None, keepdims=False, *, where=True)¶
Returns the average of the array elements along given axis.
Refer to
numpy.mean
for full documentation.See also
numpy.mean
equivalent function
- min(axis=None, out=None, keepdims=False, initial=<no value>, where=True)¶
Return the minimum along a given axis.
Refer to
numpy.amin
for full documentation.See also
numpy.amin
equivalent function
- nonzero()¶
Return the indices of the elements that are non-zero.
Refer to
numpy.nonzero
for full documentation.See also
numpy.nonzero
equivalent function
- partition(kth, axis=-1, kind='introselect', order=None)¶
Partially sorts the elements in the array in such a way that the value of the element in k-th position is in the position it would be in a sorted array. In the output array, all elements smaller than the k-th element are located to the left of this element and all equal or greater are located to its right. The ordering of the elements in the two partitions on the either side of the k-th element in the output array is undefined.
Added in version 1.8.0.
- Parameters:
- kthint or sequence of ints
Element index to partition by. The kth element value will be in its final sorted position and all smaller elements will be moved before it and all equal or greater elements behind it. The order of all elements in the partitions is undefined. If provided with a sequence of kth it will partition all elements indexed by kth of them into their sorted position at once.
Deprecated since version 1.22.0: Passing booleans as index is deprecated.
- axisint, optional
Axis along which to sort. Default is -1, which means sort along the last axis.
- kind{‘introselect’}, optional
Selection algorithm. Default is ‘introselect’.
- orderstr or list of str, optional
When
a
is an array with fields defined, this argument specifies which fields to compare first, second, etc. A single field can be specified as a string, and not all fields need to be specified, but unspecified fields will still be used, in the order in which they come up in the dtype, to break ties.
See also
numpy.partition
Return a partitioned copy of an array.
argpartition
Indirect partition.
sort
Full sort.
Notes
See
np.partition
for notes on the different algorithms.Examples
>>> a = np.array([3, 4, 2, 1]) >>> a.partition(3) >>> a array([2, 1, 3, 4]) # may vary
>>> a.partition((1, 3)) >>> a array([1, 2, 3, 4])
- prod(axis=None, dtype=None, out=None, keepdims=False, initial=1, where=True)¶
Return the product of the array elements over the given axis
Refer to
numpy.prod
for full documentation.See also
numpy.prod
equivalent function
- put(indices, values, mode='raise')¶
Set
a.flat[n] = values[n]
for alln
in indices.Refer to
numpy.put
for full documentation.See also
numpy.put
equivalent function
- ravel([order])¶
Return a flattened array.
Refer to
numpy.ravel
for full documentation.See also
numpy.ravel
equivalent function
ndarray.flat
a flat iterator on the array.
- repeat(repeats, axis=None)¶
Repeat elements of an array.
Refer to
numpy.repeat
for full documentation.See also
numpy.repeat
equivalent function
- reshape(shape, /, *, order='C')¶
Returns an array containing the same data with a new shape.
Refer to
numpy.reshape
for full documentation.See also
numpy.reshape
equivalent function
Notes
Unlike the free function
numpy.reshape
, this method onndarray
allows the elements of the shape parameter to be passed in as separate arguments. For example,a.reshape(10, 11)
is equivalent toa.reshape((10, 11))
.
- resize(new_shape, refcheck=True)¶
Change shape and size of array in-place.
- Parameters:
- new_shapetuple of ints, or
n
ints Shape of resized array.
- refcheckbool, optional
If False, reference count will not be checked. Default is True.
- new_shapetuple of ints, or
- Returns:
- None
- Raises:
- ValueError
If
a
does not own its own data or references or views to it exist, and the data memory must be changed. PyPy only: will always raise if the data memory must be changed, since there is no reliable way to determine if references or views to it exist.- SystemError
If the
order
keyword argument is specified. This behaviour is a bug in NumPy.
See also
resize
Return a new array with the specified shape.
Notes
This reallocates space for the data area if necessary.
Only contiguous arrays (data elements consecutive in memory) can be resized.
The purpose of the reference count check is to make sure you do not use this array as a buffer for another Python object and then reallocate the memory. However, reference counts can increase in other ways so if you are sure that you have not shared the memory for this array with another Python object, then you may safely set
refcheck
to False.Examples
Shrinking an array: array is flattened (in the order that the data are stored in memory), resized, and reshaped:
>>> a = np.array([[0, 1], [2, 3]], order='C') >>> a.resize((2, 1)) >>> a array([[0], [1]])
>>> a = np.array([[0, 1], [2, 3]], order='F') >>> a.resize((2, 1)) >>> a array([[0], [2]])
Enlarging an array: as above, but missing entries are filled with zeros:
>>> b = np.array([[0, 1], [2, 3]]) >>> b.resize(2, 3) # new_shape parameter doesn't have to be a tuple >>> b array([[0, 1, 2], [3, 0, 0]])
Referencing an array prevents resizing…
>>> c = a >>> a.resize((1, 1)) Traceback (most recent call last): ... ValueError: cannot resize an array that references or is referenced ...
Unless
refcheck
is False:>>> a.resize((1, 1), refcheck=False) >>> a array([[0]]) >>> c array([[0]])
- round(decimals=0, out=None)¶
Return
a
with each element rounded to the given number of decimals.Refer to
numpy.around
for full documentation.See also
numpy.around
equivalent function
- searchsorted(v, side='left', sorter=None)¶
Find indices where elements of v should be inserted in a to maintain order.
For full documentation, see
numpy.searchsorted
See also
numpy.searchsorted
equivalent function
- setfield(val, dtype, offset=0)¶
Put a value into a specified place in a field defined by a data-type.
Place
val
intoa
’s field defined bydtype
and beginningoffset
bytes into the field.- Parameters:
- valobject
Value to be placed in field.
- dtypedtype object
Data-type of the field in which to place
val
.- offsetint, optional
The number of bytes into the field at which to place
val
.
- Returns:
- None
See also
Examples
>>> x = np.eye(3) >>> x.getfield(np.float64) array([[1., 0., 0.], [0., 1., 0.], [0., 0., 1.]]) >>> x.setfield(3, np.int32) >>> x.getfield(np.int32) array([[3, 3, 3], [3, 3, 3], [3, 3, 3]], dtype=int32) >>> x array([[1.0e+000, 1.5e-323, 1.5e-323], [1.5e-323, 1.0e+000, 1.5e-323], [1.5e-323, 1.5e-323, 1.0e+000]]) >>> x.setfield(np.eye(3), np.int32) >>> x array([[1., 0., 0.], [0., 1., 0.], [0., 0., 1.]])
- setflags(write=None, align=None, uic=None)¶
Set array flags WRITEABLE, ALIGNED, WRITEBACKIFCOPY, respectively.
These Boolean-valued flags affect how numpy interprets the memory area used by
a
(see Notes below). The ALIGNED flag can only be set to True if the data is actually aligned according to the type. The WRITEBACKIFCOPY flag can never be set to True. The flag WRITEABLE can only be set to True if the array owns its own memory, or the ultimate owner of the memory exposes a writeable buffer interface, or is a string. (The exception for string is made so that unpickling can be done without copying memory.)- Parameters:
- writebool, optional
Describes whether or not
a
can be written to.- alignbool, optional
Describes whether or not
a
is aligned properly for its type.- uicbool, optional
Describes whether or not
a
is a copy of another “base” array.
Notes
Array flags provide information about how the memory area used for the array is to be interpreted. There are 7 Boolean flags in use, only three of which can be changed by the user: WRITEBACKIFCOPY, WRITEABLE, and ALIGNED.
WRITEABLE (W) the data area can be written to;
ALIGNED (A) the data and strides are aligned appropriately for the hardware (as determined by the compiler);
WRITEBACKIFCOPY (X) this array is a copy of some other array (referenced by .base). When the C-API function PyArray_ResolveWritebackIfCopy is called, the base array will be updated with the contents of this array.
All flags can be accessed using the single (upper case) letter as well as the full name.
Examples
>>> y = np.array([[3, 1, 7], ... [2, 0, 0], ... [8, 5, 9]]) >>> y array([[3, 1, 7], [2, 0, 0], [8, 5, 9]]) >>> y.flags C_CONTIGUOUS : True F_CONTIGUOUS : False OWNDATA : True WRITEABLE : True ALIGNED : True WRITEBACKIFCOPY : False >>> y.setflags(write=0, align=0) >>> y.flags C_CONTIGUOUS : True F_CONTIGUOUS : False OWNDATA : True WRITEABLE : False ALIGNED : False WRITEBACKIFCOPY : False >>> y.setflags(uic=1) Traceback (most recent call last): File "<stdin>", line 1, in <module> ValueError: cannot set WRITEBACKIFCOPY flag to True
- sort(axis=-1, kind=None, order=None)¶
Sort an array in-place. Refer to
numpy.sort
for full documentation.- Parameters:
- axisint, optional
Axis along which to sort. Default is -1, which means sort along the last axis.
- kind{‘quicksort’, ‘mergesort’, ‘heapsort’, ‘stable’}, optional
Sorting algorithm. The default is ‘quicksort’. Note that both ‘stable’ and ‘mergesort’ use timsort under the covers and, in general, the actual implementation will vary with datatype. The ‘mergesort’ option is retained for backwards compatibility.
Changed in version 1.15.0: The ‘stable’ option was added.
- orderstr or list of str, optional
When
a
is an array with fields defined, this argument specifies which fields to compare first, second, etc. A single field can be specified as a string, and not all fields need be specified, but unspecified fields will still be used, in the order in which they come up in the dtype, to break ties.
See also
numpy.sort
Return a sorted copy of an array.
numpy.argsort
Indirect sort.
numpy.lexsort
Indirect stable sort on multiple keys.
numpy.searchsorted
Find elements in sorted array.
numpy.partition
Partial sort.
Notes
See
numpy.sort
for notes on the different sorting algorithms.Examples
>>> a = np.array([[1,4], [3,1]]) >>> a.sort(axis=1) >>> a array([[1, 4], [1, 3]]) >>> a.sort(axis=0) >>> a array([[1, 3], [1, 4]])
Use the
order
keyword to specify a field to use when sorting a structured array:>>> a = np.array([('a', 2), ('c', 1)], dtype=[('x', 'S1'), ('y', int)]) >>> a.sort(order='y') >>> a array([(b'c', 1), (b'a', 2)], dtype=[('x', 'S1'), ('y', '<i8')])
- squeeze(axis=None)¶
Remove axes of length one from
a
.Refer to
numpy.squeeze
for full documentation.See also
numpy.squeeze
equivalent function
- std(axis=None, dtype=None, out=None, ddof=0, keepdims=False, *, where=True)¶
Returns the standard deviation of the array elements along given axis.
Refer to
numpy.std
for full documentation.See also
numpy.std
equivalent function
- sum(axis=None, dtype=None, out=None, keepdims=False, initial=0, where=True)¶
Return the sum of the array elements over the given axis.
Refer to
numpy.sum
for full documentation.See also
numpy.sum
equivalent function
- swapaxes(axis1, axis2)¶
Return a view of the array with
axis1
andaxis2
interchanged.Refer to
numpy.swapaxes
for full documentation.See also
numpy.swapaxes
equivalent function
- take(indices, axis=None, out=None, mode='raise')¶
Return an array formed from the elements of
a
at the given indices.Refer to
numpy.take
for full documentation.See also
numpy.take
equivalent function
- tobytes(order='C')¶
Construct Python bytes containing the raw data bytes in the array.
Constructs Python bytes showing a copy of the raw contents of data memory. The bytes object is produced in C-order by default. This behavior is controlled by the
order
parameter.Added in version 1.9.0.
- Parameters:
- order{‘C’, ‘F’, ‘A’}, optional
Controls the memory layout of the bytes object. ‘C’ means C-order, ‘F’ means F-order, ‘A’ (short for Any) means ‘F’ if
a
is Fortran contiguous, ‘C’ otherwise. Default is ‘C’.
- Returns:
- sbytes
Python bytes exhibiting a copy of
a
’s raw data.
See also
frombuffer
Inverse of this operation, construct a 1-dimensional array from Python bytes.
Examples
>>> x = np.array([[0, 1], [2, 3]], dtype='<u2') >>> x.tobytes() b'\x00\x00\x01\x00\x02\x00\x03\x00' >>> x.tobytes('C') == x.tobytes() True >>> x.tobytes('F') b'\x00\x00\x02\x00\x01\x00\x03\x00'
- tofile(fid, sep='', format='%s')¶
Write array to a file as text or binary (default).
Data is always written in ‘C’ order, independent of the order of
a
. The data produced by this method can be recovered using the function fromfile().- Parameters:
- fidfile or str or Path
An open file object, or a string containing a filename.
Changed in version 1.17.0:
pathlib.Path
objects are now accepted.- sepstr
Separator between array items for text output. If “” (empty), a binary file is written, equivalent to
file.write(a.tobytes())
.- formatstr
Format string for text file output. Each entry in the array is formatted to text by first converting it to the closest Python type, and then using “format” % item.
Notes
This is a convenience function for quick storage of array data. Information on endianness and precision is lost, so this method is not a good choice for files intended to archive data or transport data between machines with different endianness. Some of these problems can be overcome by outputting the data as text files, at the expense of speed and file size.
When fid is a file object, array contents are directly written to the file, bypassing the file object’s
write
method. As a result, tofile cannot be used with files objects supporting compression (e.g., GzipFile) or file-like objects that do not supportfileno()
(e.g., BytesIO).
- tolist()¶
Return the array as an
a.ndim
-levels deep nested list of Python scalars.Return a copy of the array data as a (nested) Python list. Data items are converted to the nearest compatible builtin Python type, via the
~numpy.ndarray.item
function.If
a.ndim
is 0, then since the depth of the nested list is 0, it will not be a list at all, but a simple Python scalar.- Parameters:
- none
- Returns:
- yobject, or list of object, or list of list of object, or …
The possibly nested list of array elements.
Notes
The array may be recreated via
a = np.array(a.tolist())
, although this may sometimes lose precision.Examples
For a 1D array,
a.tolist()
is almost the same aslist(a)
, except thattolist
changes numpy scalars to Python scalars:>>> a = np.uint32([1, 2]) >>> a_list = list(a) >>> a_list [1, 2] >>> type(a_list[0]) <class 'numpy.uint32'> >>> a_tolist = a.tolist() >>> a_tolist [1, 2] >>> type(a_tolist[0]) <class 'int'>
Additionally, for a 2D array,
tolist
applies recursively:>>> a = np.array([[1, 2], [3, 4]]) >>> list(a) [array([1, 2]), array([3, 4])] >>> a.tolist() [[1, 2], [3, 4]]
The base case for this recursion is a 0D array:
>>> a = np.array(1) >>> list(a) Traceback (most recent call last): ... TypeError: iteration over a 0-d array >>> a.tolist() 1
- tostring(order='C')¶
A compatibility alias for
~ndarray.tobytes
, with exactly the same behavior.Despite its name, it returns
bytes
notstr
s.Deprecated since version 1.19.0.
- trace(offset=0, axis1=0, axis2=1, dtype=None, out=None)¶
Return the sum along diagonals of the array.
Refer to
numpy.trace
for full documentation.See also
numpy.trace
equivalent function
- transpose(*axes)¶
Returns a view of the array with axes transposed.
Refer to
numpy.transpose
for full documentation.- Parameters:
- axesNone, tuple of ints, or
n
ints None or no argument: reverses the order of the axes.
tuple of ints:
i
in thej
-th place in the tuple means that the array’si
-th axis becomes the transposed array’sj
-th axis.n
ints: same as an n-tuple of the same ints (this form is intended simply as a “convenience” alternative to the tuple form).
- axesNone, tuple of ints, or
- Returns:
- pndarray
View of the array with its axes suitably permuted.
See also
transpose
Equivalent function.
ndarray.T
Array property returning the array transposed.
ndarray.reshape
Give a new shape to an array without changing its data.
Examples
>>> a = np.array([[1, 2], [3, 4]]) >>> a array([[1, 2], [3, 4]]) >>> a.transpose() array([[1, 3], [2, 4]]) >>> a.transpose((1, 0)) array([[1, 3], [2, 4]]) >>> a.transpose(1, 0) array([[1, 3], [2, 4]])
>>> a = np.array([1, 2, 3, 4]) >>> a array([1, 2, 3, 4]) >>> a.transpose() array([1, 2, 3, 4])
- var(axis=None, dtype=None, out=None, ddof=0, keepdims=False, *, where=True)¶
Returns the variance of the array elements, along given axis.
Refer to
numpy.var
for full documentation.See also
numpy.var
equivalent function
- view([dtype][, type])¶
New view of array with the same data.
Note
Passing None for
dtype
is different from omitting the parameter, since the former invokesdtype(None)
which is an alias fordtype('float64')
.- Parameters:
- dtypedata-type or ndarray sub-class, optional
Data-type descriptor of the returned view, e.g., float32 or int16. Omitting it results in the view having the same data-type as
a
. This argument can also be specified as an ndarray sub-class, which then specifies the type of the returned object (this is equivalent to setting thetype
parameter).- typePython type, optional
Type of the returned view, e.g., ndarray or matrix. Again, omission of the parameter results in type preservation.
Notes
a.view()
is used two different ways:a.view(some_dtype)
ora.view(dtype=some_dtype)
constructs a view of the array’s memory with a different data-type. This can cause a reinterpretation of the bytes of memory.a.view(ndarray_subclass)
ora.view(type=ndarray_subclass)
just returns an instance ofndarray_subclass
that looks at the same array (same shape, dtype, etc.) This does not cause a reinterpretation of the memory.For
a.view(some_dtype)
, ifsome_dtype
has a different number of bytes per entry than the previous dtype (for example, converting a regular array to a structured array), then the last axis ofa
must be contiguous. This axis will be resized in the result.Changed in version 1.23.0: Only the last axis needs to be contiguous. Previously, the entire array had to be C-contiguous.
Examples
>>> x = np.array([(1, 2)], dtype=[('a', np.int8), ('b', np.int8)])
Viewing array data using a different type and dtype:
>>> y = x.view(dtype=np.int16, type=np.matrix) >>> y matrix([[513]], dtype=int16) >>> print(type(y)) <class 'numpy.matrix'>
Creating a view on a structured array so it can be used in calculations
>>> x = np.array([(1, 2),(3,4)], dtype=[('a', np.int8), ('b', np.int8)]) >>> xv = x.view(dtype=np.int8).reshape(-1,2) >>> xv array([[1, 2], [3, 4]], dtype=int8) >>> xv.mean(0) array([2., 3.])
Making changes to the view changes the underlying array
>>> xv[0,1] = 20 >>> x array([(1, 20), (3, 4)], dtype=[('a', 'i1'), ('b', 'i1')])
Using a view to convert an array to a recarray:
>>> z = x.view(np.recarray) >>> z.a array([1, 3], dtype=int8)
Views share data:
>>> x[0] = (9, 10) >>> z[0] np.record((9, 10), dtype=[('a', 'i1'), ('b', 'i1')])
Views that change the dtype size (bytes per entry) should normally be avoided on arrays defined by slices, transposes, fortran-ordering, etc.:
>>> x = np.array([[1, 2, 3], [4, 5, 6]], dtype=np.int16) >>> y = x[:, ::2] >>> y array([[1, 3], [4, 6]], dtype=int16) >>> y.view(dtype=[('width', np.int16), ('length', np.int16)]) Traceback (most recent call last): ... ValueError: To change to a dtype of a different size, the last axis must be contiguous >>> z = y.copy() >>> z.view(dtype=[('width', np.int16), ('length', np.int16)]) array([[(1, 3)], [(4, 6)]], dtype=[('width', '<i2'), ('length', '<i2')])
However, views that change dtype are totally fine for arrays with a contiguous last axis, even if the rest of the axes are not C-contiguous:
>>> x = np.arange(2 * 3 * 4, dtype=np.int8).reshape(2, 3, 4) >>> x.transpose(1, 0, 2).view(np.int16) array([[[ 256, 770], [3340, 3854]], [[1284, 1798], [4368, 4882]], [[2312, 2826], [5396, 5910]]], dtype=int16)
- T¶
View of the transposed array.
Same as
self.transpose()
.See also
Examples
>>> a = np.array([[1, 2], [3, 4]]) >>> a array([[1, 2], [3, 4]]) >>> a.T array([[1, 3], [2, 4]])
>>> a = np.array([1, 2, 3, 4]) >>> a array([1, 2, 3, 4]) >>> a.T array([1, 2, 3, 4])
- base¶
Base object if memory is from some other object.
Examples
The base of an array that owns its memory is None:
>>> x = np.array([1,2,3,4]) >>> x.base is None True
Slicing creates a view, whose memory is shared with x:
>>> y = x[2:] >>> y.base is x True
- ctypes¶
An object to simplify the interaction of the array with the ctypes module.
This attribute creates an object that makes it easier to use arrays when calling shared libraries with the ctypes module. The returned object has, among others, data, shape, and strides attributes (see Notes below) which themselves return ctypes objects that can be used as arguments to a shared library.
- Parameters:
- None
- Returns:
- cPython object
Possessing attributes data, shape, strides, etc.
See also
Notes
Below are the public attributes of this object which were documented in “Guide to NumPy” (we have omitted undocumented public attributes, as well as documented private attributes):
- _ctypes.data
A pointer to the memory area of the array as a Python integer. This memory area may contain data that is not aligned, or not in correct byte-order. The memory area may not even be writeable. The array flags and data-type of this array should be respected when passing this attribute to arbitrary C-code to avoid trouble that can include Python crashing. User Beware! The value of this attribute is exactly the same as:
self._array_interface_['data'][0]
.Note that unlike
data_as
, a reference won’t be kept to the array: code likectypes.c_void_p((a + b).ctypes.data)
will result in a pointer to a deallocated array, and should be spelt(a + b).ctypes.data_as(ctypes.c_void_p)
- _ctypes.shape
(c_intp*self.ndim): A ctypes array of length self.ndim where the basetype is the C-integer corresponding to
dtype('p')
on this platform (see~numpy.ctypeslib.c_intp
). This base-type could bectypes.c_int
,ctypes.c_long
, orctypes.c_longlong
depending on the platform. The ctypes array contains the shape of the underlying array.
- _ctypes.strides
(c_intp*self.ndim): A ctypes array of length self.ndim where the basetype is the same as for the shape attribute. This ctypes array contains the strides information from the underlying array. This strides information is important for showing how many bytes must be jumped to get to the next element in the array.
- _ctypes.data_as(obj)
Return the data pointer cast to a particular c-types object. For example, calling
self._as_parameter_
is equivalent toself.data_as(ctypes.c_void_p)
. Perhaps you want to use the data as a pointer to a ctypes array of floating-point data:self.data_as(ctypes.POINTER(ctypes.c_double))
.The returned pointer will keep a reference to the array.
- _ctypes.shape_as(obj)
Return the shape tuple as an array of some other c-types type. For example:
self.shape_as(ctypes.c_short)
.
- _ctypes.strides_as(obj)
Return the strides tuple as an array of some other c-types type. For example:
self.strides_as(ctypes.c_longlong)
.
If the ctypes module is not available, then the ctypes attribute of array objects still returns something useful, but ctypes objects are not returned and errors may be raised instead. In particular, the object will still have the
as_parameter
attribute which will return an integer equal to the data attribute.Examples
>>> import ctypes >>> x = np.array([[0, 1], [2, 3]], dtype=np.int32) >>> x array([[0, 1], [2, 3]], dtype=int32) >>> x.ctypes.data 31962608 # may vary >>> x.ctypes.data_as(ctypes.POINTER(ctypes.c_uint32)) <__main__.LP_c_uint object at 0x7ff2fc1fc200> # may vary >>> x.ctypes.data_as(ctypes.POINTER(ctypes.c_uint32)).contents c_uint(0) >>> x.ctypes.data_as(ctypes.POINTER(ctypes.c_uint64)).contents c_ulong(4294967296) >>> x.ctypes.shape <numpy._core._internal.c_long_Array_2 object at 0x7ff2fc1fce60> # may vary >>> x.ctypes.strides <numpy._core._internal.c_long_Array_2 object at 0x7ff2fc1ff320> # may vary
- data¶
Python buffer object pointing to the start of the array’s data.
- dtype¶
Data-type of the array’s elements.
Warning
Setting
arr.dtype
is discouraged and may be deprecated in the future. Setting will replace thedtype
without modifying the memory (see alsondarray.view
andndarray.astype
).- Parameters:
- None
- Returns:
- dnumpy dtype object
See also
ndarray.astype
Cast the values contained in the array to a new data-type.
ndarray.view
Create a view of the same data but a different data-type.
numpy.dtype
Examples
>>> x array([[0, 1], [2, 3]]) >>> x.dtype dtype('int32') >>> type(x.dtype) <type 'numpy.dtype'>
- flags¶
Information about the memory layout of the array.
Notes
The
flags
object can be accessed dictionary-like (as ina.flags['WRITEABLE']
), or by using lowercased attribute names (as ina.flags.writeable
). Short flag names are only supported in dictionary access.Only the WRITEBACKIFCOPY, WRITEABLE, and ALIGNED flags can be changed by the user, via direct assignment to the attribute or dictionary entry, or by calling
ndarray.setflags
.The array flags cannot be set arbitrarily:
WRITEBACKIFCOPY can only be set
False
.ALIGNED can only be set
True
if the data is truly aligned.WRITEABLE can only be set
True
if the array owns its own memory or the ultimate owner of the memory exposes a writeable buffer interface or is a string.
Arrays can be both C-style and Fortran-style contiguous simultaneously. This is clear for 1-dimensional arrays, but can also be true for higher dimensional arrays.
Even for contiguous arrays a stride for a given dimension
arr.strides[dim]
may be arbitrary ifarr.shape[dim] == 1
or the array has no elements. It does not generally hold thatself.strides[-1] == self.itemsize
for C-style contiguous arrays orself.strides[0] == self.itemsize
for Fortran-style contiguous arrays is true.- Attributes:
- C_CONTIGUOUS (C)
The data is in a single, C-style contiguous segment.
- F_CONTIGUOUS (F)
The data is in a single, Fortran-style contiguous segment.
- OWNDATA (O)
The array owns the memory it uses or borrows it from another object.
- WRITEABLE (W)
The data area can be written to. Setting this to False locks the data, making it read-only. A view (slice, etc.) inherits WRITEABLE from its base array at creation time, but a view of a writeable array may be subsequently locked while the base array remains writeable. (The opposite is not true, in that a view of a locked array may not be made writeable. However, currently, locking a base object does not lock any views that already reference it, so under that circumstance it is possible to alter the contents of a locked array via a previously created writeable view onto it.) Attempting to change a non-writeable array raises a RuntimeError exception.
- ALIGNED (A)
The data and all elements are aligned appropriately for the hardware.
- WRITEBACKIFCOPY (X)
This array is a copy of some other array. The C-API function PyArray_ResolveWritebackIfCopy must be called before deallocating to the base array will be updated with the contents of this array.
- FNC
F_CONTIGUOUS and not C_CONTIGUOUS.
- FORC
F_CONTIGUOUS or C_CONTIGUOUS (one-segment test).
- BEHAVED (B)
ALIGNED and WRITEABLE.
- CARRAY (CA)
BEHAVED and C_CONTIGUOUS.
- FARRAY (FA)
BEHAVED and F_CONTIGUOUS and not C_CONTIGUOUS.
- flat¶
A 1-D iterator over the array.
This is a
numpy.flatiter
instance, which acts similarly to, but is not a subclass of, Python’s built-in iterator object.See also
flatten
Return a copy of the array collapsed into one dimension.
flatiter
Examples
>>> x = np.arange(1, 7).reshape(2, 3) >>> x array([[1, 2, 3], [4, 5, 6]]) >>> x.flat[3] 4 >>> x.T array([[1, 4], [2, 5], [3, 6]]) >>> x.T.flat[3] 5 >>> type(x.flat) <class 'numpy.flatiter'>
An assignment example:
>>> x.flat = 3; x array([[3, 3, 3], [3, 3, 3]]) >>> x.flat[[1,4]] = 1; x array([[3, 1, 3], [3, 1, 3]])
- imag¶
The imaginary part of the array.
Examples
>>> x = np.sqrt([1+0j, 0+1j]) >>> x.imag array([ 0. , 0.70710678]) >>> x.imag.dtype dtype('float64')
- itemsize¶
Length of one array element in bytes.
Examples
>>> x = np.array([1,2,3], dtype=np.float64) >>> x.itemsize 8 >>> x = np.array([1,2,3], dtype=np.complex128) >>> x.itemsize 16
- mT¶
View of the matrix transposed array.
The matrix transpose is the transpose of the last two dimensions, even if the array is of higher dimension.
Added in version 2.0.
- Raises:
- ValueError
If the array is of dimension less than 2.
Examples
>>> a = np.array([[1, 2], [3, 4]]) >>> a array([[1, 2], [3, 4]]) >>> a.mT array([[1, 3], [2, 4]])
>>> a = np.arange(8).reshape((2, 2, 2)) >>> a array([[[0, 1], [2, 3]], [[4, 5], [6, 7]]]) >>> a.mT array([[[0, 2], [1, 3]], [[4, 6], [5, 7]]])
- nbytes¶
Total bytes consumed by the elements of the array.
See also
sys.getsizeof
Memory consumed by the object itself without parents in case view. This does include memory consumed by non-element attributes.
Notes
Does not include memory consumed by non-element attributes of the array object.
Examples
>>> x = np.zeros((3,5,2), dtype=np.complex128) >>> x.nbytes 480 >>> np.prod(x.shape) * x.itemsize 480
- ndim¶
Number of array dimensions.
Examples
>>> x = np.array([1, 2, 3]) >>> x.ndim 1 >>> y = np.zeros((2, 3, 4)) >>> y.ndim 3
- real¶
The real part of the array.
See also
numpy.real
equivalent function
Examples
>>> x = np.sqrt([1+0j, 0+1j]) >>> x.real array([ 1. , 0.70710678]) >>> x.real.dtype dtype('float64')
- shape¶
Tuple of array dimensions.
The shape property is usually used to get the current shape of an array, but may also be used to reshape the array in-place by assigning a tuple of array dimensions to it. As with
numpy.reshape
, one of the new shape dimensions can be -1, in which case its value is inferred from the size of the array and the remaining dimensions. Reshaping an array in-place will fail if a copy is required.Warning
Setting
arr.shape
is discouraged and may be deprecated in the future. Usingndarray.reshape
is the preferred approach.See also
numpy.shape
Equivalent getter function.
numpy.reshape
Function similar to setting
shape
.ndarray.reshape
Method similar to setting
shape
.
Examples
>>> x = np.array([1, 2, 3, 4]) >>> x.shape (4,) >>> y = np.zeros((2, 3, 4)) >>> y.shape (2, 3, 4) >>> y.shape = (3, 8) >>> y array([[ 0., 0., 0., 0., 0., 0., 0., 0.], [ 0., 0., 0., 0., 0., 0., 0., 0.], [ 0., 0., 0., 0., 0., 0., 0., 0.]]) >>> y.shape = (3, 6) Traceback (most recent call last): File "<stdin>", line 1, in <module> ValueError: total size of new array must be unchanged >>> np.zeros((4,2))[::2].shape = (-1,) Traceback (most recent call last): File "<stdin>", line 1, in <module> AttributeError: Incompatible shape for in-place modification. Use `.reshape()` to make a copy with the desired shape.
- size¶
Number of elements in the array.
Equal to
np.prod(a.shape)
, i.e., the product of the array’s dimensions.Notes
a.size
returns a standard arbitrary precision Python integer. This may not be the case with other methods of obtaining the same value (like the suggestednp.prod(a.shape)
, which returns an instance ofnp.int_
), and may be relevant if the value is used further in calculations that may overflow a fixed size integer type.Examples
>>> x = np.zeros((3, 5, 2), dtype=np.complex128) >>> x.size 30 >>> np.prod(x.shape) 30
- strides¶
Tuple of bytes to step in each dimension when traversing an array.
The byte offset of element
(i[0], i[1], ..., i[n])
in an arraya
is:offset = sum(np.array(i) * a.strides)
A more detailed explanation of strides can be found in The N-dimensional array (ndarray).
Warning
Setting
arr.strides
is discouraged and may be deprecated in the future.numpy.lib.stride_tricks.as_strided
should be preferred to create a new view of the same data in a safer way.See also
Notes
Imagine an array of 32-bit integers (each 4 bytes):
x = np.array([[0, 1, 2, 3, 4], [5, 6, 7, 8, 9]], dtype=np.int32)
This array is stored in memory as 40 bytes, one after the other (known as a contiguous block of memory). The strides of an array tell us how many bytes we have to skip in memory to move to the next position along a certain axis. For example, we have to skip 4 bytes (1 value) to move to the next column, but 20 bytes (5 values) to get to the same position in the next row. As such, the strides for the array
x
will be(20, 4)
.Examples
>>> y = np.reshape(np.arange(2*3*4), (2,3,4)) >>> y array([[[ 0, 1, 2, 3], [ 4, 5, 6, 7], [ 8, 9, 10, 11]], [[12, 13, 14, 15], [16, 17, 18, 19], [20, 21, 22, 23]]]) >>> y.strides (48, 16, 4) >>> y[1,1,1] 17 >>> offset=sum(y.strides * np.array((1,1,1))) >>> offset/y.itemsize 17
>>> x = np.reshape(np.arange(5*6*7*8), (5,6,7,8)).transpose(2,3,1,0) >>> x.strides (32, 4, 224, 1344) >>> i = np.array([3,5,2,2]) >>> offset = sum(i * x.strides) >>> x[3,5,2,2] 813 >>> offset / x.itemsize 813
- class AliasCSRMatrix(*args, **kwargs)¶
Same as
AliasArray
but for a CSR matrixExamples
>>> from scipy.sparse import spdiags >>> m = AliasCSRMatrix(spdiags([1, 2, 1], [0], 3, 3), mapping={'A': 1, 'B': 2}) >>> [bool(aa) for aa in list(m.data == 'A')] [True, False, True] >>> [bool(aa) for aa in list(m.tocoo().data == 'A')] [True, False, True] >>> [bool(aa) for aa in list(m[:2].data == 'A')] [True, False] >>> import pickle >>> s = pickle.dumps(m) >>> m2 = pickle.loads(s) >>> [bool(aa) for aa in list(m2.data == 'A')] [True, False, True]
- arcsin()¶
Element-wise arcsin.
See
numpy.arcsin
for more information.
- arcsinh()¶
Element-wise arcsinh.
See
numpy.arcsinh
for more information.
- arctan()¶
Element-wise arctan.
See
numpy.arctan
for more information.
- arctanh()¶
Element-wise arctanh.
See
numpy.arctanh
for more information.
- argmax(axis=None, out=None)¶
Return indices of maximum elements along an axis.
Implicit zero elements are also taken into account. If there are several maximum values, the index of the first occurrence is returned.
- Parameters:
- axis{-2, -1, 0, 1, None}, optional
Axis along which the argmax is computed. If None (default), index of the maximum element in the flatten data is returned.
- outNone, optional
This argument is in the signature solely for NumPy compatibility reasons. Do not pass in anything except for the default value, as this argument is not used.
- Returns:
- indnumpy.matrix or int
Indices of maximum elements. If matrix, its size along
axis
is 1.
- argmin(axis=None, out=None)¶
Return indices of minimum elements along an axis.
Implicit zero elements are also taken into account. If there are several minimum values, the index of the first occurrence is returned.
- Parameters:
- axis{-2, -1, 0, 1, None}, optional
Axis along which the argmin is computed. If None (default), index of the minimum element in the flatten data is returned.
- outNone, optional
This argument is in the signature solely for NumPy compatibility reasons. Do not pass in anything except for the default value, as this argument is not used.
- Returns:
- indnumpy.matrix or int
Indices of minimum elements. If matrix, its size along
axis
is 1.
- asformat(format, copy=False)¶
Return this array/matrix in the passed format.
- Parameters:
- format{str, None}
The desired sparse format (“csr”, “csc”, “lil”, “dok”, “array”, …) or None for no conversion.
- copybool, optional
If True, the result is guaranteed to not share data with self.
- Returns:
- AThis array/matrix in the passed format.
- asfptype()¶
Upcast matrix to a floating point format (if necessary)
- astype(dtype, casting='unsafe', copy=True)¶
Cast the array/matrix elements to a specified type.
- Parameters:
- dtypestring or numpy dtype
Typecode or data-type to which to cast the data.
- casting{‘no’, ‘equiv’, ‘safe’, ‘same_kind’, ‘unsafe’}, optional
Controls what kind of data casting may occur. Defaults to ‘unsafe’ for backwards compatibility. ‘no’ means the data types should not be cast at all. ‘equiv’ means only byte-order changes are allowed. ‘safe’ means only casts which can preserve values are allowed. ‘same_kind’ means only safe casts or casts within a kind, like float64 to float32, are allowed. ‘unsafe’ means any data conversions may be done.
- copybool, optional
If
copy
isFalse
, the result might share some memory with this array/matrix. Ifcopy
isTrue
, it is guaranteed that the result and this array/matrix do not share any memory.
- ceil()¶
Element-wise ceil.
See
numpy.ceil
for more information.
- check_format(full_check=True)¶
Check whether the array/matrix respects the CSR or CSC format.
- Parameters:
- full_checkbool, optional
If
True
, run rigorous check, scanning arrays for valid values. Note that activating those check might copy arrays for casting, modifying indices and index pointers’ inplace. IfFalse
, run basic checks on attributes. O(1) operations. Default isTrue
.
- conj(copy=True)¶
Element-wise complex conjugation.
If the array/matrix is of non-complex data type and
copy
is False, this method does nothing and the data is not copied.- Parameters:
- copybool, optional
If True, the result is guaranteed to not share data with self.
- Returns:
- AThe element-wise complex conjugate.
- conjugate(copy=True)¶
Element-wise complex conjugation.
If the array/matrix is of non-complex data type and
copy
is False, this method does nothing and the data is not copied.- Parameters:
- copybool, optional
If True, the result is guaranteed to not share data with self.
- Returns:
- AThe element-wise complex conjugate.
- copy()¶
Returns a copy of this array/matrix.
No data/indices will be shared between the returned value and current array/matrix.
- count_nonzero()¶
Number of non-zero entries, equivalent to
np.count_nonzero(a.toarray())
Unlike the nnz property, which return the number of stored entries (the length of the data attribute), this method counts the actual number of non-zero entries in data.
- deg2rad()¶
Element-wise deg2rad.
See
numpy.deg2rad
for more information.
- diagonal(k=0)¶
Returns the kth diagonal of the array/matrix.
- Parameters:
- kint, optional
Which diagonal to get, corresponding to elements a[i, i+k]. Default: 0 (the main diagonal).
Added in version 1.0.
See also
numpy.diagonal
Equivalent numpy function.
Examples
>>> from scipy.sparse import csr_array >>> A = csr_array([[1, 2, 0], [0, 0, 3], [4, 0, 5]]) >>> A.diagonal() array([1, 0, 5]) >>> A.diagonal(k=1) array([2, 3])
- dot(other)¶
Ordinary dot product
Examples
>>> import numpy as np >>> from scipy.sparse import csr_array >>> A = csr_array([[1, 2, 0], [0, 0, 3], [4, 0, 5]]) >>> v = np.array([1, 0, -1]) >>> A.dot(v) array([ 1, -3, -1], dtype=int64)
- eliminate_zeros()¶
Remove zero entries from the array/matrix
This is an in place operation.
- expm1()¶
Element-wise expm1.
See
numpy.expm1
for more information.
- floor()¶
Element-wise floor.
See
numpy.floor
for more information.
- getH()¶
Return the Hermitian transpose of this matrix.
See also
numpy.matrix.getH
NumPy’s implementation of
getH
for matrices
- get_shape()¶
Get the shape of the matrix
- getcol(j)¶
Returns a copy of column j of the matrix, as an (m x 1) sparse matrix (column vector).
- getformat()¶
Matrix storage format
- getmaxprint()¶
Maximum number of elements to display when printed.
- getnnz(axis=None)¶
Number of stored values, including explicit zeros.
- Parameters:
- axisNone, 0, or 1
Select between the number of values across the whole array, in each column, or in each row.
- getrow(i)¶
Returns a copy of row i of the matrix, as a (1 x n) sparse matrix (row vector).
- log1p()¶
Element-wise log1p.
See
numpy.log1p
for more information.
- max(axis=None, out=None)¶
Return the maximum of the array/matrix or maximum along an axis. This takes all elements into account, not just the non-zero ones.
- Parameters:
- axis{-2, -1, 0, 1, None} optional
Axis along which the sum is computed. The default is to compute the maximum over all elements, returning a scalar (i.e.,
axis
=None
).- outNone, optional
This argument is in the signature solely for NumPy compatibility reasons. Do not pass in anything except for the default value, as this argument is not used.
- Returns:
- amaxcoo_matrix or scalar
Maximum of
a
. Ifaxis
is None, the result is a scalar value. Ifaxis
is given, the result is a sparse.coo_matrix of dimensiona.ndim - 1
.
See also
min
The minimum value of a sparse array/matrix along a given axis.
numpy.matrix.max
NumPy’s implementation of ‘max’ for matrices
- maximum(other)¶
Element-wise maximum between this and another array/matrix.
- mean(axis=None, dtype=None, out=None)¶
Compute the arithmetic mean along the specified axis.
Returns the average of the array/matrix elements. The average is taken over all elements in the array/matrix by default, otherwise over the specified axis.
float64
intermediate and return values are used for integer inputs.- Parameters:
- axis{-2, -1, 0, 1, None} optional
Axis along which the mean is computed. The default is to compute the mean of all elements in the array/matrix (i.e.,
axis
=None
).- dtypedata-type, optional
Type to use in computing the mean. For integer inputs, the default is
float64
; for floating point inputs, it is the same as the input dtype.Added in version 0.18.0.
- outnp.matrix, optional
Alternative output matrix in which to place the result. It must have the same shape as the expected output, but the type of the output values will be cast if necessary.
Added in version 0.18.0.
- Returns:
- mnp.matrix
See also
numpy.matrix.mean
NumPy’s implementation of ‘mean’ for matrices
- min(axis=None, out=None)¶
Return the minimum of the array/matrix or maximum along an axis. This takes all elements into account, not just the non-zero ones.
- Parameters:
- axis{-2, -1, 0, 1, None} optional
Axis along which the sum is computed. The default is to compute the minimum over all elements, returning a scalar (i.e.,
axis
=None
).- outNone, optional
This argument is in the signature solely for NumPy compatibility reasons. Do not pass in anything except for the default value, as this argument is not used.
- Returns:
- amincoo_matrix or scalar
Minimum of
a
. Ifaxis
is None, the result is a scalar value. Ifaxis
is given, the result is a sparse.coo_matrix of dimensiona.ndim - 1
.
See also
max
The maximum value of a sparse array/matrix along a given axis.
numpy.matrix.min
NumPy’s implementation of ‘min’ for matrices
- minimum(other)¶
Element-wise minimum between this and another array/matrix.
- multiply(other)¶
Point-wise multiplication by array/matrix, vector, or scalar.
- nanmax(axis=None, out=None)¶
Return the maximum of the array/matrix or maximum along an axis, ignoring any NaNs. This takes all elements into account, not just the non-zero ones.
Added in version 1.11.0.
- Parameters:
- axis{-2, -1, 0, 1, None} optional
Axis along which the maximum is computed. The default is to compute the maximum over all elements, returning a scalar (i.e.,
axis
=None
).- outNone, optional
This argument is in the signature solely for NumPy compatibility reasons. Do not pass in anything except for the default value, as this argument is not used.
- Returns:
- amaxcoo_matrix or scalar
Maximum of
a
. Ifaxis
is None, the result is a scalar value. Ifaxis
is given, the result is a sparse.coo_matrix of dimensiona.ndim - 1
.
See also
nanmin
The minimum value of a sparse array/matrix along a given axis, ignoring NaNs.
max
The maximum value of a sparse array/matrix along a given axis, propagating NaNs.
numpy.nanmax
NumPy’s implementation of ‘nanmax’.
- nanmin(axis=None, out=None)¶
Return the minimum of the array/matrix or minimum along an axis, ignoring any NaNs. This takes all elements into account, not just the non-zero ones.
Added in version 1.11.0.
- Parameters:
- axis{-2, -1, 0, 1, None} optional
Axis along which the minimum is computed. The default is to compute the minimum over all elements, returning a scalar (i.e.,
axis
=None
).- outNone, optional
This argument is in the signature solely for NumPy compatibility reasons. Do not pass in anything except for the default value, as this argument is not used.
- Returns:
- amincoo_matrix or scalar
Minimum of
a
. Ifaxis
is None, the result is a scalar value. Ifaxis
is given, the result is a sparse.coo_matrix of dimensiona.ndim - 1
.
See also
nanmax
The maximum value of a sparse array/matrix along a given axis, ignoring NaNs.
min
The minimum value of a sparse array/matrix along a given axis, propagating NaNs.
numpy.nanmin
NumPy’s implementation of ‘nanmin’.
- nonzero()¶
Nonzero indices of the array/matrix.
Returns a tuple of arrays (row,col) containing the indices of the non-zero elements of the array.
Examples
>>> from scipy.sparse import csr_array >>> A = csr_array([[1,2,0],[0,0,3],[4,0,5]]) >>> A.nonzero() (array([0, 0, 1, 2, 2]), array([0, 1, 2, 0, 2]))
- power(n, dtype=None)¶
This function performs element-wise power.
- Parameters:
- nscalar
n is a non-zero scalar (nonzero avoids dense ones creation) If zero power is desired, special case it to use
np.ones
- dtypeIf dtype is not specified, the current dtype will be preserved.
- Raises:
- NotImplementedErrorif n is a zero scalar
If zero power is desired, special case it to use
np.ones(A.shape, dtype=A.dtype)
- prune()¶
Remove empty space after all non-zero elements.
- rad2deg()¶
Element-wise rad2deg.
See
numpy.rad2deg
for more information.
- reshape(self, shape, order='C', copy=False)¶
Gives a new shape to a sparse array/matrix without changing its data.
- Parameters:
- shapelength-2 tuple of ints
The new shape should be compatible with the original shape.
- order{‘C’, ‘F’}, optional
Read the elements using this index order. ‘C’ means to read and write the elements using C-like index order; e.g., read entire first row, then second row, etc. ‘F’ means to read and write the elements using Fortran-like index order; e.g., read entire first column, then second column, etc.
- copybool, optional
Indicates whether or not attributes of self should be copied whenever possible. The degree to which attributes are copied varies depending on the type of sparse array being used.
- Returns:
- reshapedsparse array/matrix
A sparse array/matrix with the given
shape
, not necessarily of the same format as the current object.
See also
numpy.reshape
NumPy’s implementation of ‘reshape’ for ndarrays
- resize(*shape)¶
Resize the array/matrix in-place to dimensions given by
shape
Any elements that lie within the new shape will remain at the same indices, while non-zero elements lying outside the new shape are removed.
- Parameters:
- shape(int, int)
number of rows and columns in the new array/matrix
Notes
The semantics are not identical to
numpy.ndarray.resize
ornumpy.resize
. Here, the same data will be maintained at each index before and after reshape, if that index is within the new bounds. In numpy, resizing maintains contiguity of the array, moving elements around in the logical array but not within a flattened representation.We give no guarantees about whether the underlying data attributes (arrays, etc.) will be modified in place or replaced with new objects.
- rint()¶
Element-wise rint.
See
numpy.rint
for more information.
- set_shape(shape)¶
Set the shape of the matrix in-place
- setdiag(values, k=0)¶
Set diagonal or off-diagonal elements of the array/matrix.
- Parameters:
- valuesarray_like
New values of the diagonal elements.
Values may have any length. If the diagonal is longer than values, then the remaining diagonal entries will not be set. If values are longer than the diagonal, then the remaining values are ignored.
If a scalar value is given, all of the diagonal is set to it.
- kint, optional
Which off-diagonal to set, corresponding to elements a[i,i+k]. Default: 0 (the main diagonal).
- sign()¶
Element-wise sign.
See
numpy.sign
for more information.
- sin()¶
Element-wise sin.
See
numpy.sin
for more information.
- sinh()¶
Element-wise sinh.
See
numpy.sinh
for more information.
- sort_indices()¶
Sort the indices of this array/matrix in place
- sorted_indices()¶
Return a copy of this array/matrix with sorted indices
- sqrt()¶
Element-wise sqrt.
See
numpy.sqrt
for more information.
- sum(axis=None, dtype=None, out=None)¶
Sum the array/matrix elements over a given axis.
- Parameters:
- axis{-2, -1, 0, 1, None} optional
Axis along which the sum is computed. The default is to compute the sum of all the array/matrix elements, returning a scalar (i.e.,
axis
=None
).- dtypedtype, optional
The type of the returned array/matrix and of the accumulator in which the elements are summed. The dtype of
a
is used by default unlessa
has an integer dtype of less precision than the default platform integer. In that case, ifa
is signed then the platform integer is used while ifa
is unsigned then an unsigned integer of the same precision as the platform integer is used.Added in version 0.18.0.
- outnp.matrix, optional
Alternative output matrix in which to place the result. It must have the same shape as the expected output, but the type of the output values will be cast if necessary.
Added in version 0.18.0.
- Returns:
- sum_along_axisnp.matrix
A matrix with the same shape as
self
, with the specified axis removed.
See also
numpy.matrix.sum
NumPy’s implementation of ‘sum’ for matrices
- sum_duplicates()¶
Eliminate duplicate entries by adding them together
This is an in place operation.
- tan()¶
Element-wise tan.
See
numpy.tan
for more information.
- tanh()¶
Element-wise tanh.
See
numpy.tanh
for more information.
- toarray(order=None, out=None)¶
Return a dense ndarray representation of this sparse array/matrix.
- Parameters:
- order{‘C’, ‘F’}, optional
Whether to store multidimensional data in C (row-major) or Fortran (column-major) order in memory. The default is ‘None’, which provides no ordering guarantees. Cannot be specified in conjunction with the
out
argument.- outndarray, 2-D, optional
If specified, uses this array as the output buffer instead of allocating a new array to return. The provided array must have the same shape and dtype as the sparse array/matrix on which you are calling the method. For most sparse types,
out
is required to be memory contiguous (either C or Fortran ordered).
- Returns:
- arrndarray, 2-D
An array with the same shape and containing the same data represented by the sparse array/matrix, with the requested memory order. If
out
was passed, the same object is returned after being modified in-place to contain the appropriate values.
- tobsr(blocksize=None, copy=True)¶
Convert this array/matrix to Block Sparse Row format.
With copy=False, the data/indices may be shared between this array/matrix and the resultant bsr_array/matrix.
When blocksize=(R, C) is provided, it will be used for construction of the bsr_array/matrix.
- tocoo(*args, **kwargs) coo_matrix ¶
Convert this array/matrix to COOrdinate format.
With copy=False, the data/indices may be shared between this array/matrix and the resultant coo_array/matrix.
- tocsc(copy=False)¶
Convert this array/matrix to Compressed Sparse Column format.
With copy=False, the data/indices may be shared between this array/matrix and the resultant csc_array/matrix.
- tocsr(copy=False)¶
Convert this array/matrix to Compressed Sparse Row format.
With copy=False, the data/indices may be shared between this array/matrix and the resultant csr_array/matrix.
- todense(order=None, out=None)¶
Return a dense representation of this sparse array/matrix.
- Parameters:
- order{‘C’, ‘F’}, optional
Whether to store multi-dimensional data in C (row-major) or Fortran (column-major) order in memory. The default is ‘None’, which provides no ordering guarantees. Cannot be specified in conjunction with the
out
argument.- outndarray, 2-D, optional
If specified, uses this array (or
numpy.matrix
) as the output buffer instead of allocating a new array to return. The provided array must have the same shape and dtype as the sparse array/matrix on which you are calling the method.
- Returns:
- arrnumpy.matrix, 2-D
A NumPy matrix object with the same shape and containing the same data represented by the sparse array/matrix, with the requested memory order. If
out
was passed and was an array (rather than anumpy.matrix
), it will be filled with the appropriate values and returned wrapped in anumpy.matrix
object that shares the same memory.
- todia(copy=False)¶
Convert this array/matrix to sparse DIAgonal format.
With copy=False, the data/indices may be shared between this array/matrix and the resultant dia_array/matrix.
- todok(copy=False)¶
Convert this array/matrix to Dictionary Of Keys format.
With copy=False, the data/indices may be shared between this array/matrix and the resultant dok_array/matrix.
- tolil(copy=False)¶
Convert this array/matrix to List of Lists format.
With copy=False, the data/indices may be shared between this array/matrix and the resultant lil_array/matrix.
- trace(offset=0)¶
Returns the sum along diagonals of the sparse array/matrix.
- Parameters:
- offsetint, optional
Which diagonal to get, corresponding to elements a[i, i+offset]. Default: 0 (the main diagonal).
- transpose(axes=None, copy=False)¶
Reverses the dimensions of the sparse array/matrix.
- Parameters:
- axesNone, optional
This argument is in the signature solely for NumPy compatibility reasons. Do not pass in anything except for the default value.
- copybool, optional
Indicates whether or not attributes of
self
should be copied whenever possible. The degree to which attributes are copied varies depending on the type of sparse array/matrix being used.
- Returns:
- p
self
with the dimensions reversed.
- p
See also
numpy.transpose
NumPy’s implementation of ‘transpose’ for ndarrays
Notes
If
self
is acsr_array
or acsc_array
, then this will return acsc_array
or acsr_array
, respectively.
- trunc()¶
Element-wise trunc.
See
numpy.trunc
for more information.
- property T¶
Transpose.
- property has_canonical_format: bool¶
Whether the array/matrix has sorted indices and no duplicates
- Returns
True: if the above applies
False: otherwise
has_canonical_format implies has_sorted_indices, so if the latter flag is False, so will the former be; if the former is found True, the latter flag is also set.
- property has_sorted_indices: bool¶
Whether the indices are sorted
- Returns
True: if the indices of the array/matrix are in sorted order
False: otherwise
- property nnz: int¶
Number of stored values, including explicit zeros.
See also
count_nonzero
Number of non-zero entries
- property shape¶
Shape of the matrix
- property size: int¶
Number of stored values.
See also
count_nonzero
Number of non-zero values.
- class AliasIndex(name: str, shape: int | Tuple[int, ...] | List[int], orbs: int | Tuple[int, ...] | List[int] = (1, 1))¶
An all-or-nothing array index based on equality with a specific value
The
==
and!=
operators are overloaded to return a lazy array which is either allTrue
or allFalse
. See the examples below. This is useful for modifiers where each call gets arrays with the same sub_id/hop_id for all elements. Instead of passing anAliasArray
with.size
identical element,AliasIndex
does the same all-or-nothing indexing.Examples
>>> l = np.array([1, 2, 3]) >>> ai = AliasIndex("A", len(l)) >>> [int(i) for i in list(l[ai == "A"])] [1, 2, 3] >>> list(l[ai == "B"]) [] >>> list(l[ai != "A"]) [] >>> [int(i) for i in list(l[ai != "B"])] [1, 2, 3] >>> [bool(aa) for aa in np.logical_and([True, False, True], ai == "A")] [True, False, True] >>> [bool(aa) for aa in np.logical_and([True, False, True], ai != "A")] [False, False, False] >>> bool(ai == "A") True >>> bool(ai != "A") False >>> str(ai) 'A' >>> hash(ai) == hash("A") True >>> int(ai.eye.item()) 1 >>> bool(np.allclose(AliasIndex("A", 1, (2, 2)).eye, np.eye(2))) True
- class SplitName¶
String subclass with special support for strings of the form “first|second”
Operators
==
and!=
are overloaded to returnTrue
even if only the first part matches.Examples
>>> s = SplitName("first|second") >>> s == "first|second" True >>> s != "first|second" False >>> s == "first" True >>> s != "first" False >>> s == "second" False >>> s != "second" True
- __getitem__(key, /)¶
Return self[key].
- capitalize(/)¶
Return a capitalized version of the string.
More specifically, make the first character have upper case and the rest lower case.
- casefold(/)¶
Return a version of the string suitable for caseless comparisons.
- center(width, fillchar=' ', /)¶
Return a centered string of length width.
Padding is done using the specified fill character (default is a space).
- count(sub[, start[, end]]) int ¶
Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.
- encode(/, encoding='utf-8', errors='strict')¶
Encode the string using the codec registered for encoding.
- encoding
The encoding in which to encode the string.
- errors
The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.
- endswith(suffix[, start[, end]]) bool ¶
Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.
- expandtabs(/, tabsize=8)¶
Return a copy where all tab characters are expanded using spaces.
If tabsize is not given, a tab size of 8 characters is assumed.
- find(sub[, start[, end]]) int ¶
Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Return -1 on failure.
- format(*args, **kwargs) str ¶
Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).
- format_map(mapping) str ¶
Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).
- index(sub[, start[, end]]) int ¶
Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Raises ValueError when the substring is not found.
- isalnum(/)¶
Return True if the string is an alpha-numeric string, False otherwise.
A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.
- isalpha(/)¶
Return True if the string is an alphabetic string, False otherwise.
A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.
- isascii(/)¶
Return True if all characters in the string are ASCII, False otherwise.
ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.
- isdecimal(/)¶
Return True if the string is a decimal string, False otherwise.
A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.
- isdigit(/)¶
Return True if the string is a digit string, False otherwise.
A string is a digit string if all characters in the string are digits and there is at least one character in the string.
- isidentifier(/)¶
Return True if the string is a valid Python identifier, False otherwise.
Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.
- islower(/)¶
Return True if the string is a lowercase string, False otherwise.
A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.
- isnumeric(/)¶
Return True if the string is a numeric string, False otherwise.
A string is numeric if all characters in the string are numeric and there is at least one character in the string.
- isprintable(/)¶
Return True if the string is printable, False otherwise.
A string is printable if all of its characters are considered printable in repr() or if it is empty.
- isspace(/)¶
Return True if the string is a whitespace string, False otherwise.
A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.
- istitle(/)¶
Return True if the string is a title-cased string, False otherwise.
In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.
- isupper(/)¶
Return True if the string is an uppercase string, False otherwise.
A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.
- join(iterable, /)¶
Concatenate any number of strings.
The string whose method is called is inserted in between each given string. The result is returned as a new string.
Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’
- ljust(width, fillchar=' ', /)¶
Return a left-justified string of length width.
Padding is done using the specified fill character (default is a space).
- lower(/)¶
Return a copy of the string converted to lowercase.
- lstrip(chars=None, /)¶
Return a copy of the string with leading whitespace removed.
If chars is given and not None, remove characters in chars instead.
- static maketrans(x, y=<unrepresentable>, z=<unrepresentable>, /)¶
Return a translation table usable for str.translate().
If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.
- partition(sep, /)¶
Partition the string into three parts using the given separator.
This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.
If the separator is not found, returns a 3-tuple containing the original string and two empty strings.
- removeprefix(prefix, /)¶
Return a str with the given prefix string removed if present.
If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.
- removesuffix(suffix, /)¶
Return a str with the given suffix string removed if present.
If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.
- replace(old, new, count=-1, /)¶
Return a copy with all occurrences of substring old replaced by new.
- count
Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.
If the optional argument count is given, only the first count occurrences are replaced.
- rfind(sub[, start[, end]]) int ¶
Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Return -1 on failure.
- rindex(sub[, start[, end]]) int ¶
Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Raises ValueError when the substring is not found.
- rjust(width, fillchar=' ', /)¶
Return a right-justified string of length width.
Padding is done using the specified fill character (default is a space).
- rpartition(sep, /)¶
Partition the string into three parts using the given separator.
This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.
If the separator is not found, returns a 3-tuple containing two empty strings and the original string.
- rsplit(/, sep=None, maxsplit=-1)¶
Return a list of the substrings in the string, using sep as the separator string.
- sep
The separator used to split the string.
When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.
- maxsplit
Maximum number of splits (starting from the left). -1 (the default value) means no limit.
Splitting starts at the end of the string and works to the front.
- rstrip(chars=None, /)¶
Return a copy of the string with trailing whitespace removed.
If chars is given and not None, remove characters in chars instead.
- split(/, sep=None, maxsplit=-1)¶
Return a list of the substrings in the string, using sep as the separator string.
- sep
The separator used to split the string.
When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.
- maxsplit
Maximum number of splits (starting from the left). -1 (the default value) means no limit.
Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.
- splitlines(/, keepends=False)¶
Return a list of the lines in the string, breaking at line boundaries.
Line breaks are not included in the resulting list unless keepends is given and true.
- startswith(prefix[, start[, end]]) bool ¶
Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.
- strip(chars=None, /)¶
Return a copy of the string with leading and trailing whitespace removed.
If chars is given and not None, remove characters in chars instead.
- swapcase(/)¶
Convert uppercase characters to lowercase and lowercase characters to uppercase.
- title(/)¶
Return a version of the string where each word is titlecased.
More specifically, words start with uppercased characters and all remaining cased characters have lower case.
- translate(table, /)¶
Replace each character in the string using the given translation table.
- table
Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.
The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.
- upper(/)¶
Return a copy of the string converted to uppercase.
- zfill(width, /)¶
Pad a numeric string with zeros on the left, to fill a field of the given width.
The string is never truncated.