faiss.vector_transform

Undocumented in source.

Members

Aliases

FaissCenteringTransform
alias FaissCenteringTransform = FaissVectorTransform_H
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FaissITQMatrix
alias FaissITQMatrix = FaissVectorTransform_H
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FaissITQTransform
alias FaissITQTransform = FaissVectorTransform_H
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FaissLinearTransform
alias FaissLinearTransform = FaissVectorTransform_H

Opaque type for referencing to a LinearTransform object

FaissNormalizationTransform
alias FaissNormalizationTransform = FaissVectorTransform_H
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FaissOPQMatrix
alias FaissOPQMatrix = FaissVectorTransform_H
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FaissPCAMatrix
alias FaissPCAMatrix = FaissVectorTransform_H
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FaissRandomRotationMatrix
alias FaissRandomRotationMatrix = FaissVectorTransform_H
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FaissRemapDimensionsTransform
alias FaissRemapDimensionsTransform = FaissVectorTransform_H
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FaissVectorTransform
alias FaissVectorTransform = FaissVectorTransform_H
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Functions

faiss_CenteringTransform_free
void faiss_CenteringTransform_free(FaissCenteringTransform* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_CenteringTransform_new_with
int faiss_CenteringTransform_new_with(FaissCenteringTransform** p_vt, int d)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_ITQMatrix_free
void faiss_ITQMatrix_free(FaissITQMatrix* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_ITQMatrix_new_with
int faiss_ITQMatrix_new_with(FaissITQMatrix** p_vt, int d)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_ITQTransform_do_pca
int faiss_ITQTransform_do_pca(const(FaissITQTransform)* )

Getter for do_pca

faiss_ITQTransform_free
void faiss_ITQTransform_free(FaissITQTransform* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_ITQTransform_new_with
int faiss_ITQTransform_new_with(FaissITQTransform** p_vt, int d_in, int d_out, int do_pca)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_LinearTransform_free
void faiss_LinearTransform_free(FaissLinearTransform* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_LinearTransform_have_bias
int faiss_LinearTransform_have_bias(const(FaissLinearTransform)* )

Getter for have_bias

faiss_LinearTransform_is_orthonormal
int faiss_LinearTransform_is_orthonormal(const(FaissLinearTransform)* )

Getter for is_orthonormal

faiss_LinearTransform_set_is_orthonormal
void faiss_LinearTransform_set_is_orthonormal(FaissLinearTransform* vt)

compute A^T * A to set the is_orthonormal flag

faiss_LinearTransform_transform_transpose
void faiss_LinearTransform_transform_transpose(const(FaissLinearTransform)* vt, idx_t n, const(float)* y, float* x)

compute x = A^T * (x - b) is reverse transform if A has orthonormal lines

faiss_NormalizationTransform_free
void faiss_NormalizationTransform_free(FaissNormalizationTransform* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_NormalizationTransform_new_with
int faiss_NormalizationTransform_new_with(FaissNormalizationTransform** p_vt, int d, float norm)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_NormalizationTransform_norm
float faiss_NormalizationTransform_norm(const(FaissNormalizationTransform)* )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_OPQMatrix_free
void faiss_OPQMatrix_free(FaissOPQMatrix* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_OPQMatrix_new_with
int faiss_OPQMatrix_new_with(FaissOPQMatrix** p_vt, int d, int M, int d2)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_OPQMatrix_niter
int faiss_OPQMatrix_niter(const(FaissOPQMatrix)* )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_OPQMatrix_niter_pq
int faiss_OPQMatrix_niter_pq(const(FaissOPQMatrix)* )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_OPQMatrix_set_niter
void faiss_OPQMatrix_set_niter(FaissOPQMatrix* , int )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_OPQMatrix_set_niter_pq
void faiss_OPQMatrix_set_niter_pq(FaissOPQMatrix* , int )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_OPQMatrix_set_verbose
void faiss_OPQMatrix_set_verbose(FaissOPQMatrix* , int )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_OPQMatrix_verbose
int faiss_OPQMatrix_verbose(const(FaissOPQMatrix)* )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_PCAMatrix_eigen_power
float faiss_PCAMatrix_eigen_power(const(FaissPCAMatrix)* )

Getter for eigen_power

faiss_PCAMatrix_free
void faiss_PCAMatrix_free(FaissPCAMatrix* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_PCAMatrix_new_with
int faiss_PCAMatrix_new_with(FaissPCAMatrix** p_vt, int d_in, int d_out, float eigen_power, int random_rotation)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_PCAMatrix_random_rotation
int faiss_PCAMatrix_random_rotation(const(FaissPCAMatrix)* )

Getter for random_rotation

faiss_RandomRotationMatrix_free
void faiss_RandomRotationMatrix_free(FaissRandomRotationMatrix* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_RandomRotationMatrix_new_with
int faiss_RandomRotationMatrix_new_with(FaissRandomRotationMatrix** p_vt, int d_in, int d_out)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_RemapDimensionsTransform_free
void faiss_RemapDimensionsTransform_free(FaissRemapDimensionsTransform* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_RemapDimensionsTransform_new_with
int faiss_RemapDimensionsTransform_new_with(FaissRemapDimensionsTransform** p_vt, int d_in, int d_out, int uniform)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_VectorTransform_apply
float* faiss_VectorTransform_apply(const(FaissVectorTransform)* vt, idx_t n, const(float)* x)

apply the random rotation, return new allocated matrix @param x size n * d_in @return size n * d_out

faiss_VectorTransform_apply_noalloc
void faiss_VectorTransform_apply_noalloc(const(FaissVectorTransform)* vt, idx_t n, const(float)* x, float* xt)

apply transformation and result is pre-allocated @param x size n * d_in @param xt size n * d_out

faiss_VectorTransform_d_in
int faiss_VectorTransform_d_in(const(FaissVectorTransform)* )

Getter for input dimension

faiss_VectorTransform_d_out
int faiss_VectorTransform_d_out(const(FaissVectorTransform)* )

Getter for output dimension

faiss_VectorTransform_free
void faiss_VectorTransform_free(FaissVectorTransform* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_VectorTransform_is_trained
int faiss_VectorTransform_is_trained(const(FaissVectorTransform)* )

Getter for is_trained

faiss_VectorTransform_reverse_transform
void faiss_VectorTransform_reverse_transform(const(FaissVectorTransform)* vt, idx_t n, const(float)* xt, float* x)

reverse transformation. May not be implemented or may return approximate result

faiss_VectorTransform_train
int faiss_VectorTransform_train(FaissVectorTransform* vt, idx_t n, const(float)* x)

Perform training on a representative set of vectors

Structs

FaissVectorTransform_H
struct FaissVectorTransform_H

Defines a few objects that apply transformations to a set of vectors Often these are pre-processing steps. Opaque type for referencing to a VectorTransform object

Meta