#include "scann/data_format/gfv_properties.h"
#include "absl/log/check.h"
#include "scann/data_format/features.pb.h"
#include "scann/oss_wrappers/scann_status.h"
#include "scann/utils/common.h"
#include "scann/utils/types.h"
namespace research_scann {
string_view GfvFeatureTypeName(int gfv_feature_type) {
switch (gfv_feature_type) {
case GenericFeatureVector::INT64:
return "INT64";
case GenericFeatureVector::FLOAT:
return "FLOAT";
case GenericFeatureVector::DOUBLE:
return "DOUBLE";
case GenericFeatureVector::STRING:
return "STRING";
default:
return "INVALID_GFV_FEATURE_TYPE";
}
}
StatusOr<size_t> GetGfvVectorSize(const GenericFeatureVector& gfv) {
switch (gfv.feature_type()) {
case GenericFeatureVector::INT64:
return gfv.feature_value_is_int8_compressed()
? gfv.feature_value_int8().size()
: gfv.feature_value_int64_size();
case GenericFeatureVector::BINARY:
return gfv.feature_value_int64_size();
case GenericFeatureVector::FLOAT:
return gfv.feature_value_float_size();
case GenericFeatureVector::DOUBLE:
return gfv.feature_value_double_size();
case GenericFeatureVector::STRING:
return 1;
default:
return InvalidArgumentError("Unknown feature type: %d",
gfv.feature_type());
}
}
StatusOr<DimensionIndex> GetGfvDimensionality(const GenericFeatureVector& gfv) {
if (gfv.feature_dim() == 0) {
return InvalidArgumentError(
"GenericFeatureVector dimensionality cannot be == 0.");
}
SCANN_ASSIGN_OR_RETURN(bool is_sparse, IsGfvSparse(gfv));
if (is_sparse) {
return gfv.feature_dim();
} else {
return GetGfvVectorSize(gfv);
}
}
StatusOr<bool> IsGfvSparse(const GenericFeatureVector& gfv) {
if (gfv.feature_type() == GenericFeatureVector::STRING) {
return false;
}
if (gfv.feature_index_size() > 0) {
return true;
}
SCANN_ASSIGN_OR_RETURN(DimensionIndex vector_size, GetGfvVectorSize(gfv));
return vector_size == 0;
}
StatusOr<bool> IsGfvDense(const GenericFeatureVector& gfv) {
if (gfv.feature_type() == GenericFeatureVector::STRING) {
return false;
}
SCANN_ASSIGN_OR_RETURN(bool is_sparse, IsGfvSparse(gfv));
return !is_sparse;
}
Status GetGfvVectorSize(const GenericFeatureVector& gfv,
DimensionIndex* result) {
DCHECK(result);
SCANN_ASSIGN_OR_RETURN(*result, GetGfvVectorSize(gfv));
return OkStatus();
}
Status GetGfvDimensionality(const GenericFeatureVector& gfv,
DimensionIndex* result) {
DCHECK(result);
SCANN_ASSIGN_OR_RETURN(*result, GetGfvDimensionality(gfv));
return OkStatus();
}
Status IsGfvSparse(const GenericFeatureVector& gfv, bool* result) {
DCHECK(result);
SCANN_ASSIGN_OR_RETURN(*result, IsGfvSparse(gfv));
return OkStatus();
}
Status IsGfvDense(const GenericFeatureVector& gfv, bool* result) {
DCHECK(result);
SCANN_ASSIGN_OR_RETURN(*result, IsGfvDense(gfv));
return OkStatus();
}
size_t GetGfvDimensionalityOrDie(const GenericFeatureVector& gfv) {
return ValueOrDie(GetGfvDimensionality(gfv));
}
bool IsGfvSparseOrDie(const GenericFeatureVector& gfv) {
return ValueOrDie(IsGfvSparse(gfv));
}
bool IsGfvDenseOrDie(const GenericFeatureVector& gfv) {
return ValueOrDie(IsGfvDense(gfv));
}
}