numcodecs_wasm_reinterpret

Classes:

  • Reinterpret

    Codec to reinterpret data between different compatible types.

Reinterpret

Reinterpret(decode_dtype, encode_dtype, _version='1.0.0')

Codec to reinterpret data between different compatible types.

Note that no conversion happens, only the meaning of the bits changes.

Reinterpreting to bytes, or to a same-sized unsigned integer type, or without the changing the dtype are supported.

Parameters:
  • decode_dtype (...) –

    Dtype of the decoded data

  • encode_dtype (...) –

    Dtype of the encoded data.

  • _version (..., default: = "1.0.0" ) –

    The codec's encoding format version. Do not provide this parameter explicitly.

Methods:

  • decode

    Decode the data in buf.

  • encode

    Encode the data in buf.

  • from_config

    Instantiate the codec from a configuration dict.

  • get_config

    Returns the configuration of the codec.

codec_id class-attribute instance-attribute

codec_id = 'reinterpret.rs'

decode

decode(buf, out=None)

Decode the data in buf.

Parameters:
  • buf (Buffer) –

    Encoded data. May be any object supporting the new-style buffer protocol.

  • out (Buffer, default: None ) –

    Writeable buffer to store decoded data. N.B. if provided, this buffer must be exactly the right size to store the decoded data.

Returns:
  • dec( Buffer ) –

    Decoded data. May be any object supporting the new-style buffer protocol.

encode

encode(buf)

Encode the data in buf.

Parameters:
  • buf (Buffer) –

    Data to be encoded. May be any object supporting the new-style buffer protocol.

Returns:
  • enc( Buffer ) –

    Encoded data. May be any object supporting the new-style buffer protocol.

from_config classmethod

from_config(config)

Instantiate the codec from a configuration dict.

Parameters:
  • config (dict) –

    Configuration of the codec.

Returns:
  • codec( Self ) –

    Instantiated codec.

get_config

get_config()

Returns the configuration of the codec.

numcodecs.registry.get_codec(config) can be used to reconstruct this codec from the returned config.

Returns:
  • config( dict ) –

    Configuration of the codec.