pyarrow.FixedShapeTensorScalar#

class pyarrow.FixedShapeTensorScalar#

Bases: ExtensionScalar

Concrete class for fixed shape tensor extension scalar.

__init__(*args, **kwargs)#

Methods

__init__(*args, **kwargs)

as_py(self)

Return this scalar as a Python object.

cast(self[, target_type, safe, options, ...])

Cast scalar value to another data type.

equals(self, Scalar other)

Parameters:

from_storage(BaseExtensionType typ, value)

Construct ExtensionScalar from type and storage value.

to_numpy(self)

Convert fixed shape tensor scalar to a numpy.ndarray.

to_tensor(self)

Convert fixed shape tensor extension scalar to a pyarrow.Tensor, using shape and strides derived from corresponding FixedShapeTensorType.

validate(self, *[, full])

Perform validation checks.

Attributes

is_valid

Holds a valid (non-null) value.

type

Data type of the Scalar object.

value

Return storage value as a scalar.

as_py(self)#

Return this scalar as a Python object.

cast(self, target_type=None, safe=None, options=None, memory_pool=None)#

Cast scalar value to another data type.

See pyarrow.compute.cast() for usage.

Parameters:
target_typeDataType, default None

Type to cast scalar to.

safebool, default True

Whether to check for conversion errors such as overflow.

optionsCastOptions, default None

Additional checks pass by CastOptions

memory_poolMemoryPool, optional

memory pool to use for allocations during function execution.

Returns:
scalarA Scalar of the given target data type.
equals(self, Scalar other)#
Parameters:
otherpyarrow.Scalar
Returns:
bool
static from_storage(BaseExtensionType typ, value)#

Construct ExtensionScalar from type and storage value.

Parameters:
typDataType

The extension type for the result scalar.

valueobject

The storage value for the result scalar.

Returns:
ext_scalarExtensionScalar
is_valid#

Holds a valid (non-null) value.

to_numpy(self)#

Convert fixed shape tensor scalar to a numpy.ndarray.

The resulting ndarray’s shape matches the permuted shape of the fixed shape tensor scalar. The conversion is zero-copy.

Returns:
numpy.ndarray
to_tensor(self)#

Convert fixed shape tensor extension scalar to a pyarrow.Tensor, using shape and strides derived from corresponding FixedShapeTensorType.

The conversion is zero-copy.

Returns:
pyarrow.Tensor

Tensor represented stored in FixedShapeTensorScalar.

type#

Data type of the Scalar object.

validate(self, *, full=False)#

Perform validation checks. An exception is raised if validation fails.

By default only cheap validation checks are run. Pass full=True for thorough validation checks (potentially O(n)).

Parameters:
fullbool, default False

If True, run expensive checks, otherwise cheap checks only.

Raises:
ArrowInvalid
value#

Return storage value as a scalar.