empty_like(
a: ArrayLike,
*,
zarr_format: ZarrFormat | None = None,
**kwargs: Any,
) -> AnyArray
Create an empty array like another array. The contents will be filled with the
array's fill value or zeros if no fill value is provided.
Parameters:
-
a
(array - like)
–
The array to create an empty array like.
-
zarr_format
((2, 3, None), default:
2
)
–
The zarr format of the new array. If None (default), the zarr format of a if it
is a zarr array, otherwise the default zarr format.
-
**kwargs
(Any, default:
{}
)
–
Keyword arguments passed to create.
Returns:
Notes
The contents of an empty Zarr array are not defined. On attempting to
retrieve data from an empty Zarr array, any values may be returned,
and these are not guaranteed to be stable from one access to the next.
Source code in src/zarr/api/synchronous.py
| def empty_like(a: ArrayLike, *, zarr_format: ZarrFormat | None = None, **kwargs: Any) -> AnyArray:
"""Create an empty array like another array. The contents will be filled with the
array's fill value or zeros if no fill value is provided.
Parameters
----------
a : array-like
The array to create an empty array like.
zarr_format : {2, 3, None}, optional
The zarr format of the new array. If `None` (default), the zarr format of `a` if it
is a zarr array, otherwise the default zarr format.
**kwargs
Keyword arguments passed to [`create`][zarr.api.asynchronous.create].
Returns
-------
Array
The new array.
Notes
-----
The contents of an empty Zarr array are not defined. On attempting to
retrieve data from an empty Zarr array, any values may be returned,
and these are not guaranteed to be stable from one access to the next.
"""
return Array(sync(async_api.empty_like(a, zarr_format=zarr_format, **kwargs)))
|