Struct faiss::NormalizationTransform

struct NormalizationTransform : public faiss::VectorTransform

per-vector normalization

Public Functions

explicit NormalizationTransform(int d, float norm = 2.0)
NormalizationTransform()
virtual void apply_noalloc(idx_t n, const float *x, float *xt) const override

apply the transformation and return the result in a provided matrix

Parameters:
  • n – number of vectors to transform

  • x – input vectors, size n * d_in

  • xt – output vectors, size n * d_out

virtual void reverse_transform(idx_t n, const float *xt, float *x) const override

Identity transform since norm is not revertible.

virtual void check_identical(const VectorTransform &other) const override
virtual void train(idx_t n, const float *x)

Perform training on a representative set of vectors. Does nothing by default.

Parameters:
  • n – nb of training vectors

  • x – training vecors, size n * d

float *apply(idx_t n, const float *x) const

apply the transformation and return the result in an allocated pointer

Parameters:
  • n – number of vectors to transform

  • x – input vectors, size n * d_in

Returns:

output vectors, size n * d_out

Public Members

float norm
int d_in
int d_out

! input dimension

bool is_trained

set if the VectorTransform does not require training, or if training is done already