Struct numcodecs_random_projection::RandomProjectionCodec

pub struct RandomProjectionCodec {
    pub seed: u64,
    pub reduction: RandomProjectionReduction,
    pub projection: RandomProjectionKind,
}

Codec that uses random projections to reduce the dimensionality of high- dimensional data to compress it.

A two-dimensional array of shape N x D is encoded as n array of shape N x K, where K is either set explicitly or chosen using the the Johnson- Lindenstrauss lemma. For K to be smaller than D, D must be quite large. Therefore, this codec should only applied on large datasets as it otherwise significantly inflates the data size instead of reducing it.

Choosing a lower distortion rate epsilon will improve the quality of the lossy compression, i.e. reduce the compression error, at the cost of increasing K.

This codec only supports finite floating point data.

Fields

seed: u64

Seed for generating the random projection matrix

reduction: RandomProjectionReduction

Method with which the reduced dimensionality K is selected

projection: RandomProjectionKind

Projection kind that is used to generate the random projection matrix

Trait Implementations

impl Clone for RandomProjectionCodec

fn clone(&self) -> RandomProjectionCodec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Codec for RandomProjectionCodec

type Error = RandomProjectionCodecError

Error type that may be returned during encodeing and decodeing.

fn encode(&self, data: AnyCowArray<'_>) -> Result<AnyArray, Self::Error>

Encodes the data and returns the result.

fn decode(&self, encoded: AnyCowArray<'_>) -> Result<AnyArray, Self::Error>

Decodes the encoded data and returns the result.

fn decode_into( &self, encoded: AnyArrayView<'_>, decoded: AnyArrayViewMut<'_>, ) -> Result<(), Self::Error>

Decodes the encoded data and writes the result into the provided decoded output.

impl<'de> Deserialize<'de> for RandomProjectionCodec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RandomProjectionCodec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn always_inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for RandomProjectionCodec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticCodec for RandomProjectionCodec

const CODEC_ID: &'static str = "random-projection"

Codec identifier.

type Config<'de> = RandomProjectionCodec

Configuration type, from which the codec can be created infallibly.

fn from_config(config: Self::Config<'_>) -> Self

Instantiate a codec from its configuration.

fn get_config(&self) -> StaticCodecConfig<'_, Self>

Get the configuration for this codec.