bundles / numpy 2.4.3 / numpy / concatenate
staticmethod
numpy:concatenate
Signature
def concatenate ( arrays , / , axis = 0 , out = None , * , dtype = None , casting = same_kind ) Summary
Join a sequence of arrays along an existing axis.
Parameters
a1, a2, ...: sequence of array_likeThe arrays must have the same shape, except in the dimension corresponding to
axis(the first, by default).axis: int, optionalThe axis along which the arrays will be joined. If axis is None, arrays are flattened before use. Default is 0.
out: ndarray, optionalIf provided, the destination to place the result. The shape must be correct, matching that of what concatenate would have returned if no out argument were specified.
dtype: str or dtypeIf provided, the destination array will have this dtype. Cannot be provided together with
out.casting: {'no', 'equiv', 'safe', 'same_kind', 'unsafe'}, optionalControls what kind of data casting may occur. Defaults to 'same_kind'. For a description of the options, please see
casting.
Returns
res: ndarrayThe concatenated array.
Notes
When one or more of the arrays to be concatenated is a MaskedArray, this function will return a MaskedArray object instead of an ndarray, but the input masks are not preserved. In cases where a MaskedArray is expected as input, use the ma.concatenate function from the masked array module instead.
Examples
import numpy as np a = np.array([[1, 2], [3, 4]]) b = np.array([[5, 6]]) np.concatenate((a, b), axis=0) np.concatenate((a, b.T), axis=1) np.concatenate((a, b), axis=None)✓
a = np.ma.arange(3) a[1] = np.ma.masked b = np.arange(2, 5) a b np.concatenate([a, b]) np.ma.concatenate([a, b])✓
See also
- array_split
Split an array into multiple sub-arrays of equal or near-equal size.
- block
Assemble arrays from blocks.
- column_stack
Stack 1-D arrays as columns into a 2-D array.
- dsplit
Split array into multiple sub-arrays along the 3rd axis (depth).
- dstack
Stack arrays in sequence depth wise (along third dimension).
- hsplit
Split array into multiple sub-arrays horizontally (column wise).
- hstack
Stack arrays in sequence horizontally (column wise).
- ma.concatenate
Concatenate function that preserves input masks.
- split
Split array into a list of multiple sub-arrays of equal size.
- stack
Stack a sequence of arrays along a new axis.
- vsplit
Split array into multiple sub-arrays vertically (row wise).
- vstack
Stack arrays in sequence vertically (row wise).
Aliases
-
numpy.concat -
numpy.lib._index_tricks_impl.AxisConcatenator.concatenate