Struct faiss::MatrixStats

struct MatrixStats

Reports some statistics on a dataset and comments on them.

It is a class rather than a function so that all stats can also be accessed from code

Public Functions

MatrixStats(size_t n, size_t d, const float *x)

void do_comment(const char *fmt, ...)

Public Members

std::string comments

size_t n = 0

size_t d = 0

size_t n_collision = 0

size_t n_valid = 0

size_t n0 = 0

double min_norm2 = HUGE_VALF

double max_norm2 = 0

uint64_t hash_value = 0

std::vector<PerDimStats> per_dim_stats

std::unordered_map<uint64_t, Occurrence> occurrences

char *buf

size_t nbuf

struct Occurrence

Public Members

size_t first

size_t count

struct PerDimStats

Public Functions

void add(float x)

void compute_mean_std()

Public Members

size_t n = 0

counts of various special entries

size_t n_nan = 0

size_t n_inf = 0

size_t n0 = 0

float min = HUGE_VALF

to get min/max and stddev values

float max = -HUGE_VALF

double sum = 0

double sum2 = 0

size_t n_valid = 0

double mean = NAN

double stddev = NAN