cast_to_ndarray#

pybear.base.cast_to_ndarray(X, copy_X=True)#

Convert the container of X to numpy.ndarray.

Can take Python lists, tuples, and sets, numpy ndarrays and masked arrays, pandas dataframes and series, polars dataframes and series, and scipy sparse matrices and arrays. Any nan-like values are standardized to numpy.nan.

Parameters:
XXContainer of shape (n_samples, n_features) or (n_samples,)

The array-like data to be converted to ndarray.

copy_Xbool, default=True

Whether to copy X before casting to ndarray or perform the operations directly on the passed X.

Returns:
Xnumpy.ndarray

The original data converted to numpy.ndarray.

Notes

Type Aliases

PythonTypes:

list | tuple | set | list[list] | tuple[tuple]

NumpyTypes:

numpy.ndarray | numpy.ma.MaskedArray

PandasTypes:

pandas.Series | pandas.DataFrame

PolarsTypes:

polars.Series | polars.DataFrame

ScipySparseTypes:

ss.csc_matrix | ss.csc_array | ss.csr_matrix | ss.csr_array | ss.coo_matrix | ss.coo_array | ss.dia_matrix | ss.dia_array | ss.lil_matrix | ss.lil_array | ss.dok_matrix | ss.dok_array | ss.bsr_matrix | ss.bsr_array

XContainer:

PythonTypes | NumpyTypes | PandasTypes | PolarsTypes | ScipySparseTypes