mm.math.boolean_mask

math.boolean_mask(mask)

Returns a tensor based on the truth value of the boolean mask.

Parameters:

• tensor (ndarray[Tuple[int, ...], Union[TypeVar(R, float16, float32, float64), TypeVar(C, complex64, complex128), TypeVar(Z, int16, int32, int64), TypeVar(N, uint16, uint32, uint64)]]) – A tensor.

• mask (ndarray[Tuple[int, ...], Union[TypeVar(R, float16, float32, float64), TypeVar(C, complex64, complex128), TypeVar(Z, int16, int32, int64), TypeVar(N, uint16, uint32, uint64)]]) – A boolean mask.

Return type:

ndarray[Tuple[int, ...], Union[TypeVar(R, float16, float32, float64), TypeVar(C, complex64, complex128), TypeVar(Z, int16, int32, int64), TypeVar(N, uint16, uint32, uint64)]]

Returns:

A tensor based on the truth value of the boolean mask.

code/api/mrmustard.math.boolean_mask

 

Download Python script

 

Download Notebook

 

View on GitHub